Documentation
¶
Overview ¶
Package egress carries the dial hook a distribution installs to police the connections GoModel opens directly.
HTTP clients are steered by the standard proxy variables, so a distribution that wants to see every outbound HTTP request only has to set HTTP_PROXY. The database, cache, and vector store clients speak their own protocols over raw TCP and read no such variable: without a hook they connect wherever their URL points, whatever policy the distribution believes it is enforcing. This package is that hook.
It is process-wide on purpose, matching the proxy variables it complements: the clients live behind several layers of construction, and a guarantee an operator is told covers the process cannot depend on a parameter each of them remembers to pass along.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func DialContext ¶
DialContext opens a connection through the installed hook, or with the default dialer when there is none. Clients that take a dialer are given this function; clients that take an interface are given Dialer.
func Installed ¶
func Installed() bool
Installed reports whether a distribution has installed a hook.
func Lookup ¶
func Lookup(ctx context.Context, host string, resolve func(context.Context, string) ([]string, error)) ([]string, error)
Lookup resolves host for a client that resolves names itself before it dials. With a hook installed the name is passed through untouched, so the hook decides what it may resolve to and dials the address that passed; without one the client's own resolver answers, keeping its behaviour - multiple addresses and their fallbacks included - exactly as it was.
It is consulted per connection, never snapshotted at client construction: a client built before the hook was installed would otherwise keep handing it addresses it had already chosen, which no hostname policy can judge.
Types ¶
type DialFunc ¶
DialFunc opens one connection. It matches net.Dialer.DialContext, which is what the database and cache clients expect.
type Dialer ¶
type Dialer struct{}
Dialer adapts DialContext to the interface the MongoDB driver takes.
type Hook ¶
type Hook struct {
// contains filtered or unexported fields
}
Hook is an installed policy, handed to whoever installed it. Removing the policy needs this handle, so a package that merely imports egress cannot take the guarantee away from the clients running under it.
func Install ¶
Install routes every direct connection core opens from now on through dial, and returns the handle that removes it again. It belongs to whatever composes the process - a distribution's startup path - and there is one: installing over an existing hook is an error rather than a silent replacement.
Connections already open are unaffected: a hook installed at startup, as GoModel Pro's air-gapped mode does before the application is built, sees every connection the gateway makes.
Source Files