kubectl config set-credentials

简介

在 kubeconfig 中设置用户条目。

  • 指定已存在的属性名称将把新字段值与现有值合并。
    • 客户端证书标志：--client-certificate=certfile --client-key=keyfile
    • 持有者令牌标志：--token=bearer_token
    • 基本身份验证标志：--username=basic_user --password=basic_password
  • 持有者令牌和基本身份验证是互斥的（不可同时使用）。
kubectl config set-credentials NAME [--client-certificate=path/to/certfile] [--client-key=path/to/keyfile] [--token=bearer_token] [--username=basic_user] [--password=basic_password] [--auth-provider=provider_name] [--auth-provider-arg=key=value] [--exec-command=exec_command] [--exec-api-version=exec_api_version] [--exec-arg=arg] [--exec-env=key=value]

示例

# 仅设置 "cluster-admin" 条目上的 "client-key" 字段，不触及其他值
kubectl config set-credentials cluster-admin --client-key=~/.kube/admin.key
  
# 为 "cluster-admin" 条目设置基本身份验证
kubectl config set-credentials cluster-admin --username=admin --password=uXFGweU9l35qcif
  
# 在 "cluster-admin" 条目中嵌入客户端证书数据
kubectl config set-credentials cluster-admin --client-certificate=~/.kube/admin.crt --embed-certs=true
  
# 为 "cluster-admin" 条目启用 Google Compute Platform 身份认证提供程序
kubectl config set-credentials cluster-admin --auth-provider=gcp
  
# 使用附加参数为 "cluster-admin" 条目启用 OpenID Connect 身份认证提供程序
kubectl config set-credentials cluster-admin --auth-provider=oidc --auth-provider-arg=client-id=foo --auth-provider-arg=client-secret=bar
  
# 删除 "cluster-admin" 条目的 OpenID Connect 身份验证提供程序的 "client-secret" 配置值
kubectl config set-credentials cluster-admin --auth-provider=oidc --auth-provider-arg=client-secret-
  
# 为 "cluster-admin" 条目启用新的 exec 认证插件
kubectl config set-credentials cluster-admin --exec-command=/path/to/the/executable --exec-api-version=client.authentication.k8s.io/v1beta1
  
# 为 "cluster-admin" 条目启用新的、带交互模式的 exec 认证插件
kubectl config set-credentials cluster-admin --exec-command=/path/to/the/executable --exec-api-version=client.authentication.k8s.io/v1beta1 --exec-interactive-mode=Never
  
# 为 "cluster-admin" 条目定义新的 exec 认证插件参数
kubectl config set-credentials cluster-admin --exec-arg=arg1 --exec-arg=arg2
  
# 为 "cluster-admin" 条目创建或更新 exec 认证插件环境变量
kubectl config set-credentials cluster-admin --exec-env=key1=val1 --exec-env=key2=val2
  
# 删除 "cluster-admin" 条目的 exec 认证插件环境变量
kubectl config set-credentials cluster-admin --exec-env=var-to-remove-

选项

--auth-provider string

kubeconfig 中用户条目的身份验证提供程序。

--auth-provider-arg strings

身份验证提供程序参数，'key=value' 格式。

--client-certificate string

kubeconfig 中用户条目的客户端证书文件路径。

--client-key string

kubeconfig 中用户条目的客户端密钥文件路径。

--embed-certs tristate[=true]

在 kubeconfig 中嵌入用户条目的客户端证书/密钥。

--exec-api-version string

kubeconfig 中用户条目的 exec 凭据插件的 API 版本。

--exec-arg strings

kubeconfig 中用户条目的 exec 凭据插件命令的新参数。

--exec-command string

kubeconfig 中用户条目的 exec 凭据插件命令。

--exec-env strings

exec 凭证插件的环境变量，'key=value' 格式。。

--exec-interactive-mode string

kubeconfig 中用户条目的 exec 凭据插件的交互模式。

--exec-provide-cluster-info tristate[=true]

提供给 kubeconfig 中用户条目所使用的 exec 凭据插件的集群信息。

-h, --help

关于 set-credentials 的帮助信息。

--password string

kubeconfig 中用户条目的密码。

--token string

kubeconfig 中用户条目的 token。

--username string

kubeconfig 中用户条目的用户名。

--as string

操作所用的伪装用户名。用户可以是常规用户或命名空间中的服务账号。

--as-group strings

操作所用的伪装用户组，此标志可以被重复设置以指定多个组。

--as-uid string

操作所用的伪装 UID。

--cache-dir string     默认值："$HOME/.kube/cache"

默认缓存目录。

--certificate-authority string

证书机构的证书文件的路径。

--client-certificate string

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

--client-key string

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

--cluster string

要使用的 kubeconfig 中集群的名称。

--context string

要使用的 kubeconfig 上下文的名称。

--default-not-ready-toleration-seconds int     默认值：300

设置针对 notReady:NoExecute 的容忍度的 tolerationSeconds，默认添加到所有尚未设置此容忍度的 Pod。

--default-unreachable-toleration-seconds int     默认值：300

设置针对 unreachable:NoExecute 的容忍度的 tolerationSeconds，默认添加到所有尚未设置此容忍度的 Pod。

--disable-compression

如果为 true，则对服务器所有请求的响应不再压缩。

--insecure-skip-tls-verify

如果为 true，则不检查服务器证书的有效性。这将使你的 HTTPS 连接不安全。

--kubeconfig string

CLI 请求要使用的 kubeconfig 文件的路径。

--match-server-version

要求服务器版本与客户端版本匹配。

-n, --namespace string

如果存在，则是此 CLI 请求的命名空间范围。

--password string

对 API 服务器进行基本身份验证所用的密码。

--profile string     默认值："none"

要记录的性能分析信息。可选值为（none|cpu|heap|goroutine|threadcreate|block|mutex）。

--profile-output string     默认值："profile.pprof"

性能分析信息要写入的目标文件的名称。

--request-timeout string     默认值："0"

在放弃某个服务器请求之前等待的时长。非零值应包含相应的时间单位（例如 1s、2m、3h）。 值为零表示请求不会超时。

-s, --server string

Kubernetes API 服务器的地址和端口。

--storage-driver-buffer-duration duration     默认值：1m0s

对存储驱动的写入操作将被缓存的时长；缓存的操作会作为一个事务提交给非内存后端。

--storage-driver-db string     默认值："cadvisor"

数据库名称。

--storage-driver-host string     默认值："localhost:8086"

数据库 host:port。

--storage-driver-password string     默认值："root"

数据库密码。

--storage-driver-secure

使用与数据库的安全连接。

--storage-driver-table string     默认值："stats"

表名。

--storage-driver-user string     默认值："root"

数据库用户名。

--tls-server-name string

服务器证书验证所用的服务器名称。如果未提供，则使用与服务器通信所用的主机名。

--token string

向 API 服务器进行身份验证的持有者令牌。

--user string

要使用的 kubeconfig 用户的名称。

--username string

对 API 服务器进行基本身份验证时所用的用户名。

--version version[=true]

--version, --version=raw 打印版本信息并退出；--version=vX.Y.Z... 设置报告的版本。

--warnings-as-errors

将从服务器收到的警告视为错误，并以非零退出码退出。

另请参见

最后修改 August 22, 2024 at 12:24 PM PST: [zh] Remove --cloud-provider-gce sections from kubectl_config/* (5c67f34e47)