Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	// TODO: move SchemeBuilder with zz_generated.deepcopy.go to k8s.io/api.
	// localSchemeBuilder and AddToScheme will stay in k8s.io/kubernetes.
	SchemeBuilder runtime.SchemeBuilder

	AddToScheme = localSchemeBuilder.AddToScheme
)
View Source
var SchemeGroupVersion = schema.GroupVersion{Group: "", Version: "v1"}

    SchemeGroupVersion is group version used to register these objects TODO this should be in the "kubeconfig" group

    Functions

    This section is empty.

    Types

    type AuthInfo

    type AuthInfo struct {
    	// ClientCertificate is the path to a client cert file for TLS.
    	// +optional
    	ClientCertificate string `json:"client-certificate,omitempty"`
    	// ClientCertificateData contains PEM-encoded data from a client cert file for TLS. Overrides ClientCertificate
    	// +optional
    	ClientCertificateData []byte `json:"client-certificate-data,omitempty"`
    	// ClientKey is the path to a client key file for TLS.
    	// +optional
    	ClientKey string `json:"client-key,omitempty"`
    	// ClientKeyData contains PEM-encoded data from a client key file for TLS. Overrides ClientKey
    	// +optional
    	ClientKeyData []byte `json:"client-key-data,omitempty"`
    	// Token is the bearer token for authentication to the kubernetes cluster.
    	// +optional
    	Token string `json:"token,omitempty"`
    	// TokenFile is a pointer to a file that contains a bearer token (as described above).  If both Token and TokenFile are present, Token takes precedence.
    	// +optional
    	TokenFile string `json:"tokenFile,omitempty"`
    	// Impersonate is the username to imperonate.  The name matches the flag.
    	// +optional
    	Impersonate string `json:"as,omitempty"`
    	// ImpersonateGroups is the groups to imperonate.
    	// +optional
    	ImpersonateGroups []string `json:"as-groups,omitempty"`
    	// ImpersonateUserExtra contains additional information for impersonated user.
    	// +optional
    	ImpersonateUserExtra map[string][]string `json:"as-user-extra,omitempty"`
    	// Username is the username for basic authentication to the kubernetes cluster.
    	// +optional
    	Username string `json:"username,omitempty"`
    	// Password is the password for basic authentication to the kubernetes cluster.
    	// +optional
    	Password string `json:"password,omitempty"`
    	// AuthProvider specifies a custom authentication plugin for the kubernetes cluster.
    	// +optional
    	AuthProvider *AuthProviderConfig `json:"auth-provider,omitempty"`
    	// Exec specifies a custom exec-based authentication plugin for the kubernetes cluster.
    	// +optional
    	Exec *ExecConfig `json:"exec,omitempty"`
    	// Extensions holds additional information. This is useful for extenders so that reads and writes don't clobber unknown fields
    	// +optional
    	Extensions []NamedExtension `json:"extensions,omitempty"`
    }

      AuthInfo contains information that describes identity information. This is use to tell the kubernetes cluster who you are.

      func (*AuthInfo) DeepCopy

      func (in *AuthInfo) DeepCopy() *AuthInfo

        DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AuthInfo.

        func (*AuthInfo) DeepCopyInto

        func (in *AuthInfo) DeepCopyInto(out *AuthInfo)

          DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

          type AuthProviderConfig

          type AuthProviderConfig struct {
          	Name   string            `json:"name"`
          	Config map[string]string `json:"config"`
          }

            AuthProviderConfig holds the configuration for a specified auth provider.

            func (*AuthProviderConfig) DeepCopy

            func (in *AuthProviderConfig) DeepCopy() *AuthProviderConfig

              DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AuthProviderConfig.

              func (*AuthProviderConfig) DeepCopyInto

              func (in *AuthProviderConfig) DeepCopyInto(out *AuthProviderConfig)

                DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

                type Cluster

                type Cluster struct {
                	// Server is the address of the kubernetes cluster (https://hostname:port).
                	Server string `json:"server"`
                	// InsecureSkipTLSVerify skips the validity check for the server's certificate. This will make your HTTPS connections insecure.
                	// +optional
                	InsecureSkipTLSVerify bool `json:"insecure-skip-tls-verify,omitempty"`
                	// CertificateAuthority is the path to a cert file for the certificate authority.
                	// +optional
                	CertificateAuthority string `json:"certificate-authority,omitempty"`
                	// CertificateAuthorityData contains PEM-encoded certificate authority certificates. Overrides CertificateAuthority
                	// +optional
                	CertificateAuthorityData []byte `json:"certificate-authority-data,omitempty"`
                	// Extensions holds additional information. This is useful for extenders so that reads and writes don't clobber unknown fields
                	// +optional
                	Extensions []NamedExtension `json:"extensions,omitempty"`
                }

                  Cluster contains information about how to communicate with a kubernetes cluster

                  func (*Cluster) DeepCopy

                  func (in *Cluster) DeepCopy() *Cluster

                    DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Cluster.

                    func (*Cluster) DeepCopyInto

                    func (in *Cluster) DeepCopyInto(out *Cluster)

                      DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

                      type Config

                      type Config struct {
                      	// Legacy field from pkg/api/types.go TypeMeta.
                      	// TODO(jlowdermilk): remove this after eliminating downstream dependencies.
                      	// +optional
                      	Kind string `json:"kind,omitempty"`
                      	// Legacy field from pkg/api/types.go TypeMeta.
                      	// TODO(jlowdermilk): remove this after eliminating downstream dependencies.
                      	// +optional
                      	APIVersion string `json:"apiVersion,omitempty"`
                      	// Preferences holds general information to be use for cli interactions
                      	Preferences Preferences `json:"preferences"`
                      	// Clusters is a map of referencable names to cluster configs
                      	Clusters []NamedCluster `json:"clusters"`
                      	// AuthInfos is a map of referencable names to user configs
                      	AuthInfos []NamedAuthInfo `json:"users"`
                      	// Contexts is a map of referencable names to context configs
                      	Contexts []NamedContext `json:"contexts"`
                      	// CurrentContext is the name of the context that you would like to use by default
                      	CurrentContext string `json:"current-context"`
                      	// Extensions holds additional information. This is useful for extenders so that reads and writes don't clobber unknown fields
                      	// +optional
                      	Extensions []NamedExtension `json:"extensions,omitempty"`
                      }

                        Config holds the information needed to build connect to remote kubernetes clusters as a given user +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

                        func (*Config) DeepCopy

                        func (in *Config) DeepCopy() *Config

                          DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Config.

                          func (*Config) DeepCopyInto

                          func (in *Config) DeepCopyInto(out *Config)

                            DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

                            func (*Config) DeepCopyObject

                            func (in *Config) DeepCopyObject() runtime.Object

                              DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

                              func (*Config) GetObjectKind

                              func (obj *Config) GetObjectKind() schema.ObjectKind

                              func (*Config) GroupVersionKind

                              func (obj *Config) GroupVersionKind() schema.GroupVersionKind

                              func (*Config) SetGroupVersionKind

                              func (obj *Config) SetGroupVersionKind(gvk schema.GroupVersionKind)

                              type Context

                              type Context struct {
                              	// Cluster is the name of the cluster for this context
                              	Cluster string `json:"cluster"`
                              	// AuthInfo is the name of the authInfo for this context
                              	AuthInfo string `json:"user"`
                              	// Namespace is the default namespace to use on unspecified requests
                              	// +optional
                              	Namespace string `json:"namespace,omitempty"`
                              	// Extensions holds additional information. This is useful for extenders so that reads and writes don't clobber unknown fields
                              	// +optional
                              	Extensions []NamedExtension `json:"extensions,omitempty"`
                              }

                                Context is a tuple of references to a cluster (how do I communicate with a kubernetes cluster), a user (how do I identify myself), and a namespace (what subset of resources do I want to work with)

                                func (*Context) DeepCopy

                                func (in *Context) DeepCopy() *Context

                                  DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Context.

                                  func (*Context) DeepCopyInto

                                  func (in *Context) DeepCopyInto(out *Context)

                                    DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

                                    type ExecConfig

                                    type ExecConfig struct {
                                    	// Command to execute.
                                    	Command string `json:"command"`
                                    	// Arguments to pass to the command when executing it.
                                    	// +optional
                                    	Args []string `json:"args"`
                                    	// Env defines additional environment variables to expose to the process. These
                                    	// are unioned with the host's environment, as well as variables client-go uses
                                    	// to pass argument to the plugin.
                                    	// +optional
                                    	Env []ExecEnvVar `json:"env"`
                                    
                                    	// Preferred input version of the ExecInfo. The returned ExecCredentials MUST use
                                    	// the same encoding version as the input.
                                    	APIVersion string `json:"apiVersion,omitempty"`
                                    }

                                      ExecConfig specifies a command to provide client credentials. The command is exec'd and outputs structured stdout holding credentials.

                                      See the client.authentiction.k8s.io API group for specifications of the exact input and output format

                                      func (*ExecConfig) DeepCopy

                                      func (in *ExecConfig) DeepCopy() *ExecConfig

                                        DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ExecConfig.

                                        func (*ExecConfig) DeepCopyInto

                                        func (in *ExecConfig) DeepCopyInto(out *ExecConfig)

                                          DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

                                          type ExecEnvVar

                                          type ExecEnvVar struct {
                                          	Name  string `json:"name"`
                                          	Value string `json:"value"`
                                          }

                                            ExecEnvVar is used for setting environment variables when executing an exec-based credential plugin.

                                            func (*ExecEnvVar) DeepCopy

                                            func (in *ExecEnvVar) DeepCopy() *ExecEnvVar

                                              DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ExecEnvVar.

                                              func (*ExecEnvVar) DeepCopyInto

                                              func (in *ExecEnvVar) DeepCopyInto(out *ExecEnvVar)

                                                DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

                                                type NamedAuthInfo

                                                type NamedAuthInfo struct {
                                                	// Name is the nickname for this AuthInfo
                                                	Name string `json:"name"`
                                                	// AuthInfo holds the auth information
                                                	AuthInfo AuthInfo `json:"user"`
                                                }

                                                  NamedAuthInfo relates nicknames to auth information

                                                  func (*NamedAuthInfo) DeepCopy

                                                  func (in *NamedAuthInfo) DeepCopy() *NamedAuthInfo

                                                    DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NamedAuthInfo.

                                                    func (*NamedAuthInfo) DeepCopyInto

                                                    func (in *NamedAuthInfo) DeepCopyInto(out *NamedAuthInfo)

                                                      DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

                                                      type NamedCluster

                                                      type NamedCluster struct {
                                                      	// Name is the nickname for this Cluster
                                                      	Name string `json:"name"`
                                                      	// Cluster holds the cluster information
                                                      	Cluster Cluster `json:"cluster"`
                                                      }

                                                        NamedCluster relates nicknames to cluster information

                                                        func (*NamedCluster) DeepCopy

                                                        func (in *NamedCluster) DeepCopy() *NamedCluster

                                                          DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NamedCluster.

                                                          func (*NamedCluster) DeepCopyInto

                                                          func (in *NamedCluster) DeepCopyInto(out *NamedCluster)

                                                            DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

                                                            type NamedContext

                                                            type NamedContext struct {
                                                            	// Name is the nickname for this Context
                                                            	Name string `json:"name"`
                                                            	// Context holds the context information
                                                            	Context Context `json:"context"`
                                                            }

                                                              NamedContext relates nicknames to context information

                                                              func (*NamedContext) DeepCopy

                                                              func (in *NamedContext) DeepCopy() *NamedContext

                                                                DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NamedContext.

                                                                func (*NamedContext) DeepCopyInto

                                                                func (in *NamedContext) DeepCopyInto(out *NamedContext)

                                                                  DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

                                                                  type NamedExtension

                                                                  type NamedExtension struct {
                                                                  	// Name is the nickname for this Extension
                                                                  	Name string `json:"name"`
                                                                  	// Extension holds the extension information
                                                                  	Extension runtime.RawExtension `json:"extension"`
                                                                  }

                                                                    NamedExtension relates nicknames to extension information

                                                                    func (*NamedExtension) DeepCopy

                                                                    func (in *NamedExtension) DeepCopy() *NamedExtension

                                                                      DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NamedExtension.

                                                                      func (*NamedExtension) DeepCopyInto

                                                                      func (in *NamedExtension) DeepCopyInto(out *NamedExtension)

                                                                        DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

                                                                        type Preferences

                                                                        type Preferences struct {
                                                                        	// +optional
                                                                        	Colors bool `json:"colors,omitempty"`
                                                                        	// Extensions holds additional information. This is useful for extenders so that reads and writes don't clobber unknown fields
                                                                        	// +optional
                                                                        	Extensions []NamedExtension `json:"extensions,omitempty"`
                                                                        }

                                                                        func (*Preferences) DeepCopy

                                                                        func (in *Preferences) DeepCopy() *Preferences

                                                                          DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Preferences.

                                                                          func (*Preferences) DeepCopyInto

                                                                          func (in *Preferences) DeepCopyInto(out *Preferences)

                                                                            DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.