kubeconfig (v1)

资源类型

配置

Config 包含以给定用户身份建立连接到远程 Kubernetes 集群所需的必要信息

字段描述
apiVersion
string
/v1
kind
string
配置
kind
string

来自 pkg/api/types.go TypeMeta 的旧字段。 TODO(jlowdermilk):在消除下游依赖项后删除此字段。

apiVersion
string

来自 pkg/api/types.go TypeMeta 的旧字段。 TODO(jlowdermilk):在消除下游依赖项后删除此字段。

preferences [必填]
首选项

Preferences 保存用于 CLI 交互的通用信息

clusters [必填]
[]NamedCluster

Clusters 是可引用名称到集群配置的映射

users [必填]
[]NamedAuthInfo

AuthInfos 是可引用名称到用户配置的映射

contexts [必填]
[]NamedContext

Contexts 是可引用名称到上下文配置的映射

current-context [必填]
string

CurrentContext 是您希望默认使用的上下文的名称

extensions
[]NamedExtension

Extensions 保存其他信息。这对于扩展程序很有用,这样读取和写入就不会覆盖未知字段

AuthInfo

出现于

AuthInfo 包含描述身份信息的的信息。这用于告诉 Kubernetes 集群您的身份。

字段描述
client-certificate
string

ClientCertificate 是 TLS 客户端证书文件的路径。

client-certificate-data
[]byte

ClientCertificateData 包含来自 TLS 客户端证书文件的 PEM 编码数据。覆盖 ClientCertificate

client-key
string

ClientKey 是 TLS 客户端密钥文件的路径。

client-key-data
[]byte

ClientKeyData 包含来自 TLS 客户端密钥文件的 PEM 编码数据。覆盖 ClientKey

token
string

Token 是用于向 Kubernetes 集群进行身份验证的承载令牌。

tokenFile
string

TokenFile 是指向包含承载令牌(如上所述)的文件的指针。如果 Token 和 TokenFile 都存在,则 Token 优先。

as
string

Impersonate 是要模拟的用户名。该名称与标志匹配。

as-uid
string

ImpersonateUID 是要模拟的 UID。

as-groups
[]string

ImpersonateGroups 是要模拟的组。

as-user-extra
map[string][]string

ImpersonateUserExtra 包含模拟用户额外的信息。

username
string

Username 是用于向 Kubernetes 集群进行基本身份验证的用户名。

password
string

Password 是用于向 Kubernetes 集群进行基本身份验证的密码。

auth-provider
AuthProviderConfig

AuthProvider 指定 Kubernetes 集群的自定义身份验证插件。

exec
ExecConfig

Exec 指定 Kubernetes 集群的自定义基于执行的身份验证插件。

extensions
[]NamedExtension

Extensions 保存其他信息。这对于扩展程序很有用,这样读取和写入就不会覆盖未知字段

AuthProviderConfig

出现于

AuthProviderConfig 保存指定身份验证提供程序的配置。

字段描述
name [必填]
string
未提供描述。
config [必填]
map[string]string
未提供描述。

集群

出现于

Cluster 包含有关如何与 Kubernetes 集群通信的信息

字段描述
server [必填]
string

Server 是 Kubernetes 集群的地址 (https://hostname:port)。

tls-server-name
string

TLSServerName 用于检查服务器证书。如果 TLSServerName 为空,则使用用于联系服务器的主机名。

insecure-skip-tls-verify
bool

InsecureSkipTLSVerify 跳过对服务器证书的有效性检查。这将使您的 HTTPS 连接不安全。

certificate-authority
string

CertificateAuthority 是证书颁发机构的证书文件的路径。

certificate-authority-data
[]byte

CertificateAuthorityData 包含 PEM 编码的证书颁发机构证书。覆盖 CertificateAuthority

proxy-url
string

ProxyURL 是此客户端发出的所有请求将使用的代理的 URL。支持使用“http”、“https”和“socks5”方案的 URL。如果未提供此配置或为空字符串,则客户端尝试从 http_proxy 和 https_proxy 环境变量构建代理配置。如果未设置这些环境变量,则客户端不会尝试代理请求。

socks5 代理目前不支持 spdy 流式传输端点(执行、附加、端口转发)。

disable-compression
bool

DisableCompression 允许客户端选择退出对发送到服务器的所有请求的响应压缩。这在客户端-服务器网络带宽充足时(通过节省压缩(服务器端)和解压缩(客户端端)的时间)非常有用,以加快请求(特别是列表)的速度:https://github.com/kubernetes/kubernetes/issues/112296。

extensions
[]NamedExtension

Extensions 保存其他信息。这对于扩展程序很有用,这样读取和写入就不会覆盖未知字段

上下文

出现于

Context 是指向集群(如何与 Kubernetes 集群通信)、用户(如何标识自己)和命名空间(您想要处理的资源子集)的引用元组

字段描述
cluster [必填]
string

Cluster 是此上下文的集群名称

user [必填]
string

AuthInfo 是此上下文的 authInfo 的名称

namespace
string

Namespace 是在未指定请求时使用的默认命名空间

extensions
[]NamedExtension

Extensions 保存其他信息。这对于扩展程序很有用,这样读取和写入就不会覆盖未知字段

ExecConfig

出现于

ExecConfig 指定一个命令来提供客户端凭据。该命令将被执行并输出包含凭据的结构化标准输出。

有关确切的输入和输出格式规范,请参见 client.authentication.k8s.io API 组

字段描述
command [必填]
string

要执行的命令。

args
[]string

传递给命令的执行时的参数。

env
[]ExecEnvVar

Env 定义要公开给进程的附加环境变量。这些变量将与主机的环境变量合并,以及 client-go 用于将参数传递给插件的变量。

apiVersion [必填]
string

ExecInfo 的首选输入版本。返回的 ExecCredentials 必须使用与输入相同的编码版本。

installHint [必填]
string

当可执行文件似乎不存在时,此文本将显示给用户。例如,brew install foo-cli 可能是 Mac OS 系统上 foo-cli 的一个很好的 InstallHint。

provideClusterInfo [必填]
bool

ProvideClusterInfo 确定是否将可能包含非常大的 CA 数据的集群信息提供给此执行插件作为 KUBERNETES_EXEC_INFO 环境变量的一部分。默认情况下,它设置为 false。包 k8s.io/client-go/tools/auth/exec 提供用于读取此环境变量的帮助程序方法。

interactiveMode
ExecInteractiveMode

InteractiveMode 确定此插件与标准输入的关系。有效值为“Never”(此执行插件从不使用标准输入)、“IfAvailable”(如果可用,此执行插件希望使用标准输入)或“Always”(此执行插件需要标准输入才能正常工作)。有关更多详细信息,请参阅 ExecInteractiveMode 值。

如果 APIVersion 是 client.authentication.k8s.io/v1alpha1 或 client.authentication.k8s.io/v1beta1,则此字段是可选的,并且在未设置时默认为“IfAvailable”。否则,此字段是必需的。

ExecEnvVar

出现于

ExecEnvVar 用于在执行基于执行的凭据插件时设置环境变量。

字段描述
name [必填]
string
未提供描述。
value [必填]
string
未提供描述。

ExecInteractiveMode

(string 的别名)

出现于

ExecInteractiveMode 是一个字符串,描述了执行插件与标准输入的关系。

NamedAuthInfo

出现于

NamedAuthInfo 将昵称与身份验证信息相关联

字段描述
name [必填]
string

Name 是此 AuthInfo 的昵称

user [必填]
AuthInfo

AuthInfo 保存身份验证信息

NamedCluster

出现于

NamedCluster 将昵称与集群信息相关联

字段描述
name [必填]
string

Name 是此 Cluster 的昵称

cluster [必填]
集群

Cluster 保存集群信息

NamedContext

出现于

NamedContext 将昵称与上下文信息相关联

字段描述
name [必填]
string

Name 是此 Context 的昵称

context [必填]
上下文

Context 保存上下文信息

NamedExtension

出现于

NamedExtension 将昵称与扩展信息相关联

字段描述
name [必填]
string

Name 是此 Extension 的昵称

extension [必填]
k8s.io/apimachinery/pkg/runtime.RawExtension

Extension 保存扩展信息

首选项

出现于

字段描述
颜色
bool
未提供描述。
extensions
[]NamedExtension

Extensions 保存其他信息。这对于扩展程序很有用,这样读取和写入就不会覆盖未知字段

此页面是自动生成的。

如果您打算报告此页面的问题,请在您的问题描述中提到该页面是自动生成的。修复可能需要在 Kubernetes 项目的其他地方进行。

上次修改于 2023 年 12 月 25 日下午 9:44 PST:代码审查反馈 (a4b705bc4c)