文档中心

使用 KubeCm 管理多集群 KubeConfig

最近更新时间：2023.08.10 16:12:21

首次发布时间：2023.08.10 16:12:21

通过 KubeCm 管理工作，能够方便用户在使用 kubectl 进行集群管理时，在多个集群中灵活切换。本文为您介绍如何使用 KubeCm 管理火山引擎容器服务集群。

背景

kubectl 是 Kubernetes 自带的原生命令行工具。您可以通过 kubectl 客户端连接至 Kubernetes 集群，并对集群进行创建、查看、删除等操作。

当您使用 kubectl 工具连接目标集群时，需要首先获得集群的 KubeConfig 访问凭证，并复制该凭证到本地环境中的$HOME/.kube/config文件中。

但是，如果您同时管理多个集群，就需要不停的修改$HOME/.kube/config文件的内容。如果使用手工的方式，将多个集群的 KubeConfig 文件合并，则低效且可能出错。本文为您介绍一种方便的多集群 KubeConfig 访问凭证管理方法，方便您快速切换多集群访问凭证，实现多集群 KubeConfig 的管理。

什么是 KubeCm？

KubeCm 是一个多集群 KubeConfig 访问凭证管理工具，支持展示、切换、添加、删除 KubeConfig 访问凭证到$HOME/.kube/config文件中，方便多集群管理场景。

说明

KubeCm 的详细介绍，请参见官方网站。

前提条件

环境准备

已创建 VKE 集群，详情请参见创建集群。
已在本地环境中安装 kubectl 工具。详情请参见安装和设置 kubectl。

安装 KubeCm

在本地环境中安装 KubeCm，详情请参见官方文档。

安装完成后，执行kubecm命令，如果显示如下内容，说明安装成功。

Manage your kubeconfig more easily.        
                                                   

██   ██ ██    ██ ██████  ███████  ██████ ███    ███ 
██  ██  ██    ██ ██   ██ ██      ██      ████  ████ 
█████   ██    ██ ██████  █████   ██      ██ ████ ██ 
██  ██  ██    ██ ██   ██ ██      ██      ██  ██  ██ 
██   ██  ██████  ██████  ███████  ██████ ██      ██

 Tips  Find more information at: kubecm.cloud (https://kubecm.cloud)

Usage:
  kubecm [command]

Available Commands:
  add         Add KubeConfig to $HOME/.kube/config
  alias       Generate alias for all contexts
  clear       Clear lapsed context, cluster and user
  cloud       Manage kubeconfig from cloud
  completion  Generate completion script
  create      Create new KubeConfig(experiment)
  delete      Delete the specified context from the kubeconfig
  help        Help about any command
  list        List KubeConfig
  merge       Merge multiple kubeconfig files into one
  namespace   Switch or change namespace interactively
  rename      Rename the contexts of kubeconfig
  switch      Switch Kube Context interactively
  version     Print version info

Flags:
      --config string   path of kubeconfig (default "/Users/bytedance/.kube/config")
  -h, --help            help for kubecm
  -m, --mac-notify      enable to display Mac notification banner
      --ui-size int     number of list items to show in menu at once (default 4)

Use "kubecm [command] --help" for more information about a command.

获取集群访问凭证

登录容器服务控制台。
单击左侧导航栏中的集群。
在集群列表页面，单击目标集群名称，进入集群管理页面。
在左侧导航栏中选择 基本信息，单击 连接信息 页签。
选择 外网访问 Config 页签，单击 生成 KubeConfig 设置 有效期（本示例设置有效期为365天），生成集群访问凭证。
单击，将访问凭证下载到本地。

常见操作

添加访问凭证

执行以下命令，添加访问凭证。

kubecm add -f kube.conf

说明

kube.conf为 KubeConfig 访问凭证的文件名称举例，实际操作时，您需要修改为实际的访问凭证文件名称。
执行命令前，您需要保证$HOME/.kube目录下已经存在config文件。如果不存在该文件，执行命令时会报错。
执行命令时，如果选择True，则会将访问凭证写入到$HOME/.kube/config文件中；如果选择False，则会在当前文件夹下，生成./kubecm.config文件。

如果您想要在添加集群访问凭证的同时，修改访问凭证的名称，可以增加-c参数，并使用--context-name参数来配置名称。

kubecm add -cf kube.conf --context-name demo-cluster

查看集群列表

执行以下命令，查看所有访问凭证。

kubecm list

alt

切换集群

执行以下命令，切换当前使用的访问凭证。

kubecm switch

重命名访问凭证

执行以下命令，重命名集群的访问凭证名称。

kubecm rename

移除集群

执行以下命令，移除集群的访问凭证。

kubecm delete

背景