cli

Documentation

Index

• Variables
• func AddSubCommands(cmd *cobra.Command)
• func BasicGetStatusInfo(ctx context.Context) (ioutil.WriterTos, error)
• func ClusterIdCommand() *cobra.Command
• func Command(ctx context.Context) *cobra.Command
• func GatherTracesCommand() *cobra.Command
• func GlobalFlags() *pflag.FlagSet
• func InitConnectRequest(cmd *cobra.Command) (*connector.ConnectRequest, *pflag.FlagSet)
• func InitContext(ctx context.Context) context.Context
• func Main(ctx context.Context)
• func OnlySubcommands(cmd *cobra.Command, args []string) error
• func PerhapsLegacyCommands(cmd *cobra.Command, args []string) error
• func PushTracesCommand() *cobra.Command
• func RunSubcommands(cmd *cobra.Command, args []string) error
• func WithSubCommands(ctx context.Context) context.Context
• type HelmOpts
  • func (ha *HelmOpts) Type() connector.HelmRequest_Type
• type StatusInfo
  • func (s *StatusInfo) WriterTos() []io.WriterTo

Variables

var (
	HelmInstallExtendFlagsFunc func(*pflag.FlagSet)                                   //nolint:gochecknoglobals // extension point
	HelmInstallPrologFunc      func(context.Context, *pflag.FlagSet, *HelmOpts) error //nolint:gochecknoglobals // extension point
)

var GetStatusInfo = BasicGetStatusInfo //nolint:gochecknoglobals // extension point

GetStatusInfo may return an extended struct, based on the one returned by the BasicGetStatusInfo.

Functions

func AddSubCommands

func AddSubCommands(cmd *cobra.Command)

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 BasicGetStatusInfo

func BasicGetStatusInfo(ctx context.Context) (ioutil.WriterTos, error)

func ClusterIdCommand

func ClusterIdCommand() *cobra.Command

ClusterIdCommand is a simple command that makes it easier for users to figure out what their cluster ID is. For now this is just used when people are making licenses for air-gapped environments.

func Command

func Command(ctx context.Context) *cobra.Command

Command returns the top level "telepresence" CLI command.

func GatherTracesCommand

func GatherTracesCommand() *cobra.Command

func GlobalFlags

func GlobalFlags() *pflag.FlagSet

func InitConnectRequest

func InitConnectRequest(cmd *cobra.Command) (*connector.ConnectRequest, *pflag.FlagSet)

InitConnectRequest adds the networking flags and Kubernetes flags to the given command and returns a ConnectRequest 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 InitContext

func InitContext(ctx context.Context) context.Context

func Main

func Main(ctx context.Context)

func OnlySubcommands

func OnlySubcommands(cmd *cobra.Command, args []string) error

OnlySubcommands is a cobra.PositionalArgs that is similar to cobra.NoArgs, but prints a better error message.

func PerhapsLegacyCommands

func PerhapsLegacyCommands(cmd *cobra.Command, args []string) error

PerhapsLegacyCommands is like OnlySubcommands but performs some initial check for legacy flags.

func PushTracesCommand

func PushTracesCommand() *cobra.Command

func RunSubcommands

func RunSubcommands(cmd *cobra.Command, args []string) error

RunSubcommands is for use as a cobra.Command.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 WithSubCommands

func WithSubCommands(ctx context.Context) context.Context

Types

type HelmOpts

type HelmOpts struct {
	values.Options
	AllValues   map[string]any
	ReuseValues bool
	ResetValues bool
	Request     *connector.ConnectRequest
	// contains filtered or unexported fields
}

func (*HelmOpts) Type

func (ha *HelmOpts) Type() connector.HelmRequest_Type

type StatusInfo

type StatusInfo struct {
	RootDaemon io.WriterTo `json:"root_daemon" yaml:"root_daemon"`
	UserDaemon io.WriterTo `json:"user_daemon" yaml:"user_daemon"`
}

func (*StatusInfo) WriterTos

func (s *StatusInfo) WriterTos() []io.WriterTo