kubectl completion

简介

输出指定 shell(bash、zsh、fish 或 powershell)的 shell 补全代码。 必须评估 shell 代码才能提供 kubectl 命令的交互式补全,这可以通过从 .bash_profile 中获取它来完成。

有关如何执行此操作的详细说明请参见此处:

zsh 用户注意事项:[1] zsh 补全仅支持 zsh >= 5.2 版本。

  1. kubectl completion SHELL

示例

  1. # 使用 homebrew 在 macOS 上安装 bash-completion
  2. ## 如果运行 macOS 附带的 Bash 3.2
  3. brew install bash-completion
  4. ## 或者,如果运行的是 Bash 4.1+
  5. brew install bash-completion@2
  6. ## 如果通过 homebrew 安装了 kubectl,Shell 补全应该能够立即起作用
  7. ## 如果你通过其他方式安装,则可能需要将新的补全数据添加到补全目录中
  8. kubectl completion bash > $(brew --prefix)/etc/bash_completion.d/kubectl
  9. # 在 Linux 上安装 bash 补全
  10. ## 如果 Linux 上未安装 bash-completion,请通过发行版的包管理器安装 "bash-completion" 包。
  11. ## 将 bash 的 kubectl 补全代码加载到当前 shell 中
  12. source <(kubectl completion bash)
  13. ## 将 bash 补全代码写入文件并从 .bash_profile 中引用之
  14. kubectl completion bash > ~/.kube/completion.bash.inc
  15. printf "
  16. # kubectl shell completion
  17. source '$HOME/.kube/completion.bash.inc'
  18. " >> $HOME/.bash_profile
  19. source $HOME/.bash_profile
  20. # 将 zsh[1] 的 kubectl 补全代码加载到当前 shell 中
  21. source <(kubectl completion zsh)
  22. # 将 zsh[1] 的 kubectl 补全代码设置为在启动时自动加载
  23. kubectl completion zsh > "${fpath[1]}/_kubectl"
  24. # 将 fish[2] 的 kubectl 补全代码加载到当前 shell 中
  25. kubectl completion fish | source
  26. # 要为每个会话都加载补全代码,请执行一次如下命令:
  27. kubectl completion fish > ~/.config/fish/completions/kubectl.fish
  28. # 将 powershell 的 kubectl 补全代码加载到当前 shell 中
  29. kubectl completion powershell | Out-String | Invoke-Expression
  30. # 设置 powershell 的 kubectl 补全代码在启动时运行
  31. ## 将补全代码保存到脚本并在配置文件中执行
  32. kubectl completion powershell > $HOME\.kube\completion.ps1
  33. Add-Content $PROFILE "$HOME\.kube\completion.ps1"
  34. ## 执行配置文件中的补全代码
  35. Add-Content $PROFILE "if (Get-Command kubectl -ErrorAction SilentlyContinue) {
  36. kubectl completion powershell | Out-String | Invoke-Expression
  37. }"
  38. ## 直接将补全代码添加到 $PROFILE 脚本
  39. kubectl completion powershell >> $PROFILE

选项

-h, —help

关于 completion 的帮助信息。

—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

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

另请参见

  • kubectl - kubectl 控制 Kubernetes 集群管理器