cmd

Documentation

Index

• Variables
• func GetApplicationsForCompletion(ctx context.Context, f Factory, namespace string, toComplete string) ([]string, cobra.ShellCompDirective)
• func GetCluster(cmd *cobra.Command) string
• func GetClusters(cmd *cobra.Command) []string
• func GetClustersForCompletion(ctx context.Context, f Factory, toComplete string) ([]string, cobra.ShellCompDirective)
• func GetNamespace(f Factory, cmd *cobra.Command) string
• func GetNamespacesForCompletion(ctx context.Context, f Factory, toComplete string) ([]string, cobra.ShellCompDirective)
• func GetRevisionForCompletion(ctx context.Context, f Factory, appName string, namespace string, ...) ([]string, cobra.ShellCompDirective)
• func GetServiceAccountForCompletion(ctx context.Context, f Factory, namespace string, toComplete string) ([]string, cobra.ShellCompDirective)
• type Builder
  • func NewCommandBuilder(f Factory, cmd *cobra.Command) *Builder
  • func (builder *Builder) Build() *cobra.Command
  • func (builder *Builder) WithClusterFlag(options ...ClusterFlagOption) *Builder
  • func (builder *Builder) WithEnvFlag() *Builder
  • func (builder *Builder) WithNamespaceFlag(options ...NamespaceFlagOption) *Builder
  • func (builder *Builder) WithResponsiveWriter() *Builder
  • func (builder *Builder) WithStreams(streams util.IOStreams) *Builder
• type ClientGetter
• type ClusterFlagConfig
• type ClusterFlagDisableSliceInputOption
  • func (option ClusterFlagDisableSliceInputOption) ApplyToClusterFlagOptions(cfg *ClusterFlagConfig)
• type ClusterFlagOption
• type ConfigGetter
• type Factory
  • func NewDefaultFactory(cfg *rest.Config) Factory
  • func NewDeferredFactory(getter ConfigGetter) Factory
  • func NewDelegateFactory(clientGetter ClientGetter, configGetter ConfigGetter) Factory
  • func NewTestFactory(cfg *rest.Config, cli client.Client) Factory
• type FlagNoCompletionOption
  • func (option FlagNoCompletionOption) ApplyToClusterFlagOptions(cfg *ClusterFlagConfig)
  • func (option FlagNoCompletionOption) ApplyToNamespaceFlagOptions(cfg *NamespaceFlagConfig)
• type NamespaceFlagConfig
• type NamespaceFlagDisableEnvOption
  • func (option NamespaceFlagDisableEnvOption) ApplyToNamespaceFlagOptions(cfg *NamespaceFlagConfig)
• type NamespaceFlagOption
• type UsageOption
  • func (option UsageOption) ApplyToClusterFlagOptions(cfg *ClusterFlagConfig)
  • func (option UsageOption) ApplyToNamespaceFlagOptions(cfg *NamespaceFlagConfig)

Variables

var (
	// DefaultRateLimiter default rate limiter for cmd client
	DefaultRateLimiter = flowcontrol.NewTokenBucketRateLimiter(100, 200)
)

Functions

func GetApplicationsForCompletion

func GetApplicationsForCompletion(ctx context.Context, f Factory, namespace string, toComplete string) ([]string, cobra.ShellCompDirective)

GetApplicationsForCompletion auto-complete application

func GetCluster

func GetCluster(cmd *cobra.Command) string

GetCluster get cluster from command flags

func GetClusters

func GetClusters(cmd *cobra.Command) []string

GetClusters get cluster from command flags

func GetClustersForCompletion

func GetClustersForCompletion(ctx context.Context, f Factory, toComplete string) ([]string, cobra.ShellCompDirective)

GetClustersForCompletion auto-complete the cluster

func GetNamespace

func GetNamespace(f Factory, cmd *cobra.Command) string

GetNamespace get namespace from command flags and env

func GetNamespacesForCompletion

func GetNamespacesForCompletion(ctx context.Context, f Factory, toComplete string) ([]string, cobra.ShellCompDirective)

GetNamespacesForCompletion auto-complete the namespace

func GetRevisionForCompletion

func GetRevisionForCompletion(ctx context.Context, f Factory, appName string, namespace string, toComplete string) ([]string, cobra.ShellCompDirective)

GetRevisionForCompletion auto-complete the revision according to the application

func GetServiceAccountForCompletion

func GetServiceAccountForCompletion(ctx context.Context, f Factory, namespace string, toComplete string) ([]string, cobra.ShellCompDirective)

GetServiceAccountForCompletion auto-complete serviceaccount

Types

type Builder

type Builder struct {
	// contains filtered or unexported fields
}

Builder build command with factory

func NewCommandBuilder

func NewCommandBuilder(f Factory, cmd *cobra.Command) *Builder

NewCommandBuilder builder for command

func (*Builder) Build

func (builder *Builder) Build() *cobra.Command

Build construct the command

func (*Builder) WithClusterFlag

func (builder *Builder) WithClusterFlag(options ...ClusterFlagOption) *Builder

WithClusterFlag add cluster flag to the command

func (*Builder) WithEnvFlag

func (builder *Builder) WithEnvFlag() *Builder

WithEnvFlag add env flag to the command

func (*Builder) WithNamespaceFlag

func (builder *Builder) WithNamespaceFlag(options ...NamespaceFlagOption) *Builder

WithNamespaceFlag add namespace flag to the command, by default, it will also add env flag to the command

func (*Builder) WithResponsiveWriter

func (builder *Builder) WithResponsiveWriter() *Builder

WithResponsiveWriter format the command outputs

func (*Builder) WithStreams

func (builder *Builder) WithStreams(streams util.IOStreams) *Builder

WithStreams set the in/out/err streams for the command

type ClientGetter

type ClientGetter func() (client.Client, error)

ClientGetter function for getting client

type ClusterFlagConfig

type ClusterFlagConfig struct {
	// contains filtered or unexported fields
}

ClusterFlagConfig config for cluster flag in cmd

type ClusterFlagDisableSliceInputOption

type ClusterFlagDisableSliceInputOption struct{}

ClusterFlagDisableSliceInputOption set the cluster flag to allow multiple input

func (ClusterFlagDisableSliceInputOption) ApplyToClusterFlagOptions

func (option ClusterFlagDisableSliceInputOption) ApplyToClusterFlagOptions(cfg *ClusterFlagConfig)

ApplyToClusterFlagOptions .

type ClusterFlagOption

type ClusterFlagOption interface {
	ApplyToClusterFlagOptions(*ClusterFlagConfig)
}

ClusterFlagOption the option for configuring cluster flag

type ConfigGetter

type ConfigGetter func() (*rest.Config, error)

ConfigGetter function for getting config

type Factory

type Factory interface {
	Client() client.Client
	Config() *rest.Config
}

Factory client factory for running command

func NewDefaultFactory

func NewDefaultFactory(cfg *rest.Config) Factory

NewDefaultFactory create a factory based on client getter function

func NewDeferredFactory

func NewDeferredFactory(getter ConfigGetter) Factory

NewDeferredFactory create a factory that will only get KubeConfig until it is needed for the first time

func NewDelegateFactory

func NewDelegateFactory(clientGetter ClientGetter, configGetter ConfigGetter) Factory

NewDelegateFactory create a factory based on getter function

func NewTestFactory

func NewTestFactory(cfg *rest.Config,
	cli client.Client) Factory

NewTestFactory new a factory for the testing

type FlagNoCompletionOption

type FlagNoCompletionOption struct{}

FlagNoCompletionOption disable auto-completion for flag

func (FlagNoCompletionOption) ApplyToClusterFlagOptions

func (option FlagNoCompletionOption) ApplyToClusterFlagOptions(cfg *ClusterFlagConfig)

ApplyToClusterFlagOptions .

func (FlagNoCompletionOption) ApplyToNamespaceFlagOptions

func (option FlagNoCompletionOption) ApplyToNamespaceFlagOptions(cfg *NamespaceFlagConfig)

ApplyToNamespaceFlagOptions .

type NamespaceFlagConfig

type NamespaceFlagConfig struct {
	// contains filtered or unexported fields
}

NamespaceFlagConfig config for namespace flag in cmd

type NamespaceFlagDisableEnvOption

type NamespaceFlagDisableEnvOption struct{}

NamespaceFlagDisableEnvOption disable loading namespace from env

func (NamespaceFlagDisableEnvOption) ApplyToNamespaceFlagOptions

func (option NamespaceFlagDisableEnvOption) ApplyToNamespaceFlagOptions(cfg *NamespaceFlagConfig)

ApplyToNamespaceFlagOptions .

type NamespaceFlagOption

type NamespaceFlagOption interface {
	ApplyToNamespaceFlagOptions(*NamespaceFlagConfig)
}

NamespaceFlagOption the option for configuring namespace flag in cmd

type UsageOption

type UsageOption string

UsageOption the usage description for flag

func (UsageOption) ApplyToClusterFlagOptions

func (option UsageOption) ApplyToClusterFlagOptions(cfg *ClusterFlagConfig)

ApplyToClusterFlagOptions .

func (UsageOption) ApplyToNamespaceFlagOptions

func (option UsageOption) ApplyToNamespaceFlagOptions(cfg *NamespaceFlagConfig)

ApplyToNamespaceFlagOptions .