在 macOS 上安装和设置 kubectl

在您开始之前

您必须使用与集群相差一个次要版本之内的 kubectl 版本。例如,v1.31 客户端可以与 v1.30、v1.31 和 v1.32 控制平面通信。使用最新兼容版本的 kubectl 有助于避免不可预见的问题。

在 macOS 上安装 kubectl

以下方法可用于在 macOS 上安装 kubectl

使用 curl 在 macOS 上安装 kubectl 二进制文件

  1. 下载最新版本

    
       curl -LO "https://dl.k8s.io/release/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/darwin/amd64/kubectl"
       

    
       curl -LO "https://dl.k8s.io/release/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/darwin/arm64/kubectl"
       
  2. 验证二进制文件(可选)

    下载 kubectl 校验和文件

    
       curl -LO "https://dl.k8s.io/release/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/darwin/amd64/kubectl.sha256"
       

    
       curl -LO "https://dl.k8s.io/release/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/darwin/arm64/kubectl.sha256"
       

    根据校验和文件验证 kubectl 二进制文件

    echo "$(cat kubectl.sha256)  kubectl" | shasum -a 256 --check
    

    如果有效,则输出为

    kubectl: OK
    

    如果检查失败,shasum 将以非零状态退出并打印类似于以下内容的输出

    kubectl: FAILED
    shasum: WARNING: 1 computed checksum did NOT match
    
  3. 使 kubectl 二进制文件可执行。

    chmod +x ./kubectl
    
  4. 将 kubectl 二进制文件移动到系统 PATH 上的文件位置。

    sudo mv ./kubectl /usr/local/bin/kubectl
    sudo chown root: /usr/local/bin/kubectl
    
  5. 测试以确保您安装的版本是最新的

    kubectl version --client
    

    或使用此方法详细查看版本

    kubectl version --client --output=yaml
    
  6. 安装和验证 kubectl 后,删除校验和文件

    rm kubectl.sha256
    

在 macOS 上使用 Homebrew 安装

如果您使用 macOS 且使用 Homebrew 包管理器,您可以使用 Homebrew 安装 kubectl。

  1. 运行安装命令

    brew install kubectl
    

    brew install kubernetes-cli
    
  2. 测试以确保您安装的版本是最新的

    kubectl version --client
    

在 macOS 上使用 Macports 安装

如果您使用 macOS 且使用 Macports 包管理器,您可以使用 Macports 安装 kubectl。

  1. 运行安装命令

    sudo port selfupdate
    sudo port install kubectl
    
  2. 测试以确保您安装的版本是最新的

    kubectl version --client
    

验证 kubectl 配置

为了使 kubectl 能够找到和访问 Kubernetes 集群,它需要一个 kubeconfig 文件,该文件在您使用 kube-up.sh 创建集群或成功部署 Minikube 集群时会自动创建。默认情况下,kubectl 配置位于 ~/.kube/config

通过获取集群状态来检查 kubectl 是否已正确配置

kubectl cluster-info

如果您看到 URL 响应,则 kubectl 已正确配置以访问您的集群。

如果您看到类似于以下内容的消息,则 kubectl 配置不正确或无法连接到 Kubernetes 集群。

The connection to the server <server-name:port> was refused - did you specify the right host or port?

例如,如果您打算在笔记本电脑(本地)上运行 Kubernetes 集群,您将需要先安装像 Minikube 这样的工具,然后重新运行上述命令。

如果 kubectl cluster-info 返回 url 响应,但您无法访问您的集群,要检查它是否已正确配置,请使用

kubectl cluster-info dump

排查“未找到身份验证提供程序”错误消息

在 Kubernetes 1.26 中,kubectl 删除了对以下云提供商的托管 Kubernetes 产品的内置身份验证。这些提供商已发布了 kubectl 插件以提供特定于云的身份验证。有关说明,请参阅以下提供商文档

(也可能存在其他原因导致出现相同的错误消息,与该更改无关。)

可选 kubectl 配置和插件

启用 shell 自动完成

kubectl 为 Bash、Zsh、Fish 和 PowerShell 提供自动完成支持,这可以节省大量键入时间。

以下是为 Bash、Fish 和 Zsh 设置自动完成的步骤。

简介

可以使用 kubectl completion bash 生成 Bash 的 kubectl 完成脚本。在您的 shell 中引用此脚本可以启用 kubectl 完成。

但是,kubectl 完成脚本依赖于 bash-completion,因此您必须事先安装它。

升级 Bash

此处的说明假设您使用 Bash 4.1+。您可以通过运行以下命令来检查您的 Bash 版本

echo $BASH_VERSION

如果它太旧,您可以使用 Homebrew 安装/升级它

brew install bash

重新加载您的 shell 并验证是否正在使用所需版本

echo $BASH_VERSION $SHELL

Homebrew 通常将其安装在 /usr/local/bin/bash

安装 bash-completion

您可以使用 type _init_completion 测试是否已安装 bash-completion v2。如果没有,您可以使用 Homebrew 安装它

brew install bash-completion@2

如该命令的输出中所述,请将以下内容添加到您的 ~/.bash_profile 文件中

brew_etc="$(brew --prefix)/etc" && [[ -r "${brew_etc}/profile.d/bash_completion.sh" ]] && . "${brew_etc}/profile.d/bash_completion.sh"

重新加载您的 shell 并使用 type _init_completion 验证 bash-completion v2 是否已正确安装。

启用 kubectl 自动完成

现在您必须确保 kubectl 完成脚本在您所有 shell 会话中都被引用。有几种方法可以实现这一点

  • 在您的 ~/.bash_profile 文件中引用完成脚本

    echo 'source <(kubectl completion bash)' >>~/.bash_profile
    
  • 将完成脚本添加到 /usr/local/etc/bash_completion.d 目录

    kubectl completion bash >/usr/local/etc/bash_completion.d/kubectl
    
  • 如果您有 kubectl 的别名,您可以扩展 shell 完成以使用该别名

    echo 'alias k=kubectl' >>~/.bash_profile
    echo 'complete -o default -F __start_kubectl k' >>~/.bash_profile
    
  • 如果您使用 Homebrew 安装了 kubectl(如 此处 所述),则 kubectl 完成脚本应该已经在 /usr/local/etc/bash_completion.d/kubectl 中。在这种情况下,您无需执行任何操作。

无论如何,重新加载您的 shell 后,kubectl 完成应该可以工作。

可以使用命令 kubectl completion fish 生成 Fish 的 kubectl 完成脚本。在您的 shell 中引用此完成脚本可以启用 kubectl 自动完成。

要在您所有 shell 会话中执行此操作,请将以下行添加到您的 ~/.config/fish/config.fish 文件中

kubectl completion fish | source

重新加载您的 shell 后,kubectl 自动完成应该可以工作。

可以使用命令 kubectl completion zsh 生成 Zsh 的 kubectl 完成脚本。在您的 shell 中引用此完成脚本可以启用 kubectl 自动完成。

要在您所有 shell 会话中执行此操作,请将以下内容添加到您的 ~/.zshrc 文件中

source <(kubectl completion zsh)

如果您有 kubectl 的别名,kubectl 自动完成将自动使用它。

重新加载您的 shell 后,kubectl 自动完成应该可以工作。

如果您遇到类似于 2: command not found: compdef 的错误,请将以下内容添加到您的 ~/.zshrc 文件的开头

autoload -Uz compinit
compinit

安装 kubectl convert 插件

Kubernetes 命令行工具 kubectl 的插件,允许您在不同 API 版本之间转换清单。这在将清单迁移到较新 Kubernetes 版本的非弃用 API 版本时特别有用。有关更多信息,请访问 迁移到非弃用 API

  1. 使用以下命令下载最新版本

    
       curl -LO "https://dl.k8s.io/release/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/darwin/amd64/kubectl-convert"
       

    
       curl -LO "https://dl.k8s.io/release/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/darwin/arm64/kubectl-convert"
       
  2. 验证二进制文件(可选)

    下载 kubectl-convert 校验和文件

    
       curl -LO "https://dl.k8s.io/release/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/darwin/amd64/kubectl-convert.sha256"
       

    
       curl -LO "https://dl.k8s.io/release/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/darwin/arm64/kubectl-convert.sha256"
       

    根据校验和文件验证 kubectl-convert 二进制文件

    echo "$(cat kubectl-convert.sha256)  kubectl-convert" | shasum -a 256 --check
    

    如果有效,则输出为

    kubectl-convert: OK
    

    如果检查失败,shasum 将以非零状态退出并打印类似于以下内容的输出

    kubectl-convert: FAILED
    shasum: WARNING: 1 computed checksum did NOT match
    
  3. 使 kubectl-convert 二进制文件可执行

    chmod +x ./kubectl-convert
    
  4. 将 kubectl-convert 二进制文件移动到系统 PATH 上的文件位置。

    sudo mv ./kubectl-convert /usr/local/bin/kubectl-convert
    sudo chown root: /usr/local/bin/kubectl-convert
    
  5. 验证插件是否已成功安装

    kubectl convert --help
    

    如果您没有看到错误,则表示插件已成功安装。

  6. 安装插件后,清理安装文件

    rm kubectl-convert kubectl-convert.sha256
    

在 macOS 上卸载 kubectl

根据您安装 kubectl 的方式,请使用以下方法之一。

使用命令行卸载 kubectl

  1. 在您的系统上找到 kubectl 二进制文件

    which kubectl
    
  2. 删除 kubectl 二进制文件

    sudo rm <path>
    

    <path> 替换为上一步中 kubectl 二进制文件的路径。例如,sudo rm /usr/local/bin/kubectl

使用 homebrew 卸载 kubectl

如果您使用 Homebrew 安装了 kubectl,请运行以下命令

brew remove kubectl

下一步

上次修改时间:2023 年 12 月 3 日太平洋标准时间下午 7:17:FIx the remove step (7b2723fba7)