# kubeconfig (v1)

kubeconfig (v1)Resource TypesConfigConfigConfig holds the information needed to build connect to remote kubernetes clusters as a given userFieldDescriptionapiVersionstring/v1kindstringConfigkindstringLegacy field from pkg/api/types.go TypeMeta. TODO(jlowdermilk): remove this after eliminating downstream dependencies.apiVersionstringLegacy field from pkg/api/types.go TypeMeta. TODO(jlowdermilk): remove this after eliminating downstream dependencies.preferences [Required]PreferencesPreferences holds general information to be use for cli interactionsclusters [Required][]NamedClusterClusters is a map of referenceable names to cluster configsusers [Required][]NamedAuthInfoAuthInfos is a map of referenceable names to user configscontexts [Required][]NamedContextContexts is a map of referenceable names to context configscurrent-context [Required]stringCurrentContext is the name of the context that you would like to use by defaultextensions[]NamedExtensionExtensions holds additional information. This is useful for extenders so that reads and writes don't clobber unknown fieldsAuthInfoAppears in:NamedAuthInfoAuthInfo contains information that describes identity information. This is use to tell the kubernetes cluster who you are.FieldDescriptionclient-certificatestringClientCertificate is the path to a client cert file for TLS.client-certificate-data[]byteClientCertificateData contains PEM-encoded data from a client cert file for TLS. Overrides ClientCertificateclient-keystringClientKey is the path to a client key file for TLS.client-key-data[]byteClientKeyData contains PEM-encoded data from a client key file for TLS. Overrides ClientKeytokenstringToken is the bearer token for authentication to the kubernetes cluster.tokenFilestringTokenFile is a pointer to a file that contains a bearer token (as described above). If both Token and TokenFile are present, Token takes precedence.asstringImpersonate is the username to impersonate. The name matches the flag.as-uidstringImpersonateUID is the uid to impersonate.as-groups[]stringImpersonateGroups is the groups to impersonate.as-user-extramap[string][]stringImpersonateUserExtra contains additional information for impersonated user.usernamestringUsername is the username for basic authentication to the kubernetes cluster.passwordstringPassword is the password for basic authentication to the kubernetes cluster.auth-providerAuthProviderConfigAuthProvider specifies a custom authentication plugin for the kubernetes cluster.execExecConfigExec specifies a custom exec-based authentication plugin for the kubernetes cluster.extensions[]NamedExtensionExtensions holds additional information. This is useful for extenders so that reads and writes don't clobber unknown fieldsAuthProviderConfigAppears in:AuthInfoAuthProviderConfig holds the configuration for a specified auth provider.FieldDescriptionname [Required]stringNo description provided.config [Required]map[string]stringNo description provided.ClusterAppears in:NamedClusterCluster contains information about how to communicate with a kubernetes clusterFieldDescriptionserver [Required]stringServer is the address of the kubernetes cluster (https://hostname:port).tls-server-namestringTLSServerName is used to check server certificate. If TLSServerName is empty, the hostname used to contact the server is used.insecure-skip-tls-verifyboolInsecureSkipTLSVerify skips the validity check for the server's certificate. This will make your HTTPS connections insecure.certificate-authoritystringCertificateAuthority is the path to a cert file for the certificate authority.certificate-authority-data[]byteCertificateAuthorityData contains PEM-encoded certificate authority certificates. Overrides CertificateAuthorityproxy-urlstringProxyURL is the URL to the proxy to be used for all requests made by this client. URLs with "http", "https", and "socks5" schemes are supported. If this configuration is not provided or the empty string, the client attempts to construct a proxy configuration from http_proxy and https_proxy environment variables. If these environment variables are not set, the client does not attempt to proxy requests.socks5 proxying does not currently support spdy streaming endpoints (exec, attach, port forward).disable-compressionboolDisableCompression allows client to opt-out of response compression for all requests to the server. This is useful to speed up requests (specifically lists) when client-server network bandwidth is ample, by saving time on compression (server-side) and decompression (client-side): https://github.com/kubernetes/kubernetes/issues/112296.extensions[]NamedExtensionExtensions holds additional information. This is useful for extenders so that reads and writes don't clobber unknown fieldsContextAppears in:NamedContextContext 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)FieldDescriptioncluster [Required]stringCluster is the name of the cluster for this contextuser [Required]stringAuthInfo is the name of the authInfo for this contextnamespacestringNamespace is the default namespace to use on unspecified requestsextensions[]NamedExtensionExtensions holds additional information. This is useful for extenders so that reads and writes don't clobber unknown fieldsExecConfigAppears in:AuthInfoExecConfig specifies a command to provide client credentials. The command is exec'd and outputs structured stdout holding credentials.See the client.authentication.k8s.io API group for specifications of the exact input and output formatFieldDescriptioncommand [Required]stringCommand to execute.args[]stringArguments to pass to the command when executing it.env[]ExecEnvVarEnv 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.apiVersion [Required]stringPreferred input version of the ExecInfo. The returned ExecCredentials MUST use the same encoding version as the input.installHint [Required]stringThis text is shown to the user when the executable doesn't seem to be present. For example, brew install foo-cli might be a good InstallHint for foo-cli on Mac OS systems.provideClusterInfo [Required]boolProvideClusterInfo determines whether or not to provide cluster information, which could potentially contain very large CA data, to this exec plugin as a part of the KUBERNETES_EXEC_INFO environment variable. By default, it is set to false. Package k8s.io/client-go/tools/auth/exec provides helper methods for reading this environment variable.interactiveModeExecInteractiveModeInteractiveMode determines this plugin's relationship with standard input. Valid values are "Never" (this exec plugin never uses standard input), "IfAvailable" (this exec plugin wants to use standard input if it is available), or "Always" (this exec plugin requires standard input to function). See ExecInteractiveMode values for more details.If APIVersion is client.authentication.k8s.io/v1alpha1 or client.authentication.k8s.io/v1beta1, then this field is optional and defaults to "IfAvailable" when unset. Otherwise, this field is required.ExecEnvVarAppears in:ExecConfigExecEnvVar is used for setting environment variables when executing an exec-based credential plugin.FieldDescriptionname [Required]stringNo description provided.value [Required]stringNo description provided.ExecInteractiveMode(Alias of string)Appears in:ExecConfigExecInteractiveMode is a string that describes an exec plugin's relationship with standard input.NamedAuthInfoAppears in:ConfigNamedAuthInfo relates nicknames to auth informationFieldDescriptionname [Required]stringName is the nickname for this AuthInfouser [Required]AuthInfoAuthInfo holds the auth informationNamedClusterAppears in:ConfigNamedCluster relates nicknames to cluster informationFieldDescriptionname [Required]stringName is the nickname for this Clustercluster [Required]ClusterCluster holds the cluster informationNamedContextAppears in:ConfigNamedContext relates nicknames to context informationFieldDescriptionname [Required]stringName is the nickname for this Contextcontext [Required]ContextContext holds the context informationNamedExtensionAppears in:ConfigAuthInfoClusterContextPreferencesNamedExtension relates nicknames to extension informationFieldDescriptionname [Required]stringName is the nickname for this Extensionextension [Required]k8s.io/apimachinery/pkg/runtime.RawExtensionExtension holds the extension informationPreferencesAppears in:ConfigFieldDescriptioncolorsboolNo description provided.extensions[]NamedExtensionExtensions holds additional information. This is useful for extenders so that reads and writes don't clobber unknown fieldsThis page is automatically generated.If you plan to report an issue with this page, mention that the page is auto-generated in your issue description. The fix may need to happen elsewhere in the Kubernetes project.