为 Windows Pod 和容器配置 GMSA

FEATURE STATE: Kubernetes v1.18 [stable]

本页展示如何为将运行在 Windows 节点上的 Pod 和容器配置 组管理的服务账号（Group Managed Service Accounts，GMSA）。 组管理的服务账号是活动目录（Active Directory）的一种特殊类型，提供自动化的 密码管理、简化的服务主体名称（Service Principal Name，SPN）管理以及跨多个 服务器将管理操作委派给其他管理员等能力。

在 Kubernetes 环境中，GMSA 凭据规约配置为 Kubernetes 集群范围的自定义资源 （Custom Resources）形式。Windows Pod 以及各 Pod 中的每个容器可以配置为 使用 GMSA 来完成基于域（Domain）的操作（例如，Kerberos 身份认证），以便 与其他 Windows 服务相交互。自 Kubernetes 1.16 版本起，Docker 运行时为 Windows 负载支持 GMSA。

准备开始

你需要一个 Kubernetes 集群，以及 kubectl 命令行工具，且工具必须已配置 为能够与你的集群通信。集群预期包含 Windows 工作节点。 本节讨论需要为每个集群执行一次的初始操作。

安装 GMSACredentialSpec CRD

你需要在集群上配置一个用于 GMSA 凭据规约资源的 CustomResourceDefinition(CRD)， 以便定义类型为 GMSACredentialSpec 的自定义资源。 首先下载 GMSA CRD YAML 并将其保存为 gmsa-crd.yaml。接下来执行 kubectl apply -f gmsa-crd.yaml 安装 CRD。

安装 Webhook 来验证 GMSA 用户

你需要为 Kubernetes 集群配置两个 Webhook，在 Pod 或容器级别填充和检查 GMSA 凭据规约引用。

  1. 一个修改模式（Mutating）的 Webhook，将对 GMSA 的引用（在 Pod 规约中体现为名字） 展开为完整凭据规约的 JSON 形式，并保存回 Pod 规约中。

  2. 一个验证模式（Validating）的 Webhook，确保对 GMSA 的所有引用都是已经授权 给 Pod 的服务账号使用的。

安装以上 Webhook 及其相关联的对象需要执行以下步骤：

  1. 创建一个证书密钥对（用于允许 Webhook 容器与集群通信）

  2. 安装一个包含如上证书的 Secret

  3. 创建一个包含核心 Webhook 逻辑的 Deployment

  4. 创建引用该 Deployment 的 Validating Webhook 和 Mutating Webhook 配置

你可以使用这个脚本 来部署和配置上述 GMSA Webhook 及相关联的对象。你还可以在运行脚本时设置 --dry-run=server 选项以便审查脚本将会对集群做出的变更。

脚本所使用的YAML 模板 也可用于手动部署 Webhook 及相关联的对象，不过需要对其中的参数作适当替换。

在活动目录中配置 GMSA 和 Windows 节点

在配置 Kubernetes 中的 Pod 以使用 GMSA 之前，需要按 Windows GMSA 文档 中描述的那样先在活动目录中准备好期望的 GMSA。 Windows 工作节点（作为 Kubernetes 集群的一部分）需要被配置到活动目录中，以便 访问与期望的 GSMA 相关联的秘密凭据数据。这一操作的描述位于 Windows GMSA 文档 中。

创建 GMSA 凭据规约资源

当（如前所述）安装了 GMSACredentialSpec CRD 之后，你就可以配置包含 GMSA 凭据 规约的自定义资源了。GMSA 凭据规约中并不包含秘密或敏感数据。 其中包含的信息主要用于容器运行时，便于后者向 Windows 描述容器所期望的 GMSA。 GMSA 凭据规约可以使用 PowerShell 脚本 以 YAML 格式生成。

下面是手动以 JSON 格式生成 GMSA 凭据规约并对其进行 YAML 转换的步骤：

  1. 导入 CredentialSpec 模块: ipmo CredentialSpec.psm1

  2. 使用 New-CredentialSpec 来创建一个 JSON 格式的凭据规约。 要创建名为 WebApp1 的 GMSA 凭据规约，调用 New-CredentialSpec -Name WebApp1 -AccountName WebApp1 -Domain $(Get-ADDomain -Current LocalComputer)。

  3. 使用 Get-CredentialSpec 来显示 JSON 文件的路径。

  4. 将凭据规约从 JSON 格式转换为 YAML 格式，并添加必要的头部字段 apiVersion、kind、metadata 和 credspec，使其成为一个可以在 Kubernetes 中配置的 GMSACredentialSpec 自定义资源。

下面的 YAML 配置描述的是一个名为 gmsa-WebApp1 的 GMSA 凭据规约：

  1. apiVersion: windows.k8s.io/v1alpha1
  2. kind: GMSACredentialSpec
  3. metadata:
  4.   name: gmsa-WebApp1  # 这是随意起的一个名字，将用作引用
  5. credspec:
  6.   ActiveDirectoryConfig:
  7.     GroupManagedServiceAccounts:
  8.     - Name: WebApp1   # GMSA 账号的用户名
  9.       Scope: CONTOSO  # NETBIOS 域名
  10.     - Name: WebApp1   # GMSA 账号的用户名
  11.       Scope: contoso.com # DNS 域名
  12.   CmsPlugins:
  13.   - ActiveDirectory
  14.   DomainJoinConfig:
  15.     DnsName: contoso.com  # DNS 域名
  16.     DnsTreeName: contoso.com # DNS 域名根
  17.     Guid: 244818ae-87ac-4fcd-92ec-e79e5252348a  # GUID
  18.     MachineAccountName: WebApp1 # GMSA 账号的用户名
  19.     NetBiosName: CONTOSO  # NETBIOS 域名
  20.     Sid: S-1-5-21-2126449477-2524075714-3094792973 # GMSA 的 SID

上面的凭据规约资源可以保存为 gmsa-Webapp1-credspec.yaml，之后使用 kubectl apply -f gmsa-Webapp1-credspec.yml 应用到集群上。

配置集群角色以启用对特定 GMSA 凭据规约的 RBAC

你需要为每个 GMSA 凭据规约资源定义集群角色。 该集群角色授权某主体（通常是一个服务账号）对特定的 GMSA 资源执行 use 动作。 下面的示例显示的是一个集群角色，对前文创建的凭据规约 gmsa-WebApp1 执行鉴权。 将此文件保存为 gmsa-webapp1-role.yaml 并执行 kubectl apply -f gmsa-webapp1-role.yaml。

  1. # 创建集群角色读取凭据规约
  2. apiVersion: rbac.authorization.k8s.io/v1
  3. kind: ClusterRole
  4. metadata:
  5.   name: webapp1-role
  6. rules:
  7. - apiGroups: ["windows.k8s.io"]
  8.   resources: ["gmsacredentialspecs"]
  9.   verbs: ["use"]
  10.   resourceNames: ["gmsa-WebApp1"]

将角色指派给要使用特定 GMSA 凭据规约的服务账号

你需要将某个服务账号（Pod 配置所对应的那个）绑定到前文创建的集群角色上。 这一绑定操作实际上授予该服务账号使用所指定的 GMSA 凭据规约资源的访问权限。 下面显示的是一个绑定到集群角色 webapp1-role 上的 default 服务账号，使之 能够使用前面所创建的 gmsa-WebApp1 凭据规约资源。

  1. apiVersion: rbac.authorization.k8s.io/v1
  2. kind: RoleBinding
  3. metadata:
  4.   name: allow-default-svc-account-read-on-gmsa-WebApp1
  5.   namespace: default
  6. subjects:
  7. - kind: ServiceAccount
  8.   name: default
  9.   namespace: default
  10. roleRef:
  11.   kind: ClusterRole
  12.   name: webapp1-role
  13.   apiGroup: rbac.authorization.k8s.io

在 Pod 规约中配置 GMSA 凭据规约引用

Pod 规约字段 securityContext.windowsOptions.gmsaCredentialSpecName 可用来 设置对指定 GMSA 凭据规约自定义资源的引用。 设置此引用将会配置 Pod 中的所有容器使用所给的 GMSA。 下面是一个 Pod 规约示例，其中包含了对 gmsa-WebApp1 凭据规约的引用：

  1. apiVersion: apps/v1
  2. kind: Deployment
  3. metadata:
  4.   labels:
  5.     run: with-creds
  6.   name: with-creds
  7.   namespace: default
  8. spec:
  9.   replicas: 1
  10.   selector:
  11.     matchLabels:
  12.       run: with-creds
  13.   template:
  14.     metadata:
  15.       labels:
  16.         run: with-creds
  17.     spec:
  18.       securityContext:
  19.         windowsOptions:
  20.           gmsaCredentialSpecName: gmsa-webapp1
  21.       containers:
  22.       - image: mcr.microsoft.com/windows/servercore/iis:windowsservercore-ltsc2019
  23.         imagePullPolicy: Always
  24.         name: iis
  25.       nodeSelector:
  26.         kubernetes.io/os: windows

Pod 中的各个容器也可以使用对应容器的 securityContext.windowsOptions.gmsaCredentialSpecName 字段来设置期望使用的 GMSA 凭据规约。 例如：

  1. apiVersion: apps/v1
  2. kind: Deployment
  3. metadata:
  4.   labels:
  5.     run: with-creds
  6.   name: with-creds
  7.   namespace: default
  8. spec:
  9.   replicas: 1
  10.   selector:
  11.     matchLabels:
  12.       run: with-creds
  13.   template:
  14.     metadata:
  15.       labels:
  16.         run: with-creds
  17.     spec:
  18.       containers:
  19.       - image: mcr.microsoft.com/windows/servercore/iis:windowsservercore-ltsc2019
  20.         imagePullPolicy: Always
  21.         name: iis
  22.         securityContext:
  23.           windowsOptions:
  24.             gmsaCredentialSpecName: gmsa-Webapp1
  25.       nodeSelector:
  26.         kubernetes.io/os: windows

当 Pod 规约中填充了 GMSA 相关字段（如上所述），在集群中应用 Pod 规约时会依次 发生以下事件：

  1. Mutating Webhook 解析对 GMSA 凭据规约资源的引用，并将其全部展开， 得到 GMSA 凭据规约的实际内容。

  2. Validating Webhook 确保与 Pod 相关联的服务账号有权在所给的 GMSA 凭据规约 上执行 use 动作。

  3. 容器运行时为每个 Windows 容器配置所指定的 GMSA 凭据规约，这样容器就可以以 活动目录中该 GMSA 所代表的身份来执行操作，使用该身份来访问域中的服务。

故障排查

如果在你的环境中配置 GMSA 时遇到了困难，你可以采取若干步骤来排查可能 的故障。

首先，确保凭据规约已经被传递到 Pod。要实现这点，你需要先通过 exec 进入到 你的 Pod 之一，检查 nltest.exe /parentdomain 命令的输出。 在下面的例子中，Pod 未能正确地获得凭据规约：

  1. kubectl exec -it iis-auth-7776966999-n5nzr powershell.exe
  3. Windows PowerShell
  4. Copyright (C) Microsoft Corporation. All rights reserved.
  6. PS C:\> nltest.exe /parentdomain
  7. Getting parent domain failed: Status = 1722 0x6ba RPC_S_SERVER_UNAVAILABLE
  8. PS C:\>

如果 Pod 未能正确获得凭据规约，则下一步就要检查与域之间的通信。 首先，从 Pod 内部快速执行一个 nslookup 操作，找到域根。

这一操作会告诉我们三件事情：

  1. Pod 能否访问域控制器（DC）
  2. DC 能否访问 Pod
  3. DNS 是否正常工作

如果 DNS 和通信测试通过，接下来你需要检查是否 Pod 已经与域之间建立了 安全通信通道。要执行这一检查，你需要再次通过 exec 进入到你的 Pod 中 并执行 nltest.exe /query 命令。

  1. PS C:\> nltest.exe /query
  2. I_NetLogonControl failed: Status = 1722 0x6ba RPC_S_SERVER_UNAVAILABLE

这一输出告诉我们，由于某些原因，Pod 无法使用凭据规约中的账号登录到域。 你可以通过运行 nltest.exe /sc_reset:domain.example 命令尝试修复安全通道。

  1. PS C:\> nltest /sc_reset:domain.example
  2. Flags: 30 HAS_IP  HAS_TIMESERV
  3. Trusted DC Name \\dc10.domain.example
  4. Trusted DC Connection Status Status = 0 0x0 NERR_Success
  5. The command completed successfully
  6. PS C:\>

如果上述命令修复了错误，你就可以通过向你的 Pod 规约添加生命周期回调来将此操作 自动化。如果上述命令未能奏效，你就需要再次检查凭据规约，以确保其数据时正确的 而且是完整的。

  1.         image: registry.domain.example/iis-auth:1809v1
  2.         lifecycle:
  3.           postStart:
  4.             exec:
  5.               command: ["powershell.exe","-command","do { Restart-Service -Name netlogon } while ( $($Result = (nltest.exe /query); if ($Result -like '*0x0 NERR_Success*') {return $true} else {return $false}) -eq $false)"]
  6.         imagePullPolicy: IfNotPresent

如果你向你的 Pod 规约中添加如上所示的 lifecycle 节，则 Pod 会自动执行所 列举的命令来重启 netlogon 服务，直到 nltest.exe /query 命令返回时没有错误信息。

GMSA 的局限

在使用 Windows 版本的 ContainerD 运行时 时，通过 GMSA 域身份标识访问受限制的网络共享资源时会出错。 容器会收到身份标识且 nltest.exe /query 调用也能正常工作。 当需要访问网络共享资源时，建议使用 Docker EE 运行时。 Windows Server 团队正在 Windows 内核中解决这一问题，并在将来发布解决此问题的补丁。 你可以在 Microsoft Windows Containers 问题跟踪列表 中查找这类更新。

最后修改 May 18, 2021 at 3:35 PM PST : [zh]Resync tasks files[7] (ef49d6613)