第 4 章集成第三方策略控制器

集成第三方策略，在策略模板中创建自定义注解，以指定一个或多个合规标准、控制类别和控制。

您还可以使用 policy-collection/community 中的第三方策略。

了解如何集成以下第三方策略：

4.1. 策略生成器

Policy Generator 是 Red Hat Advanced Cluster Management for Kubernetes 应用程序生命周期订阅 GitOps 工作流的一部分，它使用 Kustomize 生成 Red Hat Advanced Cluster Management 策略。策略生成器从 Kubernetes 清单 YAML 文件构建 Red Hat Advanced Cluster Management 策略，该文件通过用于配置它的 PolicyGenerator 清单 YAML 文件提供。策略生成器作为 Kustomize 生成器插件实施。有关 Kustomize 的更多信息，请阅读 Kustomize 文档。

如需更多信息，请参阅以下部分：

4.1.1. 策略生成器功能

Policy Generator 及其与 Red Hat Advanced Cluster Management 应用程序生命周期订阅 GitOps 工作流的集成简化了 Kubernetes 资源对象的分发到受管 OpenShift Container Platform 集群，并通过 Red Hat Advanced Cluster Management 策略简化 Kubernetes 集群的发布。

使用 Policy Generator 完成以下操作：

将任何 Kubernetes 清单文件转换为 Red Hat Advanced Cluster Management 配置策略，包括从 Kustomize 目录创建的清单。
在将输入 Kubernetes 清单插入到生成的 Red Hat Advanced Cluster Management 策略前对其进行补丁。
生成额外的配置策略，以便您可以通过 Red Hat Advanced Cluster Management for Kubernetes 报告 Gatekeeper 策略违反情况。
在 hub 集群上生成策略集。

4.1.2. 策略生成器配置结构

策略生成器是一个 Kustomize 生成器插件，它配置了一个 PolicyGenerator kind 和 policy.open-cluster-management.io/v1 API 版本的清单。

要使用插件，首先在 kustomization.yaml 文件中添加一个 generators 部分。查看以下示例：

generators:
  - policy-generator-config.yaml

上例中引用的 policy-generator-config.yaml 文件是一个 YAML 文件，其中包含要生成的策略的说明。简单的 PolicyGenerator 配置文件可能类似以下示例：

apiVersion: policy.open-cluster-management.io/v1
kind: PolicyGenerator
metadata:
  name: config-data-policies
policyDefaults:
  namespace: policies
  policySets: []
policies:
  - name: config-data
    manifests:
      - path: configmap.yaml

configmap.yaml 代表要包含在策略中的 Kubernetes 清单 YAML 文件。另外，您可以设置 Kustomize 目录的路径，或者设置具有多个 Kubernetes 清单 YAML 文件的目录。查看以下示例：

apiVersion: v1
kind: ConfigMap
metadata:
  name: my-config
  namespace: default
data:
  key1: value1
  key2: value2

生成的 Policy 以及生成的 Placement 和 PlacementBinding 可能类似以下示例：

apiVersion: cluster.open-cluster-management.io/v1beta1
kind: Placement
metadata:
  name: placement-config-data
  namespace: policies
spec:
  predicates:
  - requiredClusterSelector:
      labelSelector:
        matchExpressions: []
---
apiVersion: policy.open-cluster-management.io/v1
kind: PlacementBinding
metadata:
  name: binding-config-data
  namespace: policies
placementRef:
  apiGroup: cluster.open-cluster-management.io
  kind: Placement
  name: placement-config-data
subjects:
- apiGroup: policy.open-cluster-management.io
  kind: Policy
  name: config-data
---
apiVersion: policy.open-cluster-management.io/v1
kind: Policy
metadata:
  annotations:
    policy.open-cluster-management.io/categories: CM Configuration Management
    policy.open-cluster-management.io/controls: CM-2 Baseline Configuration
    policy.open-cluster-management.io/standards: NIST SP 800-53
    policy.open-cluster-management.io/description:
  name: config-data
  namespace: policies
spec:
  disabled: false
  policy-templates:
  - objectDefinition:
      apiVersion: policy.open-cluster-management.io/v1
      kind: ConfigurationPolicy
      metadata:
        name: config-data
      spec:
        object-templates:
        - complianceType: musthave
          objectDefinition:
            apiVersion: v1
            data:
              key1: value1
              key2: value2
            kind: ConfigMap
            metadata:
              name: my-config
              namespace: default
        remediationAction: inform
        severity: low

4.1.3. 策略生成器配置参考表

请注意，每个策略都可以覆盖 policyDefaults 部分中除 namespace 以外的所有字段，每个策略集都可以覆盖 policySetDefaults 部分中的所有字段。

表 4.1. 参数表
字段	可选或必需的	描述
`apiVersion`	必填	将值设置为 `policy.open-cluster-management.io/v1`。
`kind`	必填	将值设为 `PolicyGenerator` 以表示策略类型。
`metadata.name`	必填	用于标识策略资源的名称。
`placementBindingDefaults.name`	选填	如果多个策略使用相同的放置，则使用此名称为生成的 `PlacementBinding` 生成唯一名称，将放置与引用它的策略数组绑定。
`policyDefaults`	必填	对于 policies 数组中的条目，这里列出的任何默认值都会被覆盖，但 `namespace` 除外。
`policyDefaults.namespace`	必填	所有策略的命名空间。
`policyDefaults.complianceType`	选填	决定在将清单与集群上对象进行比较时的策略控制器行为。您可以使用的值是 `musthave`、`musthave` 或 `mustnothave`。默认值为 `musthave`。
`policyDefaults.metadataComplianceType`	选填	在将清单元数据部分与集群中的对象进行比较时，会覆盖 `complianceType`。您可以使用的值是 `musthave` 和 `mustonlyhave`。默认值为空 (`{}`)，以避免覆盖元数据的 `complianceType`。
`policyDefaults.categories`	选填	`policy.open-cluster-management.io/categories` 注解中使用的类别数组。默认值为 `CM 配置管理`。
`policyDefaults.controls`	选填	`policy.open-cluster-management.io/controls` 注解中使用的控制数组。默认值为 `CM-2 Baseline Configuration`。
`policyDefaults.standards`	选填	`policy.open-cluster-management.io/standards` 注解中使用的一组标准。默认值为 `NIST SP 800-53`。
`policyDefaults.policyAnnotations`	选填	策略在 `metadata.annotations` 部分中包含的注解。除非在策略中指定的，否则会适用于所有策略。默认值为空 (`{}`)。
`policyDefaults.configurationPolicyAnnotations`	选填	用于对生成的配置策略设置的注解的键值对。例如，您可以通过定义以下参数来禁用策略模板： `{"policy.open-cluster-management.io/disable-templates": "true"}`。默认值为空 (`{}`)。
`policyDefaults.copyPolicyMetadata`	选填	复制所有策略的标签和注解，并将它们添加到副本策略中。默认设置为 `true`。如果设置为 `false`，则只有策略框架特定的策略标签和注解复制到复制策略中。
`policyDefaults.severity`	选填	策略违反的严重性。默认值为 `low`。
`policyDefaults.disabled`	选填	策略是否被禁用，代表不会传播它，因此结果为没有状态。默认值为 `false`，这会启用策略。
`policyDefaults.remediationAction`	选填	策略的补救机制。参数值是 `enforce` 和 `inform`。默认值是 `inform`。
`policyDefaults.namespaceSelector`	没有指定命名空间的命名空间对象是必需的	决定对象要应用到的受管集群中的命名空间。`include` 和 `exclude` 参数接受根据名称包含和排除命名空间的文件路径表达式。`matchExpressions` 和 `matchLabels` 参数指定要包含的命名空间。请参阅 Kubernetes 标签和选择器文档。生成的列表通过使用来自所有参数的结果的交集进行编译。
`policyDefaults.evaluationInterval`	选填	使用 `compliant` 和 `noncompliant` 参数指定特定合规状态时要评估的策略的频率。当受管集群具有较低的 CPU 资源时，可以增加评估间隔，以减少 Kubernetes API 上的 CPU 使用量。这是持续时间的格式。例如，`"1h25m3s"` 代表 1 小时，25 分钟和 3 秒。它们也可以设置为 "never"，以避免在策略成为特定合规状态后评估策略。
`policyDefaults.pruneObjectBehavior`	选填	决定在删除策略时是否应删除由策略创建或监控的对象。只有策略的补救操作被设置为 `enforce` 时才会进行修剪。示例值为 `DeleteIfCreated`、`DeleteAll` 或 `None`。默认值为 `None`。
`policyDefaults.recordDiff`	选填	指定在策略中记录对象与 `objectDefinition` 之间的区别。设置为 `Log` 以记录控制器日志中的区别或 `None` 来记录区别。默认情况下，此参数为空，不记录区别。
`policyDefaults.dependencies`	选填	应用此策略前必须处于特定合规性状态的对象列表。当 `policyDefaults.orderPolicies` 设置为 `true` 时，无法指定。
`policyDefaults.dependencies[].name`	必填	要依赖的对象名称。
`policyDefaults.dependencies[].namespace`	选填	要依赖的对象的命名空间。默认为 Policy Generator 设置的策略命名空间。
`policyDefaults.dependencies[].compliance`	选填	对象需要处于的合规性状态。默认值为 `Compliant`。
`policyDefaults.dependencies[].kind`	选填	对象的种类。默认情况下，kind 设置为 `Policy`，但也可以是具有合规状态的其他类型，如 `ConfigurationPolicy`。
`policyDefaults.dependencies[].apiVersion`	选填	对象的 API 版本。默认值为 `policy.open-cluster-management.io/v1`。
`policyDefaults.description`	选填	您要创建的策略的描述。
`policyDefaults.extraDependencies`	选填	应用此策略前必须处于特定合规性状态的对象列表。您定义的依赖项会独立于 `dependencies` 列表添加到每个策略模板中（如 `ConfigurationPolicy`）。当 `policyDefaults.orderManifests` 被设置为 `true` 时，无法指定。
`policyDefaults.extraDependencies[].name`	必填	要依赖的对象名称。
`policyDefaults.extraDependencies[].namespace`	选填	要依赖的对象的命名空间。默认情况下，值设为为 Policy Generator 设置的策略命名空间。
`policyDefaults.extraDependencies[].compliance`	选填	对象需要处于的合规性状态。默认值为 `Compliant`。
`policyDefaults.extraDependencies[].kind`	选填	对象的种类。默认值为 `Policy`，但也可以是具有合规状态的其他类型，如 `ConfigurationPolicy`。
`policyDefaults.extraDependencies[].apiVersion`	选填	对象的 API 版本。默认值为 `policy.open-cluster-management.io/v1`。
`policyDefaults.ignorePending`	选填	当 Policy Generator 等待其依赖项达到其所需状态时，绕过合规性状态检查。默认值为 `false`。
`policyDefaults.orderPolicies`	选填	自动生成有关策略的`依赖项`，以便它们按照您在策略列表中定义的顺序应用。默认情况下，值设为 `false`。无法与 `policyDefaults.dependencies` 同时指定。
`policyDefaults.orderManifests`	选填	在策略模板上自动生成 `extraDependencies`，以便它们按照您在该策略的清单列表中定义的顺序应用。当 `policyDefaults.consolidateManifests` 被设置为 `true` 时，无法指定。无法与 `policyDefaults.extraDependencies` 同时指定。
`policyDefaults.consolidateManifests`	选填	这决定了是否为策略中包含的所有清单生成单一配置策略。如果设置为 `false`，则为每个清单生成配置策略。默认值为 `true`。
`policyDefaults.informGatekeeperPolicies` （已弃用）	选填	将 `informGatekeeperPolicies` 设置为 false 以直接使用 Gatekeeper 清单，而无需在配置策略中定义。当策略引用违反 gatekeeper 策略清单时，这决定了是否应生成额外的配置策略以便在 Red Hat Advanced Cluster Management 中接收策略违反情况。默认值为 `true`。
`policyDefaults.informKyvernoPolicies`	选填	当策略引用 Kyverno 策略清单时，这决定了在 Kyverno 策略被违反时，是否生成额外的配置策略来接收 Red Hat Advanced Cluster Management 中的策略违反情况。默认值为 `true`。
`policyDefaults.policyLabels`	选填	策略在 `metadata.labels` 部分中包含的标签。`policyLabels` 参数适用于所有策略，除非在策略中指定。
`policyDefaults.policySets`	选填	策略加入的策略集合的数组。策略设置详情可在 `policySets` 部分中定义。当一个策略是策略集的一部分时，对这个策略的放置绑定没有保证，因为会为集合生成一个。设置 `policies[].generatePlacementWhenInSet` 或 `policyDefaults.generatePlacementWhenInSet` 来覆盖 `policyDefaults.policySets`。
`policyDefaults.generatePolicyPlacement`	选填	为策略生成放置清单。默认设置为 `true`。当设置为 `false` 时，会跳过放置清单生成，即使指定了放置也是如此。
`policyDefaults.generatePlacementWhenInSet`	选填	当一个策略是策略集的一部分时，默认情况下，生成器不会为这个策略生成放置，因为会为策略集生成一个。将 `generatePlacementWhenInSet` 设置为 `true`，以使用策略放置和策略设置放置部署策略。默认值为 `false`。
`policyDefaults.placement`	选填	策略的放置配置。这默认为与所有集群匹配的放置配置。
`policyDefaults.placement.name`	选填	指定一个名称来整合包含相同集群标签选择器的放置。
`policyDefaults.placement.labelSelector`	选填	使用 `key:value` 定义集群标签选择器，或为 `matchExpressions`、`matchLabels` 或两者都提供适当的值来指定放置。请参阅 `placementPath` 指定现有文件。
`policyDefaults.placement.placementName`	选填	定义此参数以使用集群中已存在的放置。没有创建 `Placement`，而是一个 `PlacementBinding` 将策略绑定到这个 `Placement`。
`policyDefaults.placement.placementPath`	选填	要重复使用现有放置，请指定相对于 `kustomization.yaml` 文件的位置的路径。如果提供，则默认所有策略使用此放置。请参阅 `labelSelector` 以生成新的 `Placement`。
`policyDefaults.placement.clusterSelector` (Deprecated)	选填	`PlacementRule` 已被弃用。使用 `labelSelector` 来生成放置。使用 `key:value` 或提供 `matchExpressions`、`matchLabels` 或使用适当的值来定义集群选择器来指定放置规则。请参阅 `placementRulePath` 以指定现有文件。
`policyDefaults.placement.placementRuleName` (Deprecated)	选填	`PlacementRule` 已被弃用。或者，使用 `placementName` 指定放置。要使用集群中的现有放置规则，请指定此参数的名称。`PlacementRule` 不会被创建，但 `PlacementBinding` 将策略绑定到现有的 `PlacementRule`。
`policyDefaults.placement.placementRulePath` (Deprecated)	选填	`PlacementRule` 已被弃用。或者，使用 `placementPath` 指定放置。要重复使用现有放置规则，请指定相对于 `kustomization.yaml` 文件的位置的路径。如果提供，则默认所有策略都使用此放置规则。请参阅 `clusterSelector` 以生成新的 `PlacementRule`。
`policySetDefaults`	选填	策略设置的默认值。为此参数列出的任何默认值都会被 `policySets` 数组中的条目覆盖。
`policySetDefaults.placement`	选填	策略的放置配置。这默认为与所有集群匹配的放置配置。有关此字段的描述，请参阅 `policyDefaults.placement`。
`policySetDefaults.generatePolicySetPlacement`	选填	为策略集合生成放置清单。默认设置为 `true`。当设置为 `false` 时，会跳过放置清单生成，即使指定了放置也是如此。
`policies`	必填	要创建的策略列表以及覆盖默认值或 `policyDefaults` 中设置的值。如需了解更多字段和描述，请参阅 `policyDefaults`。
`policies.description`	选填	您要创建的策略的描述。
`policies[].name`	必填	要创建的策略的名称。
`policies[].manifests`	必填	策略中包含的 Kubernetes 对象清单列表，以及覆盖默认值、此`策略`项中设置的值或 `policyDefaults` 中设置的值。如需了解更多字段和描述，请参阅 `policyDefaults`。当将 `Manifests` 设置为 `true` 时，只有 `complianceType`、`metadataComplianceType` 和 `recordDiff` 可以在 `policies[].manifests` 级别被覆盖。
`policies[].manifests[].path`	必填	相对于 `kustomization.yaml` 文件，到单个文件的路径、平面文件目录或 Kustomize 目录。如果该目录是一个 Kustomize 目录，则生成器会在生成策略前针对目录运行 Kustomize。如果需要为 Kustomize 目录处理 Helm chart，请在运行策略生成器的环境中将 `POLICY_GEN_ENABLE_HELM` 设置为 `"true"`，以便为策略生成器启用 Helm。
`policies[].manifests[].patches`	选填	应用到路径上清单的 Kustomize 补丁列表。如果有多个清单，补丁需要设置 `apiVersion`、`kind`、`metadata.name` 和 `metadata.namespace` （如果适用）字段，以便 Kustomize 可以识别补丁应用到的清单。如果只有一个清单，则可以修补 `metadata.name` 和 `metadata.namespace` 字段。
`policies.policyLabels`	选填	策略在 `metadata.labels` 部分中包含的标签。`policyLabels` 参数适用于所有策略，除非在策略中指定。
`policySets`	选填	要创建的策略集合列表，以及覆盖默认值或 `policySetDefaults` 中设置的值。要在策略集中包含策略，请使用 `policyDefaults.policySets`, `policies[].policySets`, 或 `policySets.policies`。如需了解更多字段和描述，请参阅 `policySetDefaults`。
`policySets[].name`	必填	要创建的策略的名称。
`policySets[].description`	选填	要创建的策略集的描述。
`policySets[].policies`	选填	包括在策略集中的策略列表。如果还指定了 `policyDefaults.policySets` 或 `policies[].policySets`，则列表会被合并。

4.1.4. 其他资源

读取生成策略以安装 GitOps Operator。
如需了解更多详细信息，请参阅策略设置控制器。
如需更多信息，请参阅应用 Kustomize。
如需了解更多主题，请参阅监管文档。
请参阅 kustomization.yaml 文件示例。
请参阅 Kubernetes 标签和选择器文档。
如需更多详细信息，请参阅 Gatekeeper。
请参阅 Kustomize 文档。
返回集成第三方策略控制器文档。

第 4 章集成第三方策略控制器

4.1. 策略生成器

4.1.1. 策略生成器功能

4.1.2. 策略生成器配置结构

4.1.3. 策略生成器配置参考表

4.1.4. 其他资源

学习

尝试、购买和销售

社区

关于红帽文档

让开源更具包容性

關於紅帽

Red Hat legal and privacy links

Red Hat legal and privacy links

第 4 章 集成第三方策略控制器

4.1. 策略生成器

4.1.1. 策略生成器功能

4.1.2. 策略生成器配置结构

4.1.3. 策略生成器配置参考表

4.1.4. 其他资源

学习

尝试、购买和销售

社区

关于红帽文档

让开源更具包容性

關於紅帽

Red Hat legal and privacy links

Red Hat legal and privacy links

第 4 章集成第三方策略控制器