⎈ k8s knowledge compiler

kubeconfig (v1) [page]deterministic

reference

## Resource Types

  • [Config](#Config)

## `Config` {#Config}

<p>Config holds the information needed to build connect to remote kubernetes clusters as a given user</p>

<table class="table"> <thead><tr><th width="30%">Field</th><th>Description</th></tr></thead> <tbody> <tr><td><code>apiVersion</code><br/>string</td><td><code>/v1</code></td></tr> <tr><td><code>kind</code><br/>string</td><td><code>Config</code></td></tr> <tr><td><code>kind</code><br/> <code>string</code> </td> <td> <p>Legacy field from pkg/api/types.go TypeMeta. TODO(jlowdermilk): remove this after eliminating downstream dependencies.</p> </td> </tr> <tr><td><code>apiVersion</code><br/> <code>string</code> </td> <td> <p>Legacy field from pkg/api/types.go TypeMeta. TODO(jlowdermilk): remove this after eliminating downstream dependencies.</p> </td> </tr> <tr><td><code>preferences,omitzero</code> <B>[Required]</B><br/> <a href="#Preferences"><code>Preferences</code></a> </td> <td> <p>Preferences holds general information to be use for cli interactions Deprecated: this field is deprecated in v1.34. It is not used by any of the Kubernetes components.</p> </td> </tr> <tr><td><code>clusters</code> <B>[Required]</B><br/> <a href="#NamedCluster"><code>[]NamedCluster</code></a> </td> <td> <p>Clusters is a map of referencable names to cluster configs</p> </td> </tr> <tr><td><code>users</code> <B>[Required]</B><br/> <a href="#NamedAuthInfo"><code>[]NamedAuthInfo</code></a> </td> <td> <p>AuthInfos is a map of referencable names to user configs</p> </td> </tr> <tr><td><code>contexts</code> <B>[Required]</B><br/> <a href="#NamedContext"><code>[]NamedContext</code></a> </td> <td> <p>Contexts is a map of referencable names to context configs</p> </td> </tr> <tr><td><code>current-context</code> <B>[Required]</B><br/> <code>string</code> </td> <td> <p>CurrentContext is the name of the context that you would like to use by default</p> </td> </tr> <tr><td><code>extensions</code><br/> <a href="#NamedExtension"><code>[]NamedExtension</code></a> </td> <td> <p>Extensions holds additional information. This is useful for extenders so that reads and writes don't clobber unknown fields</p> </td> </tr> </tbody> </table>

## `AuthInfo` {#AuthInfo}

Appears in:

  • [NamedAuthInfo](#NamedAuthInfo)

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

<table class="table"> <thead><tr><th width="30%">Field</th><th>Description</th></tr></thead> <tbody> <tr><td><code>client-certificate</code><br/> <code>string</code> </td> <td> <p>ClientCertificate is the path to a client cert file for TLS.</p> </td> </tr> <tr><td><code>client-certificate-data</code><br/> <code>[]byte</code> </td> <td> <p>ClientCertificateData contains PEM-encoded data from a client cert file for TLS. Overrides ClientCertificate</p> </td> </tr> <tr><td><code>client-key</code><br/> <code>string</code> </td> <td> <p>ClientKey is the path to a client key file for TLS.</p> </td> </tr> <tr><td><code>client-key-data</code><br/> <code>[]byte</code> </td> <td> <p>ClientKeyData contains PEM-encoded data from a client key file for TLS. Overrides ClientKey</p> </td> </tr> <tr><td><code>token</code><br/> <code>string</code> </td> <td> <p>Token is the bearer token for authentication to the kubernetes cluster.</p> </td> </tr> <tr><td><code>tokenFile</code><br/> <code>string</code> </td> <td> <p>TokenFile is a pointer to a file that contains a bearer token (as described above). If both Token and TokenFile are present, the TokenFile will be periodically read and the last successfully read value takes precedence over Token.</p> </td> </tr> <tr><td><code>as</code><br/> <code>string</code> </td> <td> <p>Impersonate is the username to impersonate. The name matches the flag.</p> </td> </tr> <tr><td><code>as-uid</code><br/> <code>string</code> </td> <td> <p>Imperson …(trimmed)

Sources

reference/config-api/kubeconfig.v1.md · dockubeconfig (v1)

Related (14)

part_of Resource typesdescribes conf=1
part_of `Config` {#Config}describes conf=1
part_of `AuthInfo` {#AuthInfo}describes conf=1
part_of `AuthProviderConfig` {#AuthProviderConfig}describes conf=1
part_of `Cluster` {#Cluster}describes conf=1
part_of `Context` {#Context}describes conf=1
part_of `ExecConfig` {#ExecConfig}describes conf=1
part_of `ExecEnvVar` {#ExecEnvVar}describes conf=1
part_of `NamedAuthInfo` {#NamedAuthInfo}describes conf=1
part_of `NamedCluster` {#NamedCluster}describes conf=1
part_of `NamedContext` {#NamedContext}describes conf=1
part_of `NamedExtension` {#NamedExtension}describes conf=1
part_of `Preferences` {#Preferences}describes conf=1

← all Docs