配置对多个集群的访问

本页面介绍了如何使用配置文件来配置对多个集群的访问。在您使用一个或多个配置文件定义了集群、用户和上下文之后，您可以使用 kubectl config use-context 命令快速切换集群。

说明

用于配置对集群的访问的文件有时被称为 kubeconfig 文件。这是对配置文件的一种通用称谓，并不意味着存在一个名为 kubeconfig 的文件。

警告

只使用来自受信任源的 kubeconfig 文件。使用特制的 kubeconfig 文件可能会导致恶意代码执行或文件泄露。如果您必须使用不受信任的 kubeconfig 文件，请首先仔细检查它，就像检查 Shell 脚本一样。

准备工作

你需要有一个 Kubernetes 集群，并且 kubectl 命令行工具已经配置为与你的集群通信。建议在至少有两个非控制平面主机节点的集群上运行本教程。如果你还没有集群，可以使用 minikube 创建一个，或者使用以下 Kubernetes 实践环境之一

要检查 kubectl 是否已安装，请运行 kubectl version --client。kubectl 的版本应与集群的 API 服务器版本在一个小版本偏差内。

定义集群、用户和上下文

假设你有两个集群，一个用于开发工作，一个用于测试工作。在 development 集群中，你的前端开发人员在名为 frontend 的命名空间中工作，存储开发人员在名为 storage 的命名空间中工作。在你的 test 集群中，开发人员在默认命名空间中工作，或者根据需要创建辅助命名空间。访问开发集群需要通过证书进行身份认证。访问测试集群需要通过用户名和密码进行身份认证。

创建一个名为 config-exercise 的目录。在 config-exercise 目录中，创建一个名为 config-demo 的文件，其内容如下：

apiVersion: v1
kind: Config
preferences: {}

clusters:
- cluster:
  name: development
- cluster:
  name: test

users:
- name: developer
- name: experimenter

contexts:
- context:
  name: dev-frontend
- context:
  name: dev-storage
- context:
  name: exp-test

配置文件描述了集群、用户和上下文。你的 config-demo 文件提供了描述两个集群、两个用户和三个上下文的框架。

进入 config-exercise 目录。输入以下命令将集群详细信息添加到配置文件中：

kubectl config --kubeconfig=config-demo set-cluster development --server=https://1.2.3.4 --certificate-authority=fake-ca-file
kubectl config --kubeconfig=config-demo set-cluster test --server=https://5.6.7.8 --insecure-skip-tls-verify

将用户详细信息添加到配置文件中

注意

将密码存储在 Kubernetes 客户端配置中存在风险。一个更好的替代方案是使用凭据插件并单独存储它们。请参阅：client-go 凭据插件。

kubectl config --kubeconfig=config-demo set-credentials developer --client-certificate=fake-cert-file --client-key=fake-key-seefile
kubectl config --kubeconfig=config-demo set-credentials experimenter --username=exp --password=some-password

说明

要删除用户，可以运行 kubectl --kubeconfig=config-demo config unset users.<name> 命令。
要删除集群，可以运行 kubectl --kubeconfig=config-demo config unset clusters.<name> 命令。
要删除上下文，可以运行 kubectl --kubeconfig=config-demo config unset contexts.<name> 命令。

将上下文详细信息添加到配置文件中

kubectl config --kubeconfig=config-demo set-context dev-frontend --cluster=development --namespace=frontend --user=developer
kubectl config --kubeconfig=config-demo set-context dev-storage --cluster=development --namespace=storage --user=developer
kubectl config --kubeconfig=config-demo set-context exp-test --cluster=test --namespace=default --user=experimenter

打开 config-demo 文件查看添加的详细信息。除了直接打开 config-demo 文件外，你还可以使用 config view 命令。

kubectl config --kubeconfig=config-demo view

输出显示了两个集群、两个用户和三个上下文

apiVersion: v1
clusters:
- cluster:
    certificate-authority: fake-ca-file
    server: https://1.2.3.4
  name: development
- cluster:
    insecure-skip-tls-verify: true
    server: https://5.6.7.8
  name: test
contexts:
- context:
    cluster: development
    namespace: frontend
    user: developer
  name: dev-frontend
- context:
    cluster: development
    namespace: storage
    user: developer
  name: dev-storage
- context:
    cluster: test
    namespace: default
    user: experimenter
  name: exp-test
current-context: ""
kind: Config
preferences: {}
users:
- name: developer
  user:
    client-certificate: fake-cert-file
    client-key: fake-key-file
- name: experimenter
  user:
    # Documentation note (this comment is NOT part of the command output).
    # Storing passwords in Kubernetes client config is risky.
    # A better alternative would be to use a credential plugin
    # and store the credentials separately.
    # See https://kubernetes.ac.cn/docs/reference/access-authn-authz/authentication/#client-go-credential-plugins
    password: some-password
    username: exp

上述的 fake-ca-file、fake-cert-file 和 fake-key-file 是证书文件路径名的占位符。你需要将这些替换为环境中实际的证书文件路径名。

有时，你可能希望在此处嵌入 Base64 编码的数据，而不是使用单独的证书文件；在这种情况下，你需要在键名后添加后缀 -data，例如 certificate-authority-data、client-certificate-data、client-key-data。

每个上下文都是一个三元组（集群、用户、命名空间）。例如，dev-frontend 上下文表示：“使用 developer 用户的凭据访问 development 集群的 frontend 命名空间”。

设置当前上下文

kubectl config --kubeconfig=config-demo use-context dev-frontend

现在，无论何时输入 kubectl 命令，该操作都将应用于 dev-frontend 上下文中列出的集群和命名空间。并且该命令将使用 dev-frontend 上下文中列出的用户的凭据。

要仅查看与当前上下文相关的配置信息，请使用 --minify 标志。

kubectl config --kubeconfig=config-demo view --minify

输出显示了与 dev-frontend 上下文相关的配置信息

apiVersion: v1
clusters:
- cluster:
    certificate-authority: fake-ca-file
    server: https://1.2.3.4
  name: development
contexts:
- context:
    cluster: development
    namespace: frontend
    user: developer
  name: dev-frontend
current-context: dev-frontend
kind: Config
preferences: {}
users:
- name: developer
  user:
    client-certificate: fake-cert-file
    client-key: fake-key-file

现在假设你想在测试集群中工作一段时间。

将当前上下文切换到 exp-test

kubectl config --kubeconfig=config-demo use-context exp-test

现在输入的任何 kubectl 命令都将应用于 test 集群的默认命名空间。并且该命令将使用 exp-test 上下文中列出的用户的凭据。

查看与新的当前上下文 exp-test 相关的配置。

kubectl config --kubeconfig=config-demo view --minify

最后，假设你想在 development 集群的 storage 命名空间中工作一段时间。

将当前上下文切换到 dev-storage

kubectl config --kubeconfig=config-demo use-context dev-storage

查看与新的当前上下文 dev-storage 相关的配置。

kubectl config --kubeconfig=config-demo view --minify

创建第二个配置文件

在 config-exercise 目录中，创建一个名为 config-demo-2 的文件，其内容如下：

apiVersion: v1
kind: Config
preferences: {}

contexts:
- context:
    cluster: development
    namespace: ramp
    user: developer
  name: dev-ramp-up

上述配置文件定义了一个名为 dev-ramp-up 的新上下文。

设置 KUBECONFIG 环境变量

检查是否存在名为 KUBECONFIG 的环境变量。如果存在，请保存 KUBECONFIG 环境变量的当前值，以便以后恢复。例如：

Linux

export KUBECONFIG_SAVED="$KUBECONFIG"

Windows PowerShell

$Env:KUBECONFIG_SAVED=$ENV:KUBECONFIG

KUBECONFIG 环境变量是一个包含配置文件路径的列表。在 Linux 和 Mac 上使用冒号分隔，在 Windows 上使用分号分隔。如果你有 KUBECONFIG 环境变量，请熟悉列表中的配置文件。

暂时将两个路径附加到你的 KUBECONFIG 环境变量中。例如：

Linux

export KUBECONFIG="${KUBECONFIG}:config-demo:config-demo-2"

Windows PowerShell

$Env:KUBECONFIG=("config-demo;config-demo-2")

在 config-exercise 目录中，输入以下命令：

kubectl config view

输出显示了从 KUBECONFIG 环境变量中列出的所有文件合并后的信息。特别注意，合并后的信息包含了来自 config-demo-2 文件的 dev-ramp-up 上下文以及来自 config-demo 文件的三个上下文。

contexts:
- context:
    cluster: development
    namespace: frontend
    user: developer
  name: dev-frontend
- context:
    cluster: development
    namespace: ramp
    user: developer
  name: dev-ramp-up
- context:
    cluster: development
    namespace: storage
    user: developer
  name: dev-storage
- context:
    cluster: test
    namespace: default
    user: experimenter
  name: exp-test

有关 kubeconfig 文件如何合并的更多信息，请参阅使用 kubeconfig 文件组织集群访问。

探索 $HOME/.kube 目录

如果你已经有一个集群，并且可以使用 kubectl 与集群交互，那么在 $HOME/.kube 目录中很可能有一个名为 config 的文件。

进入 $HOME/.kube 目录，查看其中的文件。通常会有一个名为 config 的文件。该目录中可能还有其他配置文件。简要熟悉这些文件的内容。

将 $HOME/.kube/config 附加到你的 KUBECONFIG 环境变量中

如果你有一个 $HOME/.kube/config 文件，并且它尚未列在你的 KUBECONFIG 环境变量中，请立即将其附加到 KUBECONFIG 环境变量中。例如：

Linux

export KUBECONFIG="${KUBECONFIG}:${HOME}/.kube/config"

Windows Powershell

$Env:KUBECONFIG="$Env:KUBECONFIG;$HOME\.kube\config"

查看当前列在你的 KUBECONFIG 环境变量中的所有文件合并后的配置信息。在你的 config-exercise 目录中，输入：

kubectl config view

清理

将你的 KUBECONFIG 环境变量恢复到其原始值。例如：

Linux

export KUBECONFIG="$KUBECONFIG_SAVED"

Windows PowerShell

$Env:KUBECONFIG=$ENV:KUBECONFIG_SAVED

检查 kubeconfig 所代表的主体

并非总是清楚在向集群认证后会获得哪些属性（用户名、组）。如果你同时管理多个集群，这可能更具挑战性。

有一个 kubectl 子命令可以检查你所选的 Kubernetes 客户端上下文的主体属性，例如用户名：kubectl auth whoami。

阅读API 访问客户端身份认证信息以了解更多详细信息。

下一步

最后修改于 2023 年 7 月 12 日上午 1:25 (PST): 修订文档主页 (9520b96a61)

配置对多个集群的访问

说明

警告

准备工作

定义集群、用户和上下文

注意

说明

创建第二个配置文件

设置 KUBECONFIG 环境变量

Linux

Windows PowerShell

Linux

Windows PowerShell

探索 $HOME/.kube 目录

将 $HOME/.kube/config 附加到你的 KUBECONFIG 环境变量中

Linux

Windows Powershell

清理

Linux

Windows PowerShell

检查 kubeconfig 所代表的主体

下一步

反馈