Documentation ¶
Index ¶
- Variables
- func AddSubCommands(cmd *cobra.Command)
- func GetCommandKubeConfig(cmd *cobra.Command) (*client.Kubeconfig, error)
- func MergeSubCommands(ctx context.Context, commands ...*cobra.Command) context.Context
- func OnlySubcommands(cmd *cobra.Command, args []string) error
- func RunSubcommands(cmd *cobra.Command, args []string) error
- func Telepresence(ctx context.Context) *cobra.Command
- func TelepresenceDaemon(ctx context.Context) *cobra.Command
- func WithDaemonSubCommands(ctx context.Context) context.Context
- func WithSubCommands(ctx context.Context) context.Context
- type ConnectStatusIntercept
- type ContainerizedDaemonStatus
- type HelmCommand
- type MultiConnectStatusInfo
- type RootDaemonStatus
- type SingleConnectStatusInfo
- type StatusInfo
- type TrafficManagerStatus
- type UserDaemonStatus
Constants ¶
This section is empty.
Variables ¶
var ( HelmInstallExtendFlagsFunc func(*pflag.FlagSet) //nolint:gochecknoglobals // extension point HelmExtendFlagsFunc func(*pflag.FlagSet) //nolint:gochecknoglobals // extension point HelmInstallPrologFunc func(context.Context, *pflag.FlagSet, *HelmCommand) error //nolint:gochecknoglobals // extension point )
var CLIHelpDocumentationURL = "https://www.telepresence.io" //nolint:gochecknoglobals // extension point
var GetStatusInfo = func(ctx context.Context) (ioutil.WriterTos, error) { return nil, nil }
GetStatusInfo may return an extended struct
var GetTrafficManagerStatusExtras = func(context.Context, *daemon.UserClient) ioutil.KeyValueProvider { return nil }
GetTrafficManagerStatusExtras may return an extended struct
Functions ¶
func AddSubCommands ¶
AddSubCommands adds subcommands to the given command, including the default help, the commands in the CommandGroups found in the given command's context, and the completion command. It also replaces the standard usage template with a custom template.
func GetCommandKubeConfig ¶ added in v2.18.0
func GetCommandKubeConfig(cmd *cobra.Command) (*client.Kubeconfig, error)
GetCommandKubeConfig will return the fully resolved client.Kubeconfig for the given command.
func MergeSubCommands ¶
func OnlySubcommands ¶
OnlySubcommands is a cobra.PositionalArgs that is similar to cobra.NoArgs, but prints a better error message.
func RunSubcommands ¶
RunSubcommands is for use as a cobra.interceptCmd.RunE for commands that don't do anything themselves but have subcommands. In such cases, it is important to set RunE even though there's nothing to run, because otherwise cobra will treat that as "success", and it shouldn't be "success" if the user typos a command and types something invalid.
func Telepresence ¶
Telepresence returns the top level "telepresence" CLI command.
func TelepresenceDaemon ¶
TelepresenceDaemon returns the top level "telepresence" CLI limited to the subcommands [kubeauth|connector|daemon]-foreground.
func WithDaemonSubCommands ¶ added in v2.14.3
Types ¶
type ConnectStatusIntercept ¶ added in v2.18.0
type ContainerizedDaemonStatus ¶ added in v2.18.0
type ContainerizedDaemonStatus struct { *UserDaemonStatus `yaml:",inline"` DNS *client.DNSSnake `json:"dns,omitempty" yaml:"dns,omitempty"` *client.RoutingSnake `yaml:",inline"` }
type HelmCommand ¶
type HelmCommand struct { helm.Request AllValues map[string]any // contains filtered or unexported fields }
func (*HelmCommand) Type ¶
func (ha *HelmCommand) Type() helm.RequestType
type MultiConnectStatusInfo ¶ added in v2.18.0
type MultiConnectStatusInfo struct {
// contains filtered or unexported fields
}
func (*MultiConnectStatusInfo) MarshalJSON ¶ added in v2.18.0
func (s *MultiConnectStatusInfo) MarshalJSON() ([]byte, error)
func (*MultiConnectStatusInfo) MarshalYAML ¶ added in v2.18.0
func (s *MultiConnectStatusInfo) MarshalYAML() (any, error)
func (*MultiConnectStatusInfo) WriterTos ¶ added in v2.18.0
func (s *MultiConnectStatusInfo) WriterTos() []io.WriterTo
type RootDaemonStatus ¶ added in v2.16.0
type RootDaemonStatus struct { Running bool `json:"running,omitempty" yaml:"running,omitempty"` Name string `json:"name,omitempty" yaml:"name,omitempty"` Version string `json:"version,omitempty" yaml:"version,omitempty"` APIVersion int32 `json:"api_version,omitempty" yaml:"api_version,omitempty"` DNS *client.DNSSnake `json:"dns,omitempty" yaml:"dns,omitempty"` *client.RoutingSnake `yaml:",inline"` }
type SingleConnectStatusInfo ¶ added in v2.18.0
type SingleConnectStatusInfo struct {
// contains filtered or unexported fields
}
func (*SingleConnectStatusInfo) MarshalJSON ¶ added in v2.18.0
func (s *SingleConnectStatusInfo) MarshalJSON() ([]byte, error)
func (*SingleConnectStatusInfo) MarshalYAML ¶ added in v2.18.0
func (s *SingleConnectStatusInfo) MarshalYAML() (any, error)
func (*SingleConnectStatusInfo) WriterTos ¶ added in v2.18.0
func (s *SingleConnectStatusInfo) WriterTos() []io.WriterTo
type StatusInfo ¶
type StatusInfo struct { RootDaemon RootDaemonStatus `json:"root_daemon" yaml:"root_daemon"` UserDaemon UserDaemonStatus `json:"user_daemon" yaml:"user_daemon"` TrafficManager TrafficManagerStatus `json:"traffic_manager" yaml:"traffic_manager"` }
func (*StatusInfo) MarshalJSON ¶ added in v2.18.0
func (s *StatusInfo) MarshalJSON() ([]byte, error)
func (*StatusInfo) MarshalYAML ¶ added in v2.18.0
func (s *StatusInfo) MarshalYAML() (any, error)
func (*StatusInfo) WriterTos ¶
func (s *StatusInfo) WriterTos() []io.WriterTo
type TrafficManagerStatus ¶ added in v2.18.0
type TrafficManagerStatus struct { Name string `json:"name,omitempty" yaml:"name,omitempty"` Version string `json:"version,omitempty" yaml:"version,omitempty"` TrafficAgent string `json:"traffic_agent,omitempty" yaml:"traffic_agent,omitempty"` // contains filtered or unexported fields }
func (*TrafficManagerStatus) MarshalJSON ¶ added in v2.18.0
func (ts *TrafficManagerStatus) MarshalJSON() ([]byte, error)
func (*TrafficManagerStatus) MarshalYAML ¶ added in v2.18.0
func (ts *TrafficManagerStatus) MarshalYAML() (any, error)
type UserDaemonStatus ¶ added in v2.16.0
type UserDaemonStatus struct { Running bool `json:"running,omitempty" yaml:"running,omitempty"` InDocker bool `json:"in_docker,omitempty" yaml:"in_docker,omitempty"` Name string `json:"name,omitempty" yaml:"name,omitempty"` DaemonPort int `json:"daemon_port,omitempty" yaml:"daemon_port,omitempty"` ContainerNetwork string `json:"container_network,omitempty" yaml:"container_network,omitempty"` Hostname string `json:"hostname,omitempty" yaml:"hostname,omitempty"` ExposedPorts []string `json:"exposedPorts,omitempty" yaml:"exposedPorts,omitempty"` Version string `json:"version,omitempty" yaml:"version,omitempty"` Executable string `json:"executable,omitempty" yaml:"executable,omitempty"` InstallID string `json:"install_id,omitempty" yaml:"install_id,omitempty"` Status string `json:"status,omitempty" yaml:"status,omitempty"` Error string `json:"error,omitempty" yaml:"error,omitempty"` KubernetesServer string `json:"kubernetes_server,omitempty" yaml:"kubernetes_server,omitempty"` KubernetesContext string `json:"kubernetes_context,omitempty" yaml:"kubernetes_context,omitempty"` Namespace string `json:"namespace,omitempty" yaml:"namespace,omitempty"` ManagerNamespace string `json:"manager_namespace,omitempty" yaml:"manager_namespace,omitempty"` MappedNamespaces []string `json:"mapped_namespaces,omitempty" yaml:"mapped_namespaces,omitempty"` Intercepts []ConnectStatusIntercept `json:"intercepts,omitempty" yaml:"intercepts,omitempty"` // contains filtered or unexported fields }
Source Files ¶
- completion.go
- config.go
- connect.go
- current_cluster_id.go
- gather_logs.go
- gather_traces.go
- genyaml.go
- helm.go
- intercept.go
- kubeauth.go
- leave.go
- legacy_command.go
- list.go
- list_contexts.go
- list_namespaces.go
- loglevel.go
- quit.go
- status.go
- telepresence.go
- test_vpn.go
- uninstall.go
- upload_traces.go
- usage.go
- version.go