Documentation
¶
Overview ¶
Package clientcmd provides one stop shopping for building a working client from a fixed config, from a .kubeconfig file, from command line flags, or from any merged combination.
Sample usage from merged .kubeconfig files (local directory, home directory)
loadingRules := clientcmd.NewDefaultClientConfigLoadingRules() // if you want to change the loading rules (which files in which order), you can do so here configOverrides := &clientcmd.ConfigOverrides{} // if you want to change override values or bind them to flags, there are methods to help you kubeConfig := clientcmd.NewNonInteractiveDeferredLoadingClientConfig(loadingRules, configOverrides) config, err := kubeConfig.ClientConfig() if err != nil { // Do something } client, err := unversioned.New(config) // ...
Index ¶
- Constants
- Variables
- func BindAuthInfoFlags(authInfo *clientcmdapi.AuthInfo, flags *pflag.FlagSet, ...)
- func BindClusterFlags(clusterInfo *clientcmdapi.Cluster, flags *pflag.FlagSet, ...)
- func BindContextFlags(contextInfo *clientcmdapi.Context, flags *pflag.FlagSet, ...)
- func BindOverrideFlags(overrides *ConfigOverrides, flags *pflag.FlagSet, ...)
- func BuildConfigFromFlags(masterUrl, kubeconfigPath string) (*restclient.Config, error)
- func ConfirmUsable(config clientcmdapi.Config, passedContextName string) error
- func GetAuthInfoFileReferences(authInfo *clientcmdapi.AuthInfo) []*string
- func GetClusterFileReferences(cluster *clientcmdapi.Cluster) []*string
- func GetConfigFileReferences(config *clientcmdapi.Config) []*string
- func IsConfigurationInvalid(err error) bool
- func IsContextNotFound(err error) bool
- func IsEmptyConfig(err error) bool
- func Load(data []byte) (*clientcmdapi.Config, error)
- func LoadFromFile(filename string) (*clientcmdapi.Config, error)
- func MakeRelative(path, base string) (string, error)
- func RelativizeAuthInfoLocalPaths(authInfo *clientcmdapi.AuthInfo) error
- func RelativizeClusterLocalPaths(cluster *clientcmdapi.Cluster) error
- func RelativizeConfigPaths(config *clientcmdapi.Config, base string) error
- func RelativizePathWithNoBacksteps(refs []*string, base string) error
- func ResolveConfigPaths(config *clientcmdapi.Config, base string) error
- func ResolveLocalPaths(config *clientcmdapi.Config) error
- func ResolvePaths(refs []*string, base string) error
- func Validate(config clientcmdapi.Config) error
- func Write(config clientcmdapi.Config) ([]byte, error)
- func WriteToFile(config clientcmdapi.Config, filename string) error
- type AuthLoader
- type AuthOverrideFlags
- type ClientConfig
- func NewDefaultClientConfig(config clientcmdapi.Config, overrides *ConfigOverrides) ClientConfig
- func NewInteractiveClientConfig(config clientcmdapi.Config, contextName string, overrides *ConfigOverrides, ...) ClientConfig
- func NewInteractiveDeferredLoadingClientConfig(loadingRules *ClientConfigLoadingRules, overrides *ConfigOverrides, ...) ClientConfig
- func NewNonInteractiveClientConfig(config clientcmdapi.Config, contextName string, overrides *ConfigOverrides) ClientConfig
- func NewNonInteractiveDeferredLoadingClientConfig(loadingRules *ClientConfigLoadingRules, overrides *ConfigOverrides) ClientConfig
- type ClientConfigLoadingRules
- type ClusterOverrideFlags
- type ConfigOverrideFlags
- type ConfigOverrides
- type ContextOverrideFlags
- type DeferredLoadingClientConfig
- type DirectClientConfig
- type FlagInfo
- type PromptingAuthLoader
Constants ¶
const ( RecommendedConfigPathFlag = "kubeconfig" RecommendedConfigPathEnvVar = "KUBECONFIG" RecommendedHomeDir = ".kube" RecommendedFileName = "config" RecommendedSchemaName = "schema" )
const ( FlagClusterName = "cluster" FlagAuthInfoName = "user" FlagContext = "context" FlagNamespace = "namespace" FlagAPIServer = "server" FlagAPIVersion = "api-version" FlagInsecure = "insecure-skip-tls-verify" FlagCertFile = "client-certificate" FlagKeyFile = "client-key" FlagCAFile = "certificate-authority" FlagEmbedCerts = "embed-certs" FlagBearerToken = "token" FlagUsername = "username" FlagPassword = "password" )
Variables ¶
var ( // DefaultCluster is the cluster config used when no other config is specified // TODO: eventually apiserver should start on 443 and be secure by default DefaultCluster = clientcmdapi.Cluster{Server: "http://localhost:8080"} // EnvVarCluster allows overriding the DefaultCluster using an envvar for the server name EnvVarCluster = clientcmdapi.Cluster{Server: os.Getenv("KUBERNETES_MASTER")} DefaultClientConfig = DirectClientConfig{*clientcmdapi.NewConfig(), "", &ConfigOverrides{}, nil} )
var ( ErrNoContext = errors.New("no context chosen") ErrEmptyConfig = errors.New("no configuration has been provided") // message is for consistency with old behavior ErrEmptyCluster = errors.New("cluster has no server defined") )
var OldRecommendedHomeFile = path.Join(os.Getenv("HOME"), "/.kube/.kubeconfig")
var RecommendedHomeFile = path.Join(os.Getenv("HOME"), RecommendedHomeDir, RecommendedFileName)
var RecommendedSchemaFile = path.Join(os.Getenv("HOME"), RecommendedHomeDir, RecommendedSchemaName)
Functions ¶
func BindAuthInfoFlags ¶
func BindAuthInfoFlags(authInfo *clientcmdapi.AuthInfo, flags *pflag.FlagSet, flagNames AuthOverrideFlags)
BindAuthInfoFlags is a convenience method to bind the specified flags to their associated variables
func BindClusterFlags ¶
func BindClusterFlags(clusterInfo *clientcmdapi.Cluster, flags *pflag.FlagSet, flagNames ClusterOverrideFlags)
BindClusterFlags is a convenience method to bind the specified flags to their associated variables
func BindContextFlags ¶
func BindContextFlags(contextInfo *clientcmdapi.Context, flags *pflag.FlagSet, flagNames ContextOverrideFlags)
BindFlags is a convenience method to bind the specified flags to their associated variables
func BindOverrideFlags ¶
func BindOverrideFlags(overrides *ConfigOverrides, flags *pflag.FlagSet, flagNames ConfigOverrideFlags)
BindOverrideFlags is a convenience method to bind the specified flags to their associated variables
func BuildConfigFromFlags ¶ added in v1.2.3
func BuildConfigFromFlags(masterUrl, kubeconfigPath string) (*restclient.Config, error)
BuildConfigFromFlags is a helper function that builds configs from a master url or a kubeconfig filepath. These are passed in as command line flags for cluster components. Warnings should reflect this usage. If neither masterUrl or kubeconfigPath are passed in we fallback to inClusterConfig. If inClusterConfig fails, we fallback to the default config.
func ConfirmUsable ¶
func ConfirmUsable(config clientcmdapi.Config, passedContextName string) error
ConfirmUsable looks a particular context and determines if that particular part of the config is useable. There might still be errors in the config, but no errors in the sections requested or referenced. It does not return early so that it can find as many errors as possible.
func GetAuthInfoFileReferences ¶
func GetAuthInfoFileReferences(authInfo *clientcmdapi.AuthInfo) []*string
func GetClusterFileReferences ¶
func GetClusterFileReferences(cluster *clientcmdapi.Cluster) []*string
func GetConfigFileReferences ¶
func GetConfigFileReferences(config *clientcmdapi.Config) []*string
func IsConfigurationInvalid ¶
IsConfigurationInvalid returns true if the provided error indicates the configuration is invalid.
func IsContextNotFound ¶
IsContextNotFound returns a boolean indicating whether the error is known to report that a context was not found
func IsEmptyConfig ¶ added in v1.2.3
IsEmptyConfig returns true if the provided error indicates the provided configuration is empty.
func Load ¶
func Load(data []byte) (*clientcmdapi.Config, error)
Load takes a byte slice and deserializes the contents into Config object. Encapsulates deserialization without assuming the source is a file.
func LoadFromFile ¶
func LoadFromFile(filename string) (*clientcmdapi.Config, error)
LoadFromFile takes a filename and deserializes the contents into Config object
func MakeRelative ¶
func RelativizeAuthInfoLocalPaths ¶
func RelativizeAuthInfoLocalPaths(authInfo *clientcmdapi.AuthInfo) error
RelativizeAuthInfoLocalPaths first absolutizes the paths by calling ResolveLocalPaths. This assumes that any NEW path is already absolute, but any existing path will be resolved relative to LocationOfOrigin
func RelativizeClusterLocalPaths ¶
func RelativizeClusterLocalPaths(cluster *clientcmdapi.Cluster) error
RelativizeClusterLocalPaths first absolutizes the paths by calling ResolveLocalPaths. This assumes that any NEW path is already absolute, but any existing path will be resolved relative to LocationOfOrigin
func RelativizeConfigPaths ¶
func RelativizeConfigPaths(config *clientcmdapi.Config, base string) error
func RelativizePathWithNoBacksteps ¶
RelativizePathWithNoBacksteps updates the given refs to be relative paths, relative to the given base directory as long as they do not require backsteps. Any path requiring a backstep is left as-is as long it is absolute. Any non-absolute path that can't be relativized produces an error
func ResolveConfigPaths ¶
func ResolveConfigPaths(config *clientcmdapi.Config, base string) error
func ResolveLocalPaths ¶
func ResolveLocalPaths(config *clientcmdapi.Config) error
ResolveLocalPaths resolves all relative paths in the config object with respect to the stanza's LocationOfOrigin this cannot be done directly inside of LoadFromFile because doing so there would make it impossible to load a file without modification of its contents.
func ResolvePaths ¶
ResolvePaths updates the given refs to be absolute paths, relative to the given base directory
func Validate ¶
func Validate(config clientcmdapi.Config) error
Validate checks for errors in the Config. It does not return early so that it can find as many errors as possible.
func Write ¶
func Write(config clientcmdapi.Config) ([]byte, error)
Write serializes the config to yaml. Encapsulates serialization without assuming the destination is a file.
func WriteToFile ¶
func WriteToFile(config clientcmdapi.Config, filename string) error
WriteToFile serializes the config to yaml and writes it out to a file. If not present, it creates the file with the mode 0600. If it is present it stomps the contents
Types ¶
type AuthLoader ¶
type AuthLoader interface { // LoadAuth takes a path to a config file and can then do anything it needs in order to return a valid clientauth.Info LoadAuth(path string) (*clientauth.Info, error) }
AuthLoaders are used to build clientauth.Info objects.
func NewDefaultAuthLoader ¶
func NewDefaultAuthLoader() AuthLoader
NewDefaultAuthLoader returns a default implementation of an AuthLoader that only reads from a config file
type AuthOverrideFlags ¶
type AuthOverrideFlags struct { ClientCertificate FlagInfo ClientKey FlagInfo Token FlagInfo Username FlagInfo Password FlagInfo }
AuthOverrideFlags holds the flag names to be used for binding command line flags for AuthInfo objects
func RecommendedAuthOverrideFlags ¶
func RecommendedAuthOverrideFlags(prefix string) AuthOverrideFlags
RecommendedAuthOverrideFlags is a convenience method to return recommended flag names prefixed with a string of your choosing
type ClientConfig ¶
type ClientConfig interface { // RawConfig returns the merged result of all overrides RawConfig() (clientcmdapi.Config, error) // ClientConfig returns a complete client config ClientConfig() (*restclient.Config, error) // Namespace returns the namespace resulting from the merged // result of all overrides and a boolean indicating if it was // overridden Namespace() (string, bool, error) }
ClientConfig is used to make it easy to get an api server client
func NewDefaultClientConfig ¶
func NewDefaultClientConfig(config clientcmdapi.Config, overrides *ConfigOverrides) ClientConfig
NewDefaultClientConfig creates a DirectClientConfig using the config.CurrentContext as the context name
func NewInteractiveClientConfig ¶
func NewInteractiveClientConfig(config clientcmdapi.Config, contextName string, overrides *ConfigOverrides, fallbackReader io.Reader) ClientConfig
NewInteractiveClientConfig creates a DirectClientConfig using the passed context name and a reader in case auth information is not provided via files or flags
func NewInteractiveDeferredLoadingClientConfig ¶
func NewInteractiveDeferredLoadingClientConfig(loadingRules *ClientConfigLoadingRules, overrides *ConfigOverrides, fallbackReader io.Reader) ClientConfig
NewInteractiveDeferredLoadingClientConfig creates a ConfigClientClientConfig using the passed context name and the fallback auth reader
func NewNonInteractiveClientConfig ¶
func NewNonInteractiveClientConfig(config clientcmdapi.Config, contextName string, overrides *ConfigOverrides) ClientConfig
NewNonInteractiveClientConfig creates a DirectClientConfig using the passed context name and does not have a fallback reader for auth information
func NewNonInteractiveDeferredLoadingClientConfig ¶
func NewNonInteractiveDeferredLoadingClientConfig(loadingRules *ClientConfigLoadingRules, overrides *ConfigOverrides) ClientConfig
NewNonInteractiveDeferredLoadingClientConfig creates a ConfigClientClientConfig using the passed context name
type ClientConfigLoadingRules ¶
type ClientConfigLoadingRules struct { ExplicitPath string Precedence []string // MigrationRules is a map of destination files to source files. If a destination file is not present, then the source file is checked. // If the source file is present, then it is copied to the destination file BEFORE any further loading happens. MigrationRules map[string]string // DoNotResolvePaths indicates whether or not to resolve paths with respect to the originating files. This is phrased as a negative so // that a default object that doesn't set this will usually get the behavior it wants. DoNotResolvePaths bool }
ClientConfigLoadingRules is an ExplicitPath and string slice of specific locations that are used for merging together a Config Callers can put the chain together however they want, but we'd recommend: EnvVarPathFiles if set (a list of files if set) OR the HomeDirectoryPath ExplicitPath is special, because if a user specifically requests a certain file be used and error is reported if thie file is not present
func NewDefaultClientConfigLoadingRules ¶
func NewDefaultClientConfigLoadingRules() *ClientConfigLoadingRules
NewDefaultClientConfigLoadingRules returns a ClientConfigLoadingRules object with default fields filled in. You are not required to use this constructor
func (*ClientConfigLoadingRules) Load ¶
func (rules *ClientConfigLoadingRules) Load() (*clientcmdapi.Config, error)
Load starts by running the MigrationRules and then takes the loading rules and returns a Config object based on following rules.
if the ExplicitPath, return the unmerged explicit file Otherwise, return a merged config based on the Precedence slice
A missing ExplicitPath file produces an error. Empty filenames or other missing files are ignored. Read errors or files with non-deserializable content produce errors. The first file to set a particular map key wins and map key's value is never changed. BUT, if you set a struct value that is NOT contained inside of map, the value WILL be changed. This results in some odd looking logic to merge in one direction, merge in the other, and then merge the two. It also means that if two files specify a "red-user", only values from the first file's red-user are used. Even non-conflicting entries from the second file's "red-user" are discarded. Relative paths inside of the .kubeconfig files are resolved against the .kubeconfig file's parent folder and only absolute file paths are returned.
func (*ClientConfigLoadingRules) Migrate ¶
func (rules *ClientConfigLoadingRules) Migrate() error
Migrate uses the MigrationRules map. If a destination file is not present, then the source file is checked. If the source file is present, then it is copied to the destination file BEFORE any further loading happens.
func (ClientConfigLoadingRules) ResolvePaths ¶
func (rules ClientConfigLoadingRules) ResolvePaths() bool
type ClusterOverrideFlags ¶
type ClusterOverrideFlags struct { APIServer FlagInfo APIVersion FlagInfo CertificateAuthority FlagInfo InsecureSkipTLSVerify FlagInfo }
ClusterOverride holds the flag names to be used for binding command line flags for Cluster objects
func RecommendedClusterOverrideFlags ¶
func RecommendedClusterOverrideFlags(prefix string) ClusterOverrideFlags
RecommendedClusterOverrideFlags is a convenience method to return recommended flag names prefixed with a string of your choosing
type ConfigOverrideFlags ¶
type ConfigOverrideFlags struct { AuthOverrideFlags AuthOverrideFlags ClusterOverrideFlags ClusterOverrideFlags ContextOverrideFlags ContextOverrideFlags CurrentContext FlagInfo }
ConfigOverrideFlags holds the flag names to be used for binding command line flags. Notice that this structure tightly corresponds to ConfigOverrides
func RecommendedConfigOverrideFlags ¶
func RecommendedConfigOverrideFlags(prefix string) ConfigOverrideFlags
RecommendedConfigOverrideFlags is a convenience method to return recommended flag names prefixed with a string of your choosing
type ConfigOverrides ¶
type ConfigOverrides struct { AuthInfo clientcmdapi.AuthInfo ClusterInfo clientcmdapi.Cluster Context clientcmdapi.Context CurrentContext string }
ConfigOverrides holds values that should override whatever information is pulled from the actual Config object. You can't simply use an actual Config object, because Configs hold maps, but overrides are restricted to "at most one"
type ContextOverrideFlags ¶
ContextOverrideFlags holds the flag names to be used for binding command line flags for Cluster objects
func RecommendedContextOverrideFlags ¶
func RecommendedContextOverrideFlags(prefix string) ContextOverrideFlags
RecommendedContextOverrideFlags is a convenience method to return recommended flag names prefixed with a string of your choosing
type DeferredLoadingClientConfig ¶
type DeferredLoadingClientConfig struct {
// contains filtered or unexported fields
}
DeferredLoadingClientConfig is a ClientConfig interface that is backed by a set of loading rules It is used in cases where the loading rules may change after you've instantiated them and you want to be sure that the most recent rules are used. This is useful in cases where you bind flags to loading rule parameters before the parse happens and you want your calling code to be ignorant of how the values are being mutated to avoid passing extraneous information down a call stack
func (*DeferredLoadingClientConfig) ClientConfig ¶
func (config *DeferredLoadingClientConfig) ClientConfig() (*restclient.Config, error)
ClientConfig implements ClientConfig
func (*DeferredLoadingClientConfig) Namespace ¶
func (config *DeferredLoadingClientConfig) Namespace() (string, bool, error)
Namespace implements KubeConfig
func (*DeferredLoadingClientConfig) RawConfig ¶
func (config *DeferredLoadingClientConfig) RawConfig() (clientcmdapi.Config, error)
type DirectClientConfig ¶
type DirectClientConfig struct {
// contains filtered or unexported fields
}
DirectClientConfig is a ClientConfig interface that is backed by a clientcmdapi.Config, options overrides, and an optional fallbackReader for auth information
func (*DirectClientConfig) ClientConfig ¶
func (config *DirectClientConfig) ClientConfig() (*restclient.Config, error)
ClientConfig implements ClientConfig
func (*DirectClientConfig) ConfirmUsable ¶
func (config *DirectClientConfig) ConfirmUsable() error
ConfirmUsable looks a particular context and determines if that particular part of the config is useable. There might still be errors in the config, but no errors in the sections requested or referenced. It does not return early so that it can find as many errors as possible.
func (*DirectClientConfig) Namespace ¶
func (config *DirectClientConfig) Namespace() (string, bool, error)
Namespace implements KubeConfig
func (*DirectClientConfig) RawConfig ¶
func (config *DirectClientConfig) RawConfig() (clientcmdapi.Config, error)
type FlagInfo ¶
type FlagInfo struct { // LongName is the long string for a flag. If this is empty, then the flag will not be bound LongName string // ShortName is the single character for a flag. If this is empty, then there will be no short flag ShortName string // Default is the default value for the flag Default string // Description is the description for the flag Description string }
FlagInfo contains information about how to register a flag. This struct is useful if you want to provide a way for an extender to get back a set of recommended flag names, descriptions, and defaults, but allow for customization by an extender. This makes for coherent extension, without full prescription
func (FlagInfo) BindBoolFlag ¶
BindBoolFlag binds the flag based on the provided info. If LongName == "", nothing is registered
type PromptingAuthLoader ¶
type PromptingAuthLoader struct {
// contains filtered or unexported fields
}
func NewPromptingAuthLoader ¶
func NewPromptingAuthLoader(reader io.Reader) *PromptingAuthLoader
NewPromptingAuthLoader is an AuthLoader that parses an AuthInfo object from a file path. It prompts user and creates file if it doesn't exist.
func (*PromptingAuthLoader) LoadAuth ¶
func (a *PromptingAuthLoader) LoadAuth(path string) (*clientauth.Info, error)
LoadAuth parses an AuthInfo object from a file path. It prompts user and creates file if it doesn't exist.
func (*PromptingAuthLoader) Prompt ¶
func (a *PromptingAuthLoader) Prompt() *clientauth.Info
Prompt pulls the user and password from a reader