daemon

Documentation

Index

• func DeleteInfo(ctx context.Context, file string) error
• func GetKubeStartingConfig(cmd *cobra.Command) (*api.Config, error)
• func InfoExists(ctx context.Context, file string) (bool, error)
• func KeepInfoAlive(ctx context.Context, file string) error
• func SafeContainerName(name string) string
• func SaveInfo(ctx context.Context, object *Info, file string) error
• func WatchInfos(ctx context.Context, onChange func(context.Context) error, files ...string) error
• func WithDefaultRequest(ctx context.Context, cmd *cobra.Command) (context.Context, error)
• func WithSession(ctx context.Context, s *Session) context.Context
• func WithUserClient(ctx context.Context, ud *UserClient) context.Context
• type Identifier
  • func IdentifierFromFlags(name string, flagMap map[string]string) (*Identifier, error)
  • func NewIdentifier(name, contextName, namespace string) (*Identifier, error)
  • func (id *Identifier) ContainerName() string
  • func (id *Identifier) InfoFileName() string
  • func (id *Identifier) String() string
• type Info
  • func LoadInfo(ctx context.Context, file string) (*Info, error)
  • func LoadInfos(ctx context.Context) ([]*Info, error)
  • func LoadMatchingInfo(ctx context.Context, match *regexp.Regexp) (*Info, error)
• type InfoMatchError
  • func (i InfoMatchError) Error() string
• type Request
  • func GetRequest(ctx context.Context) *Request
  • func InitRequest(cmd *cobra.Command) *Request
  • func (cr *Request) CommitFlags(cmd *cobra.Command) error
  • func (cr *Request) GetAllNamespaces(cmd *cobra.Command) ([]string, error)
  • func (cr *Request) GetConfig(cmd *cobra.Command) (*api.Config, error)
• type Session
  • func GetSession(ctx context.Context) *Session
• type UserClient
  • func GetUserClient(ctx context.Context) *UserClient
  • func (ud *UserClient) DaemonPort() int
  • func (c *UserClient) Remote() bool

Functions

func DeleteInfo

func DeleteInfo(ctx context.Context, file string) error

func GetKubeStartingConfig

func GetKubeStartingConfig(cmd *cobra.Command) (*api.Config, error)

func InfoExists

func InfoExists(ctx context.Context, file string) (bool, error)

func KeepInfoAlive

func KeepInfoAlive(ctx context.Context, file string) error

KeepInfoAlive updates the access and modification times of the given Info periodically so that it never gets older than keepAliveInterval. This means that any file with a modification time older than the current time minus two keepAliveIntervals can be considered stale and should be removed.

The alive poll ends and the Info is deleted when the context is cancelled.

func SafeContainerName

func SafeContainerName(name string) string

SafeContainerName returns a string that can safely be used as an argument to docker run --name. Only characters [a-zA-Z0-9][a-zA-Z0-9_.-] are allowed. Others are replaced by an underscore, or if it's the very first character, by the character 'a'.

func SaveInfo

func SaveInfo(ctx context.Context, object *Info, file string) error

func WatchInfos

func WatchInfos(ctx context.Context, onChange func(context.Context) error, files ...string) error

func WithDefaultRequest

func WithDefaultRequest(ctx context.Context, cmd *cobra.Command) (context.Context, error)

func WithSession

func WithSession(ctx context.Context, s *Session) context.Context

func WithUserClient

func WithUserClient(ctx context.Context, ud *UserClient) context.Context

Types

type Identifier

type Identifier struct {
	Name        string
	KubeContext string
	Namespace   string
}

func IdentifierFromFlags

func IdentifierFromFlags(name string, flagMap map[string]string) (*Identifier, error)

IdentifierFromFlags returns a unique name created from the name of the current context and the active namespace denoted by the given flagMap.

func NewIdentifier

func NewIdentifier(name, contextName, namespace string) (*Identifier, error)

func (*Identifier) ContainerName

func (id *Identifier) ContainerName() string

func (*Identifier) InfoFileName

func (id *Identifier) InfoFileName() string

func (*Identifier) String

func (id *Identifier) String() string

type Info

type Info struct {
	Options     map[string]string `json:"options,omitempty"`
	InDocker    bool              `json:"in_docker,omitempty"`
	Name        string            `json:"name,omitempty"`
	KubeContext string            `json:"kube_context,omitempty"`
	Namespace   string            `json:"namespace,omitempty"`
	DaemonPort  int               `json:"daemon_port,omitempty"`
}

func LoadInfo

func LoadInfo(ctx context.Context, file string) (*Info, error)

func LoadInfos

func LoadInfos(ctx context.Context) ([]*Info, error)

func LoadMatchingInfo

func LoadMatchingInfo(ctx context.Context, match *regexp.Regexp) (*Info, error)

type InfoMatchError

type InfoMatchError string

func (InfoMatchError) Error

func (i InfoMatchError) Error() string

type Request

type Request struct {
	connector.ConnectRequest

	// If set, then use a containerized daemon for the connection.
	Docker bool

	// Match expression to use when finding an existing connection by name
	Use *regexp.Regexp

	// Request is created on-demand, not by InitRequest
	Implicit bool

	UserDaemonProfilingPort uint16
	RootDaemonProfilingPort uint16
	// contains filtered or unexported fields
}

func GetRequest

func GetRequest(ctx context.Context) *Request

func InitRequest

func InitRequest(cmd *cobra.Command) *Request

InitRequest adds the networking flags and Kubernetes flags to the given command and returns a Request and a FlagSet with the Kubernetes flags. The FlagSet is returned here so that a map of flags that gets modified can be extracted using FlagMap once the flag parsing has completed.

func (*Request) CommitFlags

func (cr *Request) CommitFlags(cmd *cobra.Command) error

func (*Request) GetAllNamespaces

func (cr *Request) GetAllNamespaces(cmd *cobra.Command) ([]string, error)

func (*Request) GetConfig

func (cr *Request) GetConfig(cmd *cobra.Command) (*api.Config, error)

type Session

type Session struct {
	UserClient
	Info    *connector.ConnectInfo
	Started bool
}

func GetSession

func GetSession(ctx context.Context) *Session

type UserClient

type UserClient struct {
	connector.ConnectorClient
	Conn     *grpc.ClientConn
	DaemonID *Identifier
}

func GetUserClient

func GetUserClient(ctx context.Context) *UserClient

func (*UserClient) DaemonPort

func (ud *UserClient) DaemonPort() int

func (*UserClient) Remote

func (c *UserClient) Remote() bool