config

Documentation

Overview

Example (View)

expectedConfig := newRedFederalCowHammerConfig()
test := configCommandTest{
	args:           []string{"view"},
	startingConfig: newRedFederalCowHammerConfig(),
	expectedConfig: expectedConfig,
}

output := test.run(nil)
fmt.Printf("%v", output)

Output:

apiVersion: v1
clusters:
- cluster:
    server: http://cow.org:8080
  name: cow-cluster
contexts:
- context:
    cluster: cow-cluster
    user: red-user
  name: federal-context
current-context: federal-context
kind: Config
preferences: {}
users:
- name: red-user
  user:
    token: REDACTED

Index

• func NewCmdConfig(f cmdutil.Factory, pathOptions *clientcmd.PathOptions, ...) *cobra.Command
• func NewCmdConfigCurrentContext(out io.Writer, configAccess clientcmd.ConfigAccess) *cobra.Command
• func NewCmdConfigDeleteCluster(out io.Writer, configAccess clientcmd.ConfigAccess) *cobra.Command
• func NewCmdConfigDeleteContext(out, errOut io.Writer, configAccess clientcmd.ConfigAccess) *cobra.Command
• func NewCmdConfigGetClusters(out io.Writer, configAccess clientcmd.ConfigAccess) *cobra.Command
• func NewCmdConfigGetContexts(streams genericclioptions.IOStreams, configAccess clientcmd.ConfigAccess) *cobra.Command
• func NewCmdConfigRenameContext(out io.Writer, configAccess clientcmd.ConfigAccess) *cobra.Command
• func NewCmdConfigSet(out io.Writer, configAccess clientcmd.ConfigAccess) *cobra.Command
• func NewCmdConfigSetAuthInfo(out io.Writer, configAccess clientcmd.ConfigAccess) *cobra.Command
• func NewCmdConfigSetCluster(out io.Writer, configAccess clientcmd.ConfigAccess) *cobra.Command
• func NewCmdConfigSetContext(out io.Writer, configAccess clientcmd.ConfigAccess) *cobra.Command
• func NewCmdConfigUnset(out io.Writer, configAccess clientcmd.ConfigAccess) *cobra.Command
• func NewCmdConfigUseContext(out io.Writer, configAccess clientcmd.ConfigAccess) *cobra.Command
• func NewCmdConfigView(f cmdutil.Factory, streams genericclioptions.IOStreams, ...) *cobra.Command
• func RunCurrentContext(out io.Writer, options *CurrentContextOptions) error
• type CurrentContextOptions
• type GetContextsOptions
  • func (o *GetContextsOptions) Complete(cmd *cobra.Command, args []string) error
  • func (o GetContextsOptions) RunGetContexts() error
• type RenameContextOptions
  • func (o *RenameContextOptions) Complete(cmd *cobra.Command, args []string, out io.Writer) error
  • func (o RenameContextOptions) RunRenameContext(out io.Writer) error
  • func (o RenameContextOptions) Validate() error
• type ViewOptions
  • func (o *ViewOptions) Complete(cmd *cobra.Command, args []string) error
  • func (o ViewOptions) Run() error
  • func (o ViewOptions) Validate() error

Examples

• Package (View)

Functions

func NewCmdConfig

func NewCmdConfig(f cmdutil.Factory, pathOptions *clientcmd.PathOptions, streams genericclioptions.IOStreams) *cobra.Command

NewCmdConfig creates a command object for the "config" action, and adds all child commands to it.

func NewCmdConfigCurrentContext

func NewCmdConfigCurrentContext(out io.Writer, configAccess clientcmd.ConfigAccess) *cobra.Command

NewCmdConfigCurrentContext returns a Command instance for 'config current-context' sub command

func NewCmdConfigDeleteCluster

func NewCmdConfigDeleteCluster(out io.Writer, configAccess clientcmd.ConfigAccess) *cobra.Command

NewCmdConfigDeleteCluster returns a Command instance for 'config delete-cluster' sub command

func NewCmdConfigDeleteContext

func NewCmdConfigDeleteContext(out, errOut io.Writer, configAccess clientcmd.ConfigAccess) *cobra.Command

NewCmdConfigDeleteContext returns a Command instance for 'config delete-context' sub command

func NewCmdConfigGetClusters

func NewCmdConfigGetClusters(out io.Writer, configAccess clientcmd.ConfigAccess) *cobra.Command

NewCmdConfigGetClusters creates a command object for the "get-clusters" action, which lists all clusters defined in the kubeconfig.

func NewCmdConfigGetContexts

func NewCmdConfigGetContexts(streams genericclioptions.IOStreams, configAccess clientcmd.ConfigAccess) *cobra.Command

NewCmdConfigGetContexts creates a command object for the "get-contexts" action, which retrieves one or more contexts from a kubeconfig.

func NewCmdConfigRenameContext

func NewCmdConfigRenameContext(out io.Writer, configAccess clientcmd.ConfigAccess) *cobra.Command

NewCmdConfigRenameContext creates a command object for the "rename-context" action

func NewCmdConfigSet

func NewCmdConfigSet(out io.Writer, configAccess clientcmd.ConfigAccess) *cobra.Command

NewCmdConfigSet returns a Command instance for 'config set' sub command

func NewCmdConfigSetAuthInfo

func NewCmdConfigSetAuthInfo(out io.Writer, configAccess clientcmd.ConfigAccess) *cobra.Command

NewCmdConfigSetAuthInfo returns an Command option instance for 'config set-credentials' sub command

func NewCmdConfigSetCluster

func NewCmdConfigSetCluster(out io.Writer, configAccess clientcmd.ConfigAccess) *cobra.Command

NewCmdConfigSetCluster returns a Command instance for 'config set-cluster' sub command

func NewCmdConfigSetContext

func NewCmdConfigSetContext(out io.Writer, configAccess clientcmd.ConfigAccess) *cobra.Command

NewCmdConfigSetContext returns a Command instance for 'config set-context' sub command

func NewCmdConfigUnset

func NewCmdConfigUnset(out io.Writer, configAccess clientcmd.ConfigAccess) *cobra.Command

NewCmdConfigUnset returns a Command instance for 'config unset' sub command

func NewCmdConfigUseContext

func NewCmdConfigUseContext(out io.Writer, configAccess clientcmd.ConfigAccess) *cobra.Command

NewCmdConfigUseContext returns a Command instance for 'config use-context' sub command

func NewCmdConfigView

func NewCmdConfigView(f cmdutil.Factory, streams genericclioptions.IOStreams, ConfigAccess clientcmd.ConfigAccess) *cobra.Command

NewCmdConfigView returns a Command instance for 'config view' sub command

func RunCurrentContext

func RunCurrentContext(out io.Writer, options *CurrentContextOptions) error

RunCurrentContext performs the execution of 'config current-context' sub command

Types

type CurrentContextOptions

type CurrentContextOptions struct {
	ConfigAccess clientcmd.ConfigAccess
}

CurrentContextOptions holds the command-line options for 'config current-context' sub command

type GetContextsOptions

type GetContextsOptions struct {
	genericclioptions.IOStreams
	// contains filtered or unexported fields
}

GetContextsOptions contains the assignable options from the args.

func (*GetContextsOptions) Complete

func (o *GetContextsOptions) Complete(cmd *cobra.Command, args []string) error

Complete assigns GetContextsOptions from the args.

func (GetContextsOptions) RunGetContexts

func (o GetContextsOptions) RunGetContexts() error

RunGetContexts implements all the necessary functionality for context retrieval.

type RenameContextOptions

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

RenameContextOptions contains the options for running the rename-context cli command.

func (*RenameContextOptions) Complete

func (o *RenameContextOptions) Complete(cmd *cobra.Command, args []string, out io.Writer) error

Complete assigns RenameContextOptions from the args.

func (RenameContextOptions) RunRenameContext

func (o RenameContextOptions) RunRenameContext(out io.Writer) error

RunRenameContext performs the execution for 'config rename-context' sub command

func (RenameContextOptions) Validate

func (o RenameContextOptions) Validate() error

Validate makes sure that provided values for command-line options are valid

type ViewOptions

type ViewOptions struct {
	PrintFlags  *genericclioptions.PrintFlags
	PrintObject printers.ResourcePrinterFunc

	ConfigAccess clientcmd.ConfigAccess
	Merge        cliflag.Tristate
	Flatten      bool
	Minify       bool
	RawByteData  bool

	Context      string
	OutputFormat string

	genericclioptions.IOStreams
}

ViewOptions holds the command-line options for 'config view' sub command

func (*ViewOptions) Complete

func (o *ViewOptions) Complete(cmd *cobra.Command, args []string) error

Complete completes the required command-line options

func (ViewOptions) Run

func (o ViewOptions) Run() error

Run performs the execution of 'config view' sub command

func (ViewOptions) Validate

func (o ViewOptions) Validate() error

Validate makes sure that provided values for command-line options are valid