cli

Documentation

Overview

Package cli describes the operating environment for the Helm CLI.

Helm's environment encapsulates all of the service dependencies Helm has. These dependencies are expressed as interfaces so that alternate implementations (mocks, etc.) can be easily generated.

Index

• type EnvSettings
  • func New() *EnvSettings
  • func (s *EnvSettings) AddFlags(fs *pflag.FlagSet)
  • func (s *EnvSettings) EnvVars() map[string]string
  • func (s *EnvSettings) Namespace() string
  • func (s *EnvSettings) RESTClientGetter() genericclioptions.RESTClientGetter
  • func (s *EnvSettings) SetNamespace(namespace string)

Types

type EnvSettings

type EnvSettings struct {

	// KubeConfig is the path to the kubeconfig file
	KubeConfig string
	// KubeContext is the name of the kubeconfig context.
	KubeContext string
	// Bearer KubeToken used for authentication
	KubeToken string
	// Username to impersonate for the operation
	KubeAsUser string
	// Groups to impersonate for the operation, multiple groups parsed from a comma delimited list
	KubeAsGroups []string
	// Kubernetes API Server Endpoint for authentication
	KubeAPIServer string
	// Custom certificate authority file.
	KubeCaFile string
	// KubeInsecureSkipTLSVerify indicates if server's certificate will not be checked for validity.
	// This makes the HTTPS connections insecure
	KubeInsecureSkipTLSVerify bool
	// KubeTLSServerName overrides the name to use for server certificate validation.
	// If it is not provided, the hostname used to contact the server is used
	KubeTLSServerName string
	// Debug indicates whether or not Helm is running in Debug mode.
	Debug bool
	// RegistryConfig is the path to the registry config file.
	RegistryConfig string
	// RepositoryConfig is the path to the repositories file.
	RepositoryConfig string
	// RepositoryCache is the path to the repository cache directory.
	RepositoryCache string
	// PluginsDirectory is the path to the plugins directory.
	PluginsDirectory string
	// MaxHistory is the max release history maintained.
	MaxHistory int
	// BurstLimit is the default client-side throttling limit.
	BurstLimit int
	// QPS is queries per second which may be used to avoid throttling.
	QPS float32
	// contains filtered or unexported fields
}

EnvSettings describes all of the environment settings.

func New

func New() *EnvSettings

func (*EnvSettings) AddFlags

func (s *EnvSettings) AddFlags(fs *pflag.FlagSet)

AddFlags binds flags to the given flagset.

func (*EnvSettings) EnvVars

func (s *EnvSettings) EnvVars() map[string]string

func (*EnvSettings) Namespace

func (s *EnvSettings) Namespace() string

Namespace gets the namespace from the configuration

func (*EnvSettings) RESTClientGetter

func (s *EnvSettings) RESTClientGetter() genericclioptions.RESTClientGetter

RESTClientGetter gets the kubeconfig from EnvSettings

func (*EnvSettings) SetNamespace

func (s *EnvSettings) SetNamespace(namespace string)

SetNamespace sets the namespace in the configuration