Edit This Page

用插件扩展 kubectl

使用 kubectl 插件,你可以通过添加新的子命令来扩展 kubectl 命令的功能。
FEATURE STATE: Kubernetes v1.18 [stable]

本指南演示了如何为 kubectl 安装和编写扩展。 通过将核心 kubectl 命令看作与 Kubernetes 集群交互的基本构建块,集群管理员可以将插件视为一种利用这些构建块创建更复杂行为的方法。 插件用新的子命令扩展了 kubectl,允许新的和自定义的特性不包括在 kubectl 的主要发行版中。

准备开始

您需要安装一个工作的二进制 kubectl

说明:

插件在 v1.8.0 版本中正式作为 alpha 特性引入。它们已经在 v1.12.0 版本中工作,以支持更广泛的用例。因此,虽然在以前的版本中已经提供了部分插件特性,但如果您遵循这些文档,建议使用 1.12.0 或更高版本的 kubectl

安装 kubectl 插件

插件只不过是一个独立的可执行文件,名称以 kubectl- 开头。要安装插件,只需将此可执行文件移动到路径上的任何位置。

说明:

Kubernetes 不提供包管理器或任何类似于安装或更新插件的东西。你有责任确保插件可执行文件的文件名以 kubectl- 开头,并将它们放在你路径的某个位置。

发现插件

kubectl 提供一个命令 kubectl plugin list,用于搜索路径查找有效的插件可执行文件。 执行此命令将遍历路径中的所有文件。任何以 kubectl- 开头的可执行文件都将在这个命令的输出中以它们在路径中出现的顺序显示。 任何以 kubectl- 开头的文件如果不可执行,都将包含一个警告。 对于任何相同的有效插件文件,都将包含一个警告。

限制

目前无法创建覆盖现有 kubectl 命令的插件,例如,创建一个插件 kubectl-version 将导致该插件永远不会被执行,因为现有的 kubectl-version 命令总是优先于它执行。 由于这个限制,也不可能使用插件将新的子命令添加到现有的 kubectl 命令中。例如,通过将插件命名为 kubectl-create-foo 来添加子命令 kubectl create foo 将导致该插件被忽略。对于任何试图这样做的有效插件 kubectl plugin list 的输出中将显示警告。

编写 kubectl 插件

你可以用任何编程语言或脚本编写插件,允许您编写命令行命令。

不需要安装插件或预加载,插件可执行程序从 kubectl 二进制文件接收继承的环境,插件根据其名称确定它希望实现的命令路径。 例如,一个插件想要提供一个新的命令 kubectl foo,它将被简单地命名为 kubectl-foo,并且位于用户路径的某个位置。

示例插件

#!/bin/bash

# optional argument handling
if [[ "$1" == "version" ]]
then
    echo "1.0.0"
    exit 0
fi

# optional argument handling
if [[ "$1" == "config" ]]
then
    echo $KUBECONFIG
    exit 0
fi

echo "I am a plugin named kubectl-foo"

使用插件

要使用上面的插件,只需使其可执行:

sudo chmod +x ./kubectl-foo

并将它放在你的路径中的任何地方:

sudo mv ./kubectl-foo /usr/local/bin

你现在可以调用你的插件作为 kubectl 命令:

kubectl foo
I am a plugin named kubectl-foo

所有参数和标记按原样传递给可执行文件:

kubectl foo version
1.0.0

所有环境变量也按原样传递给可执行文件:

export KUBECONFIG=~/.kube/config
kubectl foo config
/home/<user>/.kube/config
KUBECONFIG=/etc/kube/config kubectl foo config
/etc/kube/config

此外,传递给插件的第一个参数总是调用它的位置的绝对路径(在上面的例子中,$0 将等于 /usr/local/bin/kubectl-foo)。

命名插件

如上面的例子所示,插件根据文件名确定要实现的命令路径,插件所针对的命令路径中的每个子命令都由破折号(-)分隔。 例如,当用户调用命令 kubectl foo bar baz 时,希望调用该命令的插件的文件名为 kubectl-foo-bar-baz

参数和标记处理

说明:

与以前版本的 kubectl 不同,插件机制不会为插件进程创建任何定制的、特定于插件的值或环境变量,这意味着像 KUBECTL_PLUGINS_CURRENT_NAMESPACE 这样的环境变量不再提供给插件。 插件必须解析用户传递给它们的所有参数,并将参数验证作为它们自己实现的一部分处理。对于用 Go 编写的插件,在 k8s.io/cli-runtime 下提供了一组实用程序来帮助实现这一点。

从上面的场景中使用我们的 kubectl-foo-bar-baz 插件,我们将进一步研究用户在提供额外标记和参数的同时调用我们的插件的其他情况。 例如,在用户调用命令 kubectl foo bar baz arg1 --flag=value arg2 的情况下,插件机制将首先尝试找到名称可能最长的插件,在本例中是 kubectl-foo-bar-baz-arg1。 当没有找到这个插件时,它就会将最后一个以破折号分隔的值视为参数(在本例中为 arg1),并尝试找到下一个最长的名称 kubectl-foo-bar-baz。 在找到具有此名称的插件后,它将调用该插件,并在其名称之后将所有参数和标志传递给插件可执行文件。

示例:

# create a plugin
echo -e '#!/bin/bash\n\necho "My first command-line argument was $1"' > kubectl-foo-bar-baz
sudo chmod +x ./kubectl-foo-bar-baz

# "install" our plugin by placing it on our PATH
sudo mv ./kubectl-foo-bar-baz /usr/local/bin

# ensure our plugin is recognized by kubectl
kubectl plugin list
The following kubectl-compatible plugins are available:

/usr/local/bin/kubectl-foo-bar-baz
# test that calling our plugin via a "kubectl" command works
# even when additional arguments and flags are passed to our
# plugin executable by the user.
kubectl foo bar baz arg1 --meaningless-flag=true
My first command-line argument was arg1

正如你所看到的,我们的插件是基于用户指定的 kubectl 命令找到的,所有额外的参数和标记都是按原样传递给插件可执行文件的。

带有破折号和下划线的名称

虽然 kubectl 插件机制在插件文件名中使用破折号(-)分隔插件处理的子命令序列,但是仍然可以通过在文件名中使用下划线(-)来创建命令行中包含破折号的插件命令。

例子:

# create a plugin containing an underscore in its filename
echo -e '#!/bin/bash\n\necho "I am a plugin with a dash in my name"' > ./kubectl-foo_bar
sudo chmod +x ./kubectl-foo_bar

# move the plugin into your PATH
sudo mv ./kubectl-foo_bar /usr/local/bin

# our plugin can now be invoked from `kubectl` like so:
kubectl foo-bar
I am a plugin with a dash in my name

请注意,在插件文件名中引入下划线并不会阻止我们使用 kubectl foo_bar 之类的命令。可以使用破折号(-)或下划线(-)调用上面示例中的命令:

# our plugin can be invoked with a dash
kubectl foo-bar
I am a plugin with a dash in my name
# it can also be invoked using an underscore
kubectl foo_bar
I am a plugin with a dash in my name

命名冲突和弊端

可以在路径的不同位置使用多个文件名相同的插件, 例如,给定一个路径的值为: PATH=/usr/local/bin/plugins:/usr/local/bin/moreplugins,在 /usr/local/bin/plugins/usr/local/bin/moreplugins 中可以存在一个插件 kubectl-foo 的副本,这样 kubectl plugin list 命令的输出就是:

PATH=/usr/local/bin/plugins:/usr/local/bin/moreplugins kubectl plugin list
The following kubectl-compatible plugins are available:

/usr/local/bin/plugins/kubectl-foo
/usr/local/bin/moreplugins/kubectl-foo
  - warning: /usr/local/bin/moreplugins/kubectl-foo is overshadowed by a similarly named plugin: /usr/local/bin/plugins/kubectl-foo

error: one plugin warning was found

在上面的场景中 /usr/local/bin/moreplugins/kubectl-foo 下的警告告诉我们这个插件永远不会被执行。相反,首先出现在我们路径中的可执行文件 /usr/local/bin/plugins/kubectl-foo 总是首先被 kubectl 插件机制找到并执行。

解决这个问题的一种方法是你确保你希望与 kubectl 一起使用的插件的位置总是在你的路径中首先出现。 例如,如果我们总是想使用 /usr/local/bin/moreplugins/kubectl foo,那么在调用 kubectl 命令 kubectl foo 时,我们只需将路径的值更改为 PATH=/usr/local/bin/moreplugins:/usr/local/bin/plugins

调用最长的可执行文件名

对于插件文件名而言还有另一种弊端,给定用户路径中的两个插件 kubectl-foo-barkubectl-foo-bar-bazkubectl 插件机制总是为给定的用户命令选择尽可能长的插件名称。下面的一些例子进一步的说明了这一点:

# for a given kubectl command, the plugin with the longest possible filename will always be preferred
kubectl foo bar baz
Plugin kubectl-foo-bar-baz is executed
kubectl foo bar
Plugin kubectl-foo-bar is executed
kubectl foo bar baz buz
Plugin kubectl-foo-bar-baz is executed, with "buz" as its first argument
kubectl foo bar buz
Plugin kubectl-foo-bar is executed, with "buz" as its first argument

这种设计选择确保插件子命令可以跨多个文件实现,如果需要,这些子命令可以嵌套在"父"插件命令下:

ls ./plugin_command_tree
kubectl-parent
kubectl-parent-subcommand
kubectl-parent-subcommand-subsubcommand

检查插件警告

你可以使用前面提到的 kubectl plugin list 命令来确保你的插件可以被 kubectl 看到,并且验证没有警告防止它被称为 kubectl 命令。

kubectl plugin list
The following kubectl-compatible plugins are available:

test/fixtures/pkg/kubectl/plugins/kubectl-foo
/usr/local/bin/kubectl-foo
  - warning: /usr/local/bin/kubectl-foo is overshadowed by a similarly named plugin: test/fixtures/pkg/kubectl/plugins/kubectl-foo
plugins/kubectl-invalid
  - warning: plugins/kubectl-invalid identified as a kubectl plugin, but it is not executable

error: 2 plugin warnings were found

使用命令行 runtime 包

作为 v1.12.0 版本中插件机制更新的一部分,插件作者可以使用另外一组实用程序。这些实用程序在, k8s.io/cli-runtime 存储库,并且可以被编写在 Go 中的插件用来解析和更新, 用户的 KUBECONFIG 文件,获取 REST 客户端与 API 服务器通信,并自动绑定与配置和打印相关的参数。

插件必须用 Go 编写才能被 kubectl 识别为有效的插件,但是它们必须使用 Go 才能使用的 CLI Runtime 存储库中的工具和实用程序。

参见 CLI 插件示例了解 CLI Runtime 存储库中提供的工具的使用示例。

接下来

  • 查看 CLI 插件库示例,查看用 Go 编写的插件的详细示例
  • 如有任何问题,请随时联系 CLI SIG 小组
  • 二进制插件是 beta 版的特性,所以现在是时候为代码库贡献一些想法和改进了。我们也很高兴听到您计划用插件实现什么,所以让我们知道