Documentation ¶
Index ¶
- Constants
- func CheckTimeout(ctx context.Context, err error) error
- func DialSocket(ctx context.Context, socketName string, opts ...grpc.DialOption) (*grpc.ClientConn, error)
- func DisplayVersion() string
- func GetConfigFile(c context.Context) string
- func GetExe() string
- func GetInstallMechanism() (string, error)
- func GetMechanismFromPath(execPath string) (string, error)
- func ListenSocket(ctx context.Context, processName, socketName string) (net.Listener, error)
- func RemoveSocket(listener net.Listener) error
- func Retry(c context.Context, text string, f func(context.Context) error, ...) error
- func RunError(err error) error
- func Semver() semver.Version
- func SetConfig(ctx context.Context, configDir, configYml string) (context.Context, error)
- func SetDefaultConfig(ctx context.Context, configDir string) (context.Context, error)
- func SetExe(executable string)
- func SocketExists(name string) (bool, error)
- func Version() string
- func WaitUntilSocketAppears(name, path string, ttw time.Duration) error
- func WaitUntilSocketVanishes(name, path string, ttw time.Duration) error
- func WithConfig(ctx context.Context, config *Config) context.Context
- func WithEnsuredState(ctx context.Context, r EnsuredState, retain bool, f func() error) (err error)
- func WithEnv(ctx context.Context, env *Env) context.Context
- func WrapRecvErr(err error, msg string) error
- type Cloud
- type Config
- type EnsuredState
- type Env
- type Grpc
- type Images
- type LogLevels
- type RecvEOF
- type TelepresenceAPI
- type TimeoutID
- type Timeouts
Constants ¶
const ( // ConnectorSocketName is the path used when communicating to the connector process ConnectorSocketName = "/tmp/telepresence-connector.socket" // DaemonSocketName is the path used when communicating to the daemon process DaemonSocketName = "/var/run/telepresence-daemon.socket" )
const (
// APIVersion is the API version of the daemon and connector API
APIVersion = 3
)
Variables ¶
This section is empty.
Functions ¶
func DialSocket ¶
func DialSocket(ctx context.Context, socketName string, opts ...grpc.DialOption) (*grpc.ClientConn, error)
DialSocket dials the given socket and returns the resulting connection
func DisplayVersion ¶
func DisplayVersion() string
DisplayVersion returns a printable version for `telepresence`
func GetConfigFile ¶ added in v2.3.5
GetConfigFile gets the path to the configFile as stored in filelocation.AppUserConfigDir
func GetInstallMechanism ¶ added in v2.4.8
GetInstallMechanism returns how the executable was installed on the machine.
func GetMechanismFromPath ¶ added in v2.4.8
GetMechanismFromPath is a helper function that contains most of the logic required for GetInstallMechanism, but enables us to test it since we can control the path passed in.
func ListenSocket ¶ added in v2.4.0
ListenSocket returns a listener for the given socket and returns the resulting connection
func RemoveSocket ¶ added in v2.4.0
RemoveSocket removes any representation of the the socket from the filesystem.
func Retry ¶
func Retry(c context.Context, text string, f func(context.Context) error, durations ...time.Duration) error
Retry will run the given function repeatedly with an increasing delay until it returns without error.
The function takes 0 to 2 durations with the following meaning
Delay - initial delay, i.e. the delay between the first and the second call. MaxDelay - maximum delay between calling the functions (delay will never grow beyond this value)
func RunError ¶
RunError checks if the given err is a *exit.ExitError, and if so, extracts Stderr and the ExitCode from it.
func SetConfig ¶ added in v2.4.0
SetConfig creates a config from the configYml provided and assigns it to a new context which is returned. Use this if you are testing components of the config.yml, otherwise you can use setDefaultConfig.
func SetDefaultConfig ¶ added in v2.4.0
SetDefaultConfig creates a config that has the registry set correctly. This ensures that the config on the machine of whatever is running the test, isn't used, which could cause conflict with the tests.
func SetExe ¶
func SetExe(executable string)
SetExe defines the name of the executable (for testing purposes only)
func SocketExists ¶
SocketExists returns true if a socket is found with the given name
func WaitUntilSocketAppears ¶
WaitUntilSocketAppears waits until the socket at the given path comes into existence and returns when that happens. The wait will be max ttw (time to wait) long. An error is returned if that time is exceeded before the socket is removed.
func WaitUntilSocketVanishes ¶
WaitUntilSocketVanishes waits until the socket at the given path is removed and returns when that happens. The wait will be max ttw (time to wait) long. An error is returned if that time is exceeded before the socket is removed.
func WithConfig ¶ added in v2.4.2
WithConfig returns a context with the given Config
func WithEnsuredState ¶
WithEnsuredState ensures the given state, calls the function, and then, if the state was activated, it is deactivated unless the retain flag is true.
func WrapRecvErr ¶ added in v2.3.3
WrapRecvErr wraps an error from a Recv call. If the error is nil, nil is returned. If the error indicates that the remote end has , a RecvEOF wrapping the error will be returned. Otherwise, the original error will be wrapped as fmt.Errorf("%s: %w", msg, err)
Types ¶
type Cloud ¶ added in v2.3.5
type Cloud struct { SkipLogin bool `json:"skipLogin,omitempty" yaml:"skipLogin,omitempty"` RefreshMessages time.Duration `json:"refreshMessages,omitempty" yaml:"refreshMessages,omitempty"` SystemaHost string `json:"systemaHost,omitempty" yaml:"systemaHost,omitempty"` SystemaPort string `json:"systemaPort,omitempty" yaml:"systemaPort,omitempty"` }
func (Cloud) MarshalYAML ¶ added in v2.4.4
MarshalYAML is not using pointer receiver here, because Cloud is not pointer in the Config struct
func (*Cloud) UnmarshalYAML ¶ added in v2.3.5
UnmarshalYAML parses the images YAML
type Config ¶ added in v2.1.2
type Config struct { Timeouts Timeouts `json:"timeouts,omitempty" yaml:"timeouts,omitempty"` LogLevels LogLevels `json:"logLevels,omitempty" yaml:"logLevels,omitempty"` Images Images `json:"images,omitempty" yaml:"images,omitempty"` Cloud Cloud `json:"cloud,omitempty" yaml:"cloud,omitempty"` Grpc Grpc `json:"grpc,omitempty" yaml:"grpc,omitempty"` TelepresenceAPI TelepresenceAPI `json:"telepresenceAPI,omitempty" yaml:"telepresenceAPI,omitempty"` }
Config contains all configuration values for the telepresence CLI
func GetDefaultConfig ¶ added in v2.4.2
GetDefaultConfig returns the default configuration settings
func LoadConfig ¶ added in v2.4.2
LoadConfig loads and returns the Telepresence configuration as stored in filelocation.AppUserConfigDir or filelocation.AppSystemConfigDirs
func (*Config) Merge ¶ added in v2.4.4
merge merges this instance with the non-zero values of the given argument. The argument values take priority.
func (*Config) UnmarshalYAML ¶ added in v2.1.2
type EnsuredState ¶
type EnsuredState interface { // EnsureState will check if the state is active and activate it if that is not the case. // The boolean return value indicates if the state was activated or not. EnsureState(ctx context.Context) (bool, error) // Deactivate the state (i.e. quit, remove, disconnect) DeactivateState(ctx context.Context) error }
An EnsuredState represents some state that is needed in order for a function to execute.
type Env ¶
type Env struct { // I'd like to set TELEPRESENCE_LOGIN_DOMAIN,default=auth.datawire.io, but // sethvargo/go-envconfig doesn't support filling in the default for our later references to // it in following settings, so we have to do the hack with maybeSetDefault below. *sigh* I // guess I'm just spoiled by apro/cmd/amb-sidecar/types/internal/envconfig. LoginDomain string `env:"TELEPRESENCE_LOGIN_DOMAIN,required"` LoginAuthURL string `env:"TELEPRESENCE_LOGIN_AUTH_URL,default=https://${TELEPRESENCE_LOGIN_DOMAIN}/auth"` LoginTokenURL string `env:"TELEPRESENCE_LOGIN_TOKEN_URL,default=https://${TELEPRESENCE_LOGIN_DOMAIN}/token"` LoginCompletionURL string `env:"TELEPRESENCE_LOGIN_COMPLETION_URL,default=https://${TELEPRESENCE_LOGIN_DOMAIN}/completion"` UserInfoURL string `env:"TELEPRESENCE_USER_INFO_URL,default=https://${TELEPRESENCE_LOGIN_DOMAIN}/api/userinfo"` ManagerNamespace string `env:"TELEPRESENCE_MANAGER_NAMESPACE,default=ambassador"` // This environment variable becomes the default for the images.registry and images.webhookRegistry Registry string `env:"TELEPRESENCE_REGISTRY,default=docker.io/datawire"` // This environment variable becomes the default for the images.agentImage and images.webhookAgentImage AgentImage string `env:"TELEPRESENCE_AGENT_IMAGE,default="` // contains filtered or unexported fields }
func LoadEnvWith ¶ added in v2.4.7
type Grpc ¶ added in v2.3.5
type Grpc struct { // MaxReceiveSize is the maximum message size in bytes the client can receive in a gRPC call or stream message. // Overrides the gRPC default of 4MB. MaxReceiveSize resource.Quantity `json:"maxReceiveSize,omitempty" yaml:"maxReceiveSize,omitempty"` }
func (Grpc) MarshalYAML ¶ added in v2.4.4
MarshalYAML is not using pointer receiver here, because Cloud is not pointer in the Config struct
func (*Grpc) UnmarshalYAML ¶ added in v2.3.5
UnmarshalYAML parses the images YAML
type Images ¶ added in v2.3.5
type Images struct { Registry string `json:"registry,omitempty" yaml:"registry,omitempty"` AgentImage string `json:"agentImage,omitempty" yaml:"agentImage,omitempty"` WebhookRegistry string `json:"webhookRegistry,omitempty" yaml:"webhookRegistry,omitempty"` WebhookAgentImage string `json:"webhookAgentImage,omitempty" yaml:"webhookAgentImage,omitempty"` }
func (*Images) UnmarshalYAML ¶ added in v2.3.5
UnmarshalYAML parses the images YAML
type LogLevels ¶ added in v2.3.0
type LogLevels struct { UserDaemon logrus.Level `json:"userDaemon,omitempty" yaml:"userDaemon,omitempty"` RootDaemon logrus.Level `json:"rootDaemon,omitempty" yaml:"rootDaemon,omitempty"` }
func (*LogLevels) UnmarshalYAML ¶ added in v2.3.0
UnmarshalYAML parses the logrus log-levels
type RecvEOF ¶ added in v2.3.3
type RecvEOF struct {
// contains filtered or unexported fields
}
RecvEOF should be returned when a component has returned EOF from a stream. Do not use this if, for example, the initial dial to a stream fails.
type TelepresenceAPI ¶ added in v2.4.8
type TelepresenceAPI struct {
Port int `json:"port,omitempty" yaml:"port,omitempty"`
}
type Timeouts ¶ added in v2.1.2
type Timeouts struct { // PrivateAgentInstall is how long to wait for an agent to be installed (i.e. apply of service and deploy manifests) PrivateAgentInstall time.Duration `json:"agentInstall,omitempty" yaml:"agentInstall,omitempty"` // PrivateApply is how long to wait for a k8s manifest to be applied PrivateApply time.Duration `json:"apply,omitempty" yaml:"apply,omitempty"` // PrivateClusterConnect is the maximum time to wait for a connection to the cluster to be established PrivateClusterConnect time.Duration `json:"clusterConnect,omitempty" yaml:"clusterConnect,omitempty"` // PrivateEndpointDial is how long to wait for a Dial to a service for which the IP is known. PrivateEndpointDial time.Duration `json:"endpointDial,omitempty" yaml:"endpointDial,omitempty"` // PrivateHelm is how long to wait for any helm operation. PrivateHelm time.Duration `json:"helm,omitempty" yaml:"helm,omitempty"` // PrivateIntercept is the time to wait for an intercept after the agents has been installed PrivateIntercept time.Duration `json:"intercept,omitempty" yaml:"intercept,omitempty"` // PrivateRoundtripLatency is how much to add to the EndpointDial timeout when establishing a remote connection. PrivateRoundtripLatency time.Duration `json:"roundtripLatency,omitempty" yaml:"roundtripLatency,omitempty"` // PrivateProxyDial is how long to wait for the proxy to establish an outbound connection PrivateProxyDial time.Duration `json:"proxyDial,omitempty" yaml:"proxyDial,omitempty"` // PrivateTrafficManagerConnect is how long to wait for the traffic-manager API to connect PrivateTrafficManagerAPI time.Duration `json:"trafficManagerAPI,omitempty" yaml:"trafficManagerAPI,omitempty"` // PrivateTrafficManagerConnect is how long to wait for the initial port-forwards to the traffic-manager PrivateTrafficManagerConnect time.Duration `json:"trafficManagerConnect,omitempty" yaml:"trafficManagerConnect,omitempty"` }
func (Timeouts) MarshalYAML ¶ added in v2.4.4
MarshalYAML is not using pointer receiver here, because Timeouts is not pointer in the Config struct
func (*Timeouts) TimeoutContext ¶ added in v2.3.0
func (*Timeouts) UnmarshalYAML ¶ added in v2.1.2
UnmarshalYAML caters for the unfortunate fact that time.Duration doesn't do YAML or JSON at all.