插件

如何开发 minikube 插件

创建新插件

要创建插件,首先 fork minikube 仓库,然后检出你的 fork

git clone git@github.com:<username>/minikube.git

然后进入源目录

cd minikube

创建子目录

mkdir deploy/addons/<addon name>

将你的清单 YAML 文件添加到你创建的目录中

cp *.yaml deploy/addons/<addon name>

注意:如果插件不需要 GCP 认证,请考虑将以下标签添加到 Pod 的 YAML 中

gcp-auth-skip-secret: "true"

为了让插件出现在 minikube addons list 中,请将其添加到 pkg/addons/config.go。以下是 registry 插件使用的条目,它适用于任何不需要自定义代码的插件

  {
    name:      "registry",
    set:       SetBool,
    callbacks: []setFn{EnableOrDisableAddon},
  },

接下来,使用 //go:embed 指令将所有必需文件添加到 deploy/addons/assets.go 中一个新的 embed.FS 变量。以下是 csi-hostpath-driver 插件使用的条目

	// CsiHostpathDriverAssets assets for csi-hostpath-driver addon
	//go:embed csi-hostpath-driver/deploy/*.tmpl csi-hostpath-driver/rbac/*.tmpl
	CsiHostpathDriverAssets embed.FS

然后,将要复制到集群中的文件列表(包括清单)添加到 pkg/minikube/assets/addons.go 中。以下是 registry 插件使用的条目

  "registry": NewAddon([]*BinAsset{
    MustBinAsset(addons.RegistryAssets,
      "registry/registry-rc.yaml.tmpl",
      vmpath.GuestAddonsDir,
      "registry-rc.yaml",
      "0640",
      false),
    MustBinAsset(addons.RegistryAssets,
      "registry/registry-svc.yaml.tmpl",
      vmpath.GuestAddonsDir,
      "registry-svc.yaml",
      "0640",
      false),
    MustBinAsset(addons.RegistryAssets,
      "registry/registry-proxy.yaml.tmpl",
      vmpath.GuestAddonsDir,
      "registry-proxy.yaml",
      "0640",
      false),
  }, false, "registry", "google"),

MustBinAsset 参数为

  • 资产变量(通常存在于 deploy/addons/assets.go 中)
  • 源文件名
  • 目标目录(通常是 vmpath.GuestAddonsDir
  • 目标文件名
  • 权限(通常是 0640
  • 布尔值,表示是否需要模板替换(通常是 false

最后一行中的布尔值表示插件是否应默认启用。此值应始终为 false。此外,在插件名称之后是维护者字段。此字段旨在告知用户插件镜像的控制方。在上述示例中,维护者是 Google,因为 registry 插件使用的镜像是 Google 控制的。创建新插件时,在填写之前应联系镜像来源并询问他们是否愿意成为此插件的联系点。如果来源不接受此责任,则维护者字段留空也是可以接受的。

要查看其他示例,请参阅 插件提交历史 以获取其他近期示例。

“addons open” 支持

如果你的插件包含 NodePort Service,请添加 kubernetes.io/minikube-addons-endpoint: <addon name> 标签,该标签由 minikube addons open 命令使用

apiVersion: v1
kind: Service
metadata:
 labels:
    kubernetes.io/minikube-addons-endpoint: <addon name>

注意:minikube addons open 当前仅适用于 kube-system 命名空间:#8089

测试插件更改

重建 minikube 二进制文件并启用额外日志记录来应用插件

make && make test && ./out/minikube addons enable <addon name> --alsologtostderr

请注意,每次更改 YAML 文件时都必须运行 make。要在进行新更改时禁用插件,请运行

./out/minikube addons disable <addon name> --alsologtostderr

发送你的 PR

测试完插件后,点击 新建拉取请求 将你的 PR 发送给我们!


最后修改于 2021 年 8 月 5 日:添加了说明维护者字段的文档。(3c90833e5)