配置 kubelet 镜像凭据提供程序

配置 kubelet 的镜像凭据提供程序插件

FEATURE STATE: Kubernetes v1.20 [alpha]

从 Kubernetes v1.20 开始，kubelet 可以使用 exec 插件动态检索容器镜像注册中心的凭据。 kubelet 和 exec 插件使用 Kubernetes 版本化 API 通过标准输入输出（标准输入、标准输出和标准错误）通信。 这些插件允许 kubelet 动态请求容器注册中心的凭据，而不是将静态凭据存储在磁盘上。 例如，插件可能会与本地元数据通信，以检索 kubelet 正在拉取的镜像的短期凭据。

如果以下任一情况属实，你可能对此功能感兴趣：

  • 需要调用云提供商的 API 来检索注册中心的身份验证信息。
  • 凭据的到期时间很短，需要频繁请求新凭据。
  • 将注册中心凭据存储在磁盘或者 imagePullSecret 是不可接受的。

准备开始

  • kubelet 镜像凭证提供程序在 v1.20 版本作为 alpha 功能引入。 与其他 alpha 功能一样，当前仅当在 kubelet 启动 KubeletCredentialProviders 特性门禁才能使该功能正常工作。
  • 凭据提供程序 exec 插件的工作实现。你可以构建自己的插件或使用云提供商提供的插件。

在节点上安装插件

凭据提供程序插件是将由 kubelet 运行的可执行二进制文件。 确保插件二进制存在于你的集群的每个节点上，并存储在已知目录中。 稍后配置 kubelet 标志需要该目录。

配置 kubelet

为了使用这个特性，kubelet 需要设置以下两个标志：

  • --image-credential-provider-config —— 凭据提供程序插件配置文件的路径。
  • --image-credential-provider-bin-dir —— 凭据提供程序插件二进制文件所在目录的路径。

配置 kubelet 凭据提供程序

kubelet 会读取传入 --image-credential-provider-config 的配置文件文件， 以确定应该为哪些容器镜像调用哪些 exec 插件。 如果你正在使用基于 ECR 插件， 这里有个样例配置文件你可能最终会使用到：

  1. kind: CredentialProviderConfig
  2. apiVersion: kubelet.config.k8s.io/v1alpha1
  3. # providers 是将由 kubelet 启用的凭证提供程序插件列表。
  4. # 多个提供程序可能与单个镜像匹配，在这种情况下，来自所有提供程序的凭据将返回到 kubelet。
  5. # 如果为单个镜像调用多个提供程序，则结果会合并。
  6. # 如果提供程序返回重叠的身份验证密钥，则使用提供程序列表中较早的值。
  7. providers:
  8.   # name 是凭据提供程序的必需名称。 
  9.   # 它必须与 kubelet 看到的提供程序可执行文件的名称相匹配。
  10.   # 可执行文件必须在 kubelet 的 bin 目录中
  11.   # （由 --image-credential-provider-bin-dir 标志设置）。
  12.   - name: ecr
  13.     # matchImages 是一个必需的字符串列表，用于匹配镜像以确定是否应调用此提供程序。
  14.     # 如果其中一个字符串与 kubelet 请求的镜像相匹配，则该插件将被调用并有机会提供凭据。
  15.     # 镜像应包含注册域和 URL 路径。
  16.     #
  17.     # matchImages 中的每个条目都是一个模式，可以选择包含端口和路径。
  18.     # 通配符可以在域中使用，但不能在端口或路径中使用。
  19.     # 支持通配符作为子域（例如“*.k8s.io”或“k8s.*.io”）和顶级域（例如“k8s.*”）。
  20.     # 还支持匹配部分子域，如“app*.k8s.io”。
  21.     # 每个通配符只能匹配一个子域段，因此 *.io 不匹配 *.k8s.io。
  22.     #
  23.     # 当以下所有条件都为真时，镜像和 matchImage 之间存在匹配：
  24.     # - 两者都包含相同数量的域部分并且每个部分都匹配。
  25.     # - imageMatch 的 URL 路径必须是目标镜像 URL 路径的前缀。
  26.     # - 如果 imageMatch 包含端口，则该端口也必须在图像中匹配。
  27.     #
  28.     # matchImages 的示例值：
  29.     # - 123456789.dkr.ecr.us-east-1.amazonaws.com
  30.     # - *.azurecr.io
  31.     # - gcr.io
  32.     # - *.*.registry.io
  33.     # - registry.io:8080/path
  34.     matchImages:
  35.     - "*.dkr.ecr.*.amazonaws.com"
  36.     - "*.dkr.ecr.*.amazonaws.cn"
  37.     - "*.dkr.ecr-fips.*.amazonaws.com"
  38.     - "*.dkr.ecr.us-iso-east-1.c2s.ic.gov"
  39.     - "*.dkr.ecr.us-isob-east-1.sc2s.sgov.gov"
  40.     # defaultCacheDuration 是插件将在内存中缓存凭据的默认持续时间
  41.     # 如果插件响应中未提供缓存持续时间。此字段是必需的。
  42.     defaultCacheDuration: "12h"
  43.     # exec CredentialProviderRequest 的必需输入版本。
  44.     # 返回的 CredentialProviderResponse 必须使用与输入相同的编码版本。当前支持的值为：
  45.     # - credentialprovider.kubelet.k8s.io/v1alpha1
  46.     apiVersion: credentialprovider.kubelet.k8s.io/v1alpha1
  47.     # 执行命令时传递给命令的参数。
  48.     # +可选
  49.     args:
  50.     - get-credentials
  51.     # env 定义了额外的环境变量以暴露给进程。
  52.     # 这些与主机环境以及 client-go 用于将参数传递给插件的变量结合在一起。
  53.     # +可选
  54.     env:
  55.     - name: AWS_PROFILE
  56.       value: example_profile

providers 字段是 kubelet 使用的已启用插件列表。每个条目都有几个必填字段：

  • name：插件的名称，必须与传入--image-credential-provider-bin-dir 的目录中存在的可执行二进制文件的名称相匹配。
  • matchImages：用于匹配图像以确定是否应调用此提供程序的字符串列表。更多相关信息如下。
  • defaultCacheDuration：如果插件未指定缓存持续时间，kubelet 将在内存中缓存凭据的默认持续时间。
  • apiVersion：kubelet 和 exec 插件在通信时将使用的 api 版本。

每个凭证提供程序也可以被赋予可选的参数和环境变量。 咨询插件实现者以确定给定插件需要哪些参数和环境变量集。

配置镜像匹配

kubelet 使用每个凭证提供程序的 matchImages 字段来确定是否应该为 Pod 正在使用的给定镜像调用插件。 matchImages 中的每个条目都是一个镜像模式，可以选择包含端口和路径。 通配符可以在域中使用，但不能在端口或路径中使用。 支持通配符作为子域，如 *.k8s.io 或 k8s.*.io，以及顶级域，如 k8s.*。 还支持匹配部分子域，如 app*.k8s.io。每个通配符只能匹配一个子域段， 因此 *.io 不匹配 *.k8s.io。

当以下所有条件都为真时，镜像名称和 matchImage 条目之间存在匹配：

  • 两者都包含相同数量的域部分并且每个部分都匹配。
  • 匹配图片的 URL 路径必须是目标图片 URL 路径的前缀。
  • 如果 imageMatch 包含端口，则该端口也必须在镜像中匹配。

matchImages 模式的一些示例值：

  • 123456789.dkr.ecr.us-east-1.amazonaws.com
  • *.azurecr.io
  • gcr.io
  • *.*.registry.io
  • foo.registry.io:8080/path

最后修改 July 08, 2021 at 3:38 PM PST : [zh]translate kubelet-credential-provider.md (bb7066c46)