Chapter 2. Governance Enterprises must meet internal standards for software engineering, secure engineering, resiliency, security, and regulatory compliance for workloads hosted on private, multi and hybrid clouds. Red Hat Advanced Cluster Management for Kubernetes governance provides an extensible policy framework for enterprises to introduce their own security policies. Continue reading the related topics of the Red Hat Advanced Cluster Management governance framework: Governance architecture Policy overview Policy controllers introduction Policy controller advanced configuration Policy compliance history (Technology Preview) Supported policies Policy dependencies Manage Governance dashboard Secure the hub cluster Gatekeeper operator overview Integrating Policy Generator 2.1. Governance architecture Enhance the security for your cluster with the Red Hat Advanced Cluster Management for Kubernetes governance lifecycle. The product governance lifecycle is based on using supported policies, processes, and procedures to manage security and compliance from a central interface page. View the following diagram of the governance architecture: View the following component descriptions for the governance architecture diagram: Policy propagator controller: Runs on the Red Hat Advanced Cluster Management hub cluster and generates the replicated policies in the managed cluster namespaces on the hub based on the placements bound to the root policy. It also aggregates compliance status from replicated policies to the root policy status and initiates automations based on policy automations bound to the root policy. Governance policy add-on controller: Runs on the Red Hat Advanced Cluster Management hub cluster and manages the installation of policy controllers on managed clusters. Governance policy framework: The image represents the framework that runs as the governance-policy-framework pod on managed clusters and contains the following controllers: Spec sync controller: Synchronizes the replicated policy in the managed cluster namespace on the hub cluster to the managed cluster namespace on the managed cluster. Status sync controller: Records compliance events from policy controllers in the replicated policies on the hub and managed cluster. The status only contains updates that are relevant to the current policy and does not consider past statuses if the policy is deleted and recreated. Template sync controller: Creates, updates, and deletes objects in the managed cluster namespace on the managed cluster based on the definitions from the replicated policy spec.policy-templates entries. Gatekeeper sync controller: Records Gatekeeper constraint audit results as compliance events in corresponding Red Hat Advanced Cluster Management policies. 2.1.1. Governance architecture components The governance architecture also include following components: Governance dashboard: Provides a summary of your cloud governance and risk details, which include policy and cluster violations. Refer to the Manage Governance dashboard section to learn about the structure of an Red Hat Advanced Cluster Management for Kubernetes policy framework, and how to use the Red Hat Advanced Cluster Management for Kubernetes Governance dashboard. Notes: When a policy is propagated to a managed cluster, it is first replicated to the cluster namespace on the hub cluster, and is named and labeled using namespaceName.policyName . When you create a policy, make sure that the length of the namespaceName.policyName does not exceed 63 characters due to the Kubernetes length limit for label values. When you search for a policy in the hub cluster, you might also receive the name of the replicated policy in the managed cluster namespace. For example, if you search for policy-dhaz-cert in the default namespace, the following policy name from the hub cluster might also appear in the managed cluster namespace: default.policy-dhaz-cert . Policy-based governance framework: Supports policy creation and deployment to various managed clusters based on attributes associated with clusters, such as a geographical region. There are examples of the predefined policies and instructions on deploying policies to your cluster in the open source community . Additionally, when policies are violated, automations can be configured to run and take any action that the user chooses. Open source community: Supports community contributions with a foundation of the Red Hat Advanced Cluster Management policy framework. Policy controllers and third-party policies are also a part of the open-cluster-management/policy-collection repository . You can contribute and deploy policies using GitOps. 2.1.2. Additional resources See Policy controllers introduction . See Deploying policies by using GitOps . 2.2. Policy overview To create and manage policies, gain visibility and remediate configurations to meet standards, use the Red Hat Advanced Cluster Management for Kubernetes security policy framework. Kubernetes custom resource definition instances are used to create policies. You can create a policy in any namespace on the hub cluster except the managed cluster namespaces. If you create a policy in a managed cluster namespace, it is deleted by Red Hat Advanced Cluster Management. Each Red Hat Advanced Cluster Management policy can be organized into one or more policy template definitions. For more details about the policy elements, view the Policy YAML table section on this page. You are responsible for ensuring that the managed cloud environment meets internal enterprise security standards for software engineering, secure engineering, resiliency, security, and regulatory compliance for workloads hosted on Kubernetes clusters. 2.2.1. Prerequisites Each policy requires a Placement resource that defines the clusters that the policy document is applied to, and a PlacementBinding resource that binds the Red Hat Advanced Cluster Management for Kubernetes policy. Policy resources are applied to cluster based on an associated Placement definition, where you can view a list of managed clusters that match a certain criteria. A sample Placement resource that matches all clusters that have the environment=dev label resembles the following YAML: apiVersion: cluster.open-cluster-management.io/v1beta1 kind: Placement metadata: name: placement-policy-role spec: predicates: - requiredClusterSelector: labelSelector: matchExpressions: - {key: environment, operator: In, values: ["dev"]} To learn more about placement and the supported criteria, see Placement overview in the Cluster lifecycle documentation. In addition to the Placement resource, you must create a PlacementBinding to bind your Placement resource to a policy. A sample Placement resource that matches all clusters that have the environment=dev label resembles the following YAML: apiVersion: policy.open-cluster-management.io/v1 kind: PlacementBinding metadata: name: binding-policy-role placementRef: name: placement-policy-role 1 kind: Placement apiGroup: cluster.open-cluster-management.io subjects: 2 - name: policy-role kind: Policy apiGroup: policy.open-cluster-management.io 1 If you use the sample, make sure you update the name of the Placement resource in the placementRef section to match your placement name. 2 You must update the name of the policy in the subjects section to match your policy name. Use the oc apply -f resource.yaml -n namespace command to apply both the Placement and the Placementbinding resources. Make sure the policy, placement and placement binding are all created in the same namespace. To use a Placement resource, you must bind a ManagedClusterSet resource to the namespace of the Placement resource with a ManagedClusterSetBinding resource. Refer to Creating a ManagedClusterSetBinding resource for additional details. When you create a Placement resource for your policy from the console, the status of the placement toleration is automatically added to the Placement resource. See Adding a toleration to a placement for more details. Best practice: Use the command line interface (CLI) to make updates to the policies when you use the Placement resource. Learn more details about the policy components in the following sections: Policy YAML structure Policy YAML table Policy sample file 2.2.2. Policy YAML structure When you create a policy, you must include required parameter fields and values. Depending on your policy controller, you might need to include other optional fields and values. View the following YAML structure for policies: apiVersion: policy.open-cluster-management.io/v1 kind: Policy metadata: name: annotations: policy.open-cluster-management.io/standards: policy.open-cluster-management.io/categories: policy.open-cluster-management.io/controls: policy.open-cluster-management.io/description: spec: disabled: remediationAction: dependencies: - apiVersion: policy.open-cluster-management.io/v1 compliance: kind: Policy name: namespace: policy-templates: - objectDefinition: apiVersion: kind: metadata: name: spec: --- apiVersion: policy.open-cluster-management.io/v1 kind: PlacementBinding metadata: bindingOverrides: remediationAction: subFilter: name: placementRef: name: kind: Placement apiGroup: cluster.open-cluster-management.io subjects: - name: kind: apiGroup: --- apiVersion: cluster.open-cluster-management.io/v1beta1 kind: Placement metadata: name: spec: 2.2.3. Policy YAML table View the following table for policy parameter descriptions: Table 2.1. Parameter table Field Optional or required Description apiVersion Required Set the value to policy.open-cluster-management.io/v1 . kind Required Set the value to Policy to indicate the type of policy. metadata.name Required The name for identifying the policy resource. metadata.annotations Optional Used to specify a set of security details that describes the set of standards the policy is trying to validate. All annotations documented here are represented as a string that contains a comma-separated list. Note: You can view policy violations based on the standards and categories that you define for your policy on the Policies page, from the console. bindingOverrides.remediationAction Optional When this parameter is set to enforce , it provides a way for you to override the remediation action of the related PlacementBinding resources for configuration policies. The default value is null . subFilter Optional Set this parameter to restriction to select a subset of bound policies. The default value is null . annotations.policy.open-cluster-management.io/standards Optional The name or names of security standards the policy is related to. For example, National Institute of Standards and Technology (NIST) and Payment Card Industry (PCI). annotations.policy.open-cluster-management.io/categories Optional A security control category represent specific requirements for one or more standards. For example, a System and Information Integrity category might indicate that your policy contains a data transfer protocol to protect personal information, as required by the HIPAA and PCI standards. annotations.policy.open-cluster-management.io/controls Optional The name of the security control that is being checked. For example, Access Control or System and Information Integrity. spec.disabled Required Set the value to true or false . The disabled parameter provides the ability to enable and disable your policies. spec.remediationAction Optional Specifies the remediation of your policy. The parameter values are enforce and inform . If specified, the spec.remediationAction value that is defined overrides any remediationAction parameter defined in the child policies in the policy-templates section. For example, if the spec.remediationAction value is set to enforce , then the remediationAction in the policy-templates section is set to enforce during runtime. spec.copyPolicyMetadata Optional Specifies whether the labels and annotations of a policy should be copied when replicating the policy to a managed cluster. If you set to true , all of the labels and annotations of the policy are copied to the replicated policy. If you set to false , only the policy framework specific policy labels and annotations are copied to the replicated policy. spec.dependencies Optional Used to create a list of dependency objects detailed with extra considerations for compliance. spec.policy-templates Required Used to create one or more policies to apply to a managed cluster. spec.policy-templates.extraDependencies Optional For policy templates, this is used to create a list of dependency objects detailed with extra considerations for compliance. spec.policy-templates.ignorePending Optional Used to mark a policy template as compliant until the dependency criteria is verified. Important: Some policy kinds might not support the enforce feature. 2.2.4. Policy sample file View the following YAML file which is a configuration policy for roles: apiVersion: policy.open-cluster-management.io/v1 kind: Policy metadata: name: policy-role annotations: policy.open-cluster-management.io/standards: NIST SP 800-53 policy.open-cluster-management.io/categories: AC Access Control policy.open-cluster-management.io/controls: AC-3 Access Enforcement policy.open-cluster-management.io/description: spec: remediationAction: inform disabled: false policy-templates: - objectDefinition: apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: policy-role-example spec: remediationAction: inform # the policy-template spec.remediationAction is overridden by the preceding parameter value for spec.remediationAction. severity: high namespaceSelector: include: ["default"] object-templates: - complianceType: mustonlyhave # role definition should exact match objectDefinition: apiVersion: rbac.authorization.k8s.io/v1 kind: Role metadata: name: sample-role rules: - apiGroups: ["extensions", "apps"] resources: ["deployments"] verbs: ["get", "list", "watch", "delete","patch"] --- apiVersion: policy.open-cluster-management.io/v1 kind: PlacementBinding metadata: name: binding-policy-role placementRef: name: placement-policy-role kind: Placement apiGroup: cluster.open-cluster-management.io subjects: - name: policy-role kind: Policy apiGroup: policy.open-cluster-management.io --- apiVersion: cluster.open-cluster-management.io/v1beta1 kind: Placement metadata: name: placement-policy-role spec: predicates: - requiredClusterSelector: labelSelector: matchExpressions: - {key: environment, operator: In, values: ["dev"]} 2.2.5. Additional resources Refer to Policy controllers . See Managing security policies to create and update a policy. You can also enable and update Red Hat Advanced Cluster Management policy controllers to validate the compliance of your policies. Return to the Governance documentation. 2.3. Policy controllers introduction Policy controllers monitor and report whether your cluster is compliant with a policy. Use the Red Hat Advanced Cluster Management for Kubernetes policy framework by using the supported policy templates to apply policies managed by these controllers. The policy controllers manage Kubernetes custom resource definition instances. Policy controllers check for policy violations, and can make the cluster status compliant if the controller supports the enforcement feature. View the following topics to learn more about the following Red Hat Advanced Cluster Management for Kubernetes policy controllers: Kubernetes configuration policy controller Certificate policy controller Policy set controller Operator policy controller Important: Only the configuration policy controller policies support the enforce feature. You must manually remediate policies, where the policy controller does not support the enforce feature. 2.3.1. Kubernetes configuration policy controller The configuration policy controller can be used to configure any Kubernetes resource and apply security policies across your clusters. The configuration policy is provided in the policy-templates field of the policy on the hub cluster, and is propagated to the selected managed clusters by the governance framework. A Kubernetes object is defined (in whole or in part) in the object-templates array in the configuration policy, indicating to the configuration policy controller of the fields to compare with objects on the managed cluster. The configuration policy controller communicates with the local Kubernetes API server to get the list of your configurations that are in your cluster. The configuration policy controller is created on the managed cluster during installation. The configuration policy controller supports the enforce and the InformOnly feature to remediate when the configuration policy is non-compliant. When the remediationAction for the configuration policy is set to enforce , the controller applies the specified configuration to the target managed cluster. When the remediationAction for the configuration policy is set to InformOnly , the parent policy does not enforce the configuration policy, even if the remediationAction in the parent policy is set to enforce . Note: Configuration policies that specify an object without a name can only be inform . You can also use templated values within configuration policies. For more information, see Template processing . If you have existing Kubernetes manifests that you want to put in a policy, the Policy Generator is a useful tool to accomplish this. 2.3.1.1. Configuration policy sample apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: policy-config spec: namespaceSelector: include: ["default"] exclude: [] matchExpressions: [] matchLabels: {} remediationAction: inform severity: low evaluationInterval: compliant: noncompliant: object-templates: - complianceType: musthave objectDefinition: apiVersion: v1 kind: Pod metadata: name: pod spec: containers: - image: pod-image name: pod-name ports: - containerPort: 80 - complianceType: musthave objectDefinition: apiVersion: v1 kind: ConfigMap metadata: name: myconfig namespace: default data: testData: hello spec: ... 2.3.1.2. Configuration policy YAML table Table 2.2. Parameter table Field Optional or required Description apiVersion Required Set the value to policy.open-cluster-management.io/v1 . kind Required Set the value to ConfigurationPolicy to indicate the type of policy. metadata.name Required The name of the policy. spec.namespaceSelector Required for namespaced objects that do not have a namespace specified Determines namespaces in the managed cluster that the object is applied to. The include and exclude parameters accept file path expressions to include and exclude namespaces by name. The matchExpressions and matchLabels parameters specify namespaces to include by label. See the Kubernetes labels and selectors documentation. The resulting list is compiled by using the intersection of results from all parameters. spec.remediationAction Required Specifies the action to take when the policy is non-compliant. Use the following parameter values: inform , InformOnly , or enforce . spec.severity Required Specifies the severity when the policy is non-compliant. Use the following parameter values: low , medium , high , or critical . spec.evaluationInterval.compliant Optional Used to define how often the policy is evaluated when it is in the compliant state. The values must be in the format of a duration which is a sequence of numbers with time unit suffixes. For example, 12h30m5s represents 12 hours, 30 minutes, and 5 seconds. It can also be set to never so that the policy is not reevaluated on the compliant cluster, unless the policy spec is updated. By default, the minimum time between evaluations for configuration policies is approximately 10 seconds when the evaluationInterval.compliant is not set or empty. This can be longer if the configuration policy controller is saturated on the managed cluster. spec.evaluationInterval.noncompliant Optional Used to define how often the policy is evaluated when it is in the non-compliant state. Similar to the evaluationInterval.compliant parameter, the values must be in the format of a duration which is a sequence of numbers with time unit suffixes. It can also be set to never so that the policy is not reevaluated on the non-compliant cluster, unless the policy spec is updated. spec.object-templates Optional The array of Kubernetes objects (either fully defined or containing a subset of fields) for the controller to compare with objects on the managed cluster. Note: While spec.object-templates and spec.object-templates-raw are listed as optional, exactly one of the two parameter fields must be set. spec.object-templates-raw Optional Used to set object templates with a raw YAML string. Specify conditions for the object templates, where advanced functions like if-else statements and the range function are supported values. For example, add the following value to avoid duplication in your object-templates definition: {{- if eq .metadata.name "policy-grc-your-meta-data-name" }} replicas: 2 {{- else }} replicas: 1 {{- end }} Note: While spec.object-templates and spec.object-templates-raw are listed as optional, exactly one of the two parameter fields must be set. spec.object-templates[].complianceType Required Use this parameter to define the desired state of the Kubernetes object on your managed clusters. Use one of the following verbs as the parameter value: mustonlyhave : Indicates that an object must exist with the exact fields and values as defined in the objectDefinition . musthave : Indicates an object must exist with the same fields as specified in the objectDefinition . Any existing fields on the object that are not specified in the object-template are ignored. In general, array values are appended. The exception for the array to be patched is when the item contains a name key with a value that matches an existing item. Use a fully defined objectDefinition using the mustonlyhave compliance type, if you want to replace the array. mustnothave : Indicates that an object with the same fields as specified in the objectDefinition cannot exist. spec.object-templates[].metadataComplianceType Optional Overrides spec.object-templates[].complianceType when comparing the manifest's metadata section to objects on the cluster ("musthave", "mustonlyhave"). Default is unset to not override complianceType for metadata. spec.object-templates[].recordDiff Optional Use this parameter to specify if and where to display the difference between the object on the cluster and the objectDefinition in the policy. The following options are supported: Set to InStatus to store the difference in the ConfigurationPolicy status. Set to Log to log the difference in the controller logs. Set to None to not log the difference. By default, this parameter is set to InStatus if the controller does not detect sensitive data in the difference. Otherwise, the default is None . If sensitive data is detected, the ConfigurationPolicy status displays a message to set recordDiff to view the difference. spec.object-templates[].recreateOption Optional Describes when to delete and recreate an object when an update is required. When you set the object to IfRequired , the policy recreates the object when updating an immutable field. When you set the parameter to Always , the policy recreates the object on any update. When you set the remediationAction to inform , the parameter value, recreateOption , has no effect on the object. The IfRequired value has no effect on clusters without dry-run update support. The default value is None . spec.object-templates[].objectDefinition Required A Kubernetes object (either fully defined or containing a subset of fields) for the controller to compare with objects on the managed cluster. spec.pruneObjectBehavior Optional Determines whether to clean up resources related to the policy when the policy is removed from a managed cluster. 2.3.1.3. Additional resources See the following topics for more information: See the Policy overview for more details on the hub cluster policy. See the policy samples that use NIST Special Publication 800-53 (Rev. 4) , and are supported by Red Hat Advanced Cluster Management from the CM-Configuration-Management folder . For information about dry-run support, see the Kubernetes documentation, Dry-run . Learn about how policies are applied on your hub cluster, see Supported policies for more details. Refer to Policy controllers for more details about controllers. Customize your policy controller configuration. See Policy controller advanced configuration . Learn about cleaning up resources and other topics in the Cleaning up resources that are created by policies documentation. Refer to Policy Generator . Learn about how to create and customize policies, see Manage Governance dashboard . See Template processing . 2.3.2. Certificate policy controller You can use the certificate policy controller to detect certificates that are close to expiring, time durations (hours) that are too long, or contain DNS names that fail to match specified patterns. You can add the certificate policy to the policy-templates field of the policy on the hub cluster, which propagates to the selected managed clusters by using the governance framework. See the Policy overview documentation for more details on the hub cluster policy. Configure and customize the certificate policy controller by updating the following parameters in your controller policy: minimumDuration minimumCADuration maximumDuration maximumCADuration allowedSANPattern disallowedSANPattern Your policy might become non-compliant due to either of the following scenarios: When a certificate expires in less than the minimum duration of time or exceeds the maximum time. When DNS names fail to match the specified pattern. The certificate policy controller is created on your managed cluster. The controller communicates with the local Kubernetes API server to get the list of secrets that contain certificates and determine all non-compliant certificates. Certificate policy controller does not support the enforce feature. Note: The certificate policy controller automatically looks for a certificate in a secret in only the tls.crt key. If a secret is stored under a different key, add a label named certificate_key_name with a value set to the key to let the certificate policy controller know to look in a different key. For example, if a secret contains a certificate stored in the key named sensor-cert.pem , add the following label to the secret: certificate_key_name: sensor-cert.pem . 2.3.2.1. Certificate policy controller YAML structure View the following example of a certificate policy and review the element in the YAML table: apiVersion: policy.open-cluster-management.io/v1 kind: CertificatePolicy metadata: name: certificate-policy-example spec: namespaceSelector: include: ["default"] exclude: [] matchExpressions: [] matchLabels: {} labelSelector: myLabelKey: myLabelValue remediationAction: severity: minimumDuration: minimumCADuration: maximumDuration: maximumCADuration: allowedSANPattern: disallowedSANPattern: 2.3.2.1.1. Certificate policy controller YAML table Table 2.3. Parameter table Field Optional or required Description apiVersion Required Set the value to policy.open-cluster-management.io/v1 . kind Required Set the value to CertificatePolicy to indicate the type of policy. metadata.name Required The name to identify the policy. metadata.labels Optional In a certificate policy, the category=system-and-information-integrity label categorizes the policy and facilitates querying the certificate policies. If there is a different value for the category key in your certificate policy, the value is overridden by the certificate controller. spec.namespaceSelector Required Determines namespaces in the managed cluster where secrets are monitored. The include and exclude parameters accept file path expressions to include and exclude namespaces by name. The matchExpressions and matchLabels parameters specify namespaces to be included by label. See the Kubernetes labels and selectors documentation. The resulting list is compiled by using the intersection of results from all parameters. Note: If the namespaceSelector for the certificate policy controller does not match any namespace, the policy is considered compliant. spec.labelSelector Optional Specifies identifying attributes of objects. See the Kubernetes labels and selectors documentation. spec.remediationAction Required Specifies the remediation of your policy. Set the parameter value to inform . Certificate policy controller only supports inform feature. spec.severity Optional Informs the user of the severity when the policy is non-compliant. Use the following parameter values: low , medium , high , or critical . spec.minimumDuration Required When a value is not specified, the default value is 100h . This parameter specifies the smallest duration (in hours) before a certificate is considered non-compliant. The parameter value uses the time duration format from Golang. See Golang Parse Duration for more information. spec.minimumCADuration Optional Set a value to identify signing certificates that might expire soon with a different value from other certificates. If the parameter value is not specified, the CA certificate expiration is the value used for the minimumDuration . See Golang Parse Duration for more information. spec.maximumDuration Optional Set a value to identify certificates that have been created with a duration that exceeds your desired limit. The parameter uses the time duration format from Golang. See Golang Parse Duration for more information. spec.maximumCADuration Optional Set a value to identify signing certificates that have been created with a duration that exceeds your defined limit. The parameter uses the time duration format from Golang. See Golang Parse Duration for more information. spec.allowedSANPattern Optional A regular expression that must match every SAN entry that you have defined in your certificates. This parameter checks DNS names against patterns. See the Golang Regular Expression syntax for more information. spec.disallowedSANPattern Optional A regular expression that must not match any SAN entries you have defined in your certificates. This parameter checks DNS names against patterns. Note: To detect wild-card certificate, use the following SAN pattern: disallowedSANPattern: "[\\*]" See the Golang Regular Expression syntax for more information. 2.3.2.2. Certificate policy sample When your certificate policy controller is created on your hub cluster, a replicated policy is created on your managed cluster. See policy-certificate.yaml to view the certificate policy sample. 2.3.2.3. Additional resources Learn how to manage a certificate policy, see Managing security policies for more details. Refer to Policy controllers introduction for more topics. Return to the Certificates introduction . 2.3.3. Policy set controller The policy set controller aggregates the policy status scoped to policies that are defined in the same namespace. Create a policy set ( PolicySet ) to group policies that are in the same namespace. All policies in the PolicySet are placed together in a selected cluster by creating a PlacementBinding to bind the PolicySet and Placement . The policy set is deployed to the hub cluster. Additionally, when a policy is a part of multiple policy sets, existing and new Placement resources remain in the policy. When a user removes a policy from the policy set, the policy is not applied to the cluster that is selected in the policy set, but the placements remain. The policy set controller only checks for violations in clusters that include the policy set placement. Notes: The Red Hat Advanced Cluster Management sample policy set uses cluster placement. If you use cluster placement, bind the namespace containing the policy to the managed cluster set. See Deploying policies to your cluster for more details on using cluster placement. In order to use a Placement resource, a ManagedClusterSet resource must be bound to the namespace of the Placement resource with a ManagedClusterSetBinding resource. Refer to Creating a ManagedClusterSetBinding resource for additional details. Learn more details about the policy set structure in the following sections: Policy set controller YAML structure Policy set controller YAML table Policy set sample 2.3.3.1. Policy set YAML structure Your policy set might resemble the following YAML file: apiVersion: policy.open-cluster-management.io/v1beta1 kind: PolicySet metadata: name: demo-policyset spec: policies: - policy-demo --- apiVersion: policy.open-cluster-management.io/v1 kind: PlacementBinding metadata: name: demo-policyset-pb placementRef: apiGroup: cluster.open-cluster-management.io kind: Placement name: demo-policyset-pr subjects: - apiGroup: policy.open-cluster-management.io kind: PolicySet name: demo-policyset --- apiVersion: cluster.open-cluster-management.io/v1beta1 kind: Placement metadata: name: demo-policyset-pr spec: predicates: - requiredClusterSelector: labelSelector: matchExpressions: - key: name operator: In values: - local-cluster 2.3.3.2. Policy set table View the following parameter table for descriptions: Table 2.4. Parameter table Field Optional or required Description apiVersion Required Set the value to policy.open-cluster-management.io/v1beta1 . kind Required Set the value to PolicySet to indicate the type of policy. metadata.name Required The name for identifying the policy resource. spec Required Add configuration details for your policy. spec.policies Optional The list of policies that you want to group together in the policy set. 2.3.3.3. Policy set sample apiVersion: policy.open-cluster-management.io/v1beta1 kind: PolicySet metadata: name: pci namespace: default spec: description: Policies for PCI compliance policies: - policy-pod - policy-namespace status: compliant: NonCompliant placement: - placementBinding: binding1 placement: placement1 policySet: policyset-ps 2.3.3.4. Additional resources See Red Hat OpenShift Platform Plus policy set . See the Creating policy sets section in the Managing security policies topic. Also view the stable PolicySets , which require the Policy Generator for deployment, PolicySets-- Stable . Return to the beginning of this topic, Policy set controller . 2.3.4. Operator policy controller The operator policy controller allows you to monitor and install Operator Lifecycle Manager operators across your clusters. Use the operator policy controller to monitor the health of various pieces of the operator and to specify how you want to automatically handle updates to the operator. You can also distribute an operator policy to managed clusters by using the governance framework and adding the policy to the policy-templates field of a policy on the hub cluster. You can also use template values within the operatorGroup and subscription fields of an operator policy. For more information, see Template processing . 2.3.4.1. Prerequisites Operator Lifecycle Manager must be available on your managed cluster. This is enabled by default on Red Hat OpenShift Container Platform. Required access: Cluster administrator 2.3.4.2. Operator policy YAML table Field Optional or required Description apiVersion Required Set the value to policy.open-cluster-management.io/v1beta1 . kind Required Set the value to OperatorPolicy to indicate the type of policy. metadata.name Required The name for identifying the policy resource. spec.remediationAction Required If the remediationAction for the operator policy is set to enforce , the controller creates resources on the target managed cluster to communicate to OLM to install the operator and approve updates based on the versions specified in the policy. + If the remediationAction set to inform , the controller only reports the status of the operator, including if any upgrades are available. spec.operatorGroup Optional By default, if the operatorGroup field is not specified, the controller generates an AllNamespaces type OperatorGroup in the same namespace as the subscription, if supported. This resource is generated by the operator policy controller. spec.complianceType Required Specifies the desired state of the operator on the cluster. If set to musthave , the policy is compliant when the operator is found. If set to mustnothave , the policy is compliant when the operator is not found. spec.removalBehavior Optional Determines which resource types need to be kept or removed when you enforce an OperatorPolicy resource with complianceType: mustnothave defined. There is no effect when complianceType is set to musthave . - operatorGroups can be set to Keep or DeleteIfUnused . The default value is DeleteIfUnusued which only removes the OperatorGroup resource if it is not used by any other operators. - subscriptions can be set to Keep or Delete . The default value is Delete . - clusterServiceVersions can be set to Keep or Delete . The default value is Delete . - customResourceDefinitions can be set to Keep or Delete . The default value is Keep . If you set this to Delete , the CustomResourceDefintion resources on the managed cluster are removed and can cause data loss. spec.subscription Required Define the configurations to create an operator subscription. Add information in the following fields to create an operator subscription. Default options are selected for a few items if there is no entry: channel : If not specified, the default channel is selected from the operator catalog. The default can be different on different OpenShift Container Platform versions. name : Specify the package name of the operator. namespace : If not specified, the default namespaced that is used for OpenShift Container Platform managed clusters is openshift-operators . source : If not specified, the catalog that contains the operator is chosen. sourceNamespace : If not specified, the namespace of the catalog that contains the operator is chosen. Note: If you define a value for upgradeApproval , your policy becomes non-compliant. spec.complianceConfig Optional Use this parameter to define the compliance behavior for specific scenarios that are associated with operators. You can set each of the following options individually, where the supported values are Compliant and NonCompliant : catalogSourceUnhealthy : Define the compliance when the catalog source for the operator is unhealthy. The default value is Compliant because this only affects possible upgrades. deploymentsUnavailable : Define the compliance when at least one deployment of the operator is not fully available. The default value is NonCompliant because this reflects the availability of the service that the operator provides. upgradesAvailable : Define the compliance when there is an upgrade available for the operator. The default value is Compliant because the existing operator installation might be running correctly. spec.upgradeApproval Required If the upgradeApproval field is set to Automatic , version upgrades on the cluster are approved by the policy when the policy is set to enforce . If you set the field to None , version upgrades to the specific operator are not approved when the policy is set to enforce . spec.versions Optional Declare which versions of the operator are compliant. If the field is empty, any version running on the cluster is considered compliant. If the field is not empty, the version on the managed cluster must match one of the versions in the list for the policy to be compliant. If the policy is set to enforce and the list is not empty, the versions listed here are approved by the controller on the cluster. 2.3.4.3. Additional resources See Template processing . See Installing an operator by using the OperatorPolicy resource for more details. See the Subscription topic in the OpenShift Container Platform documentation. See Operator Lifecycle Manager (OLM) for more details. See the Adding Operators to a cluster documentation for general information on OLM. 2.4. Policy controller advanced configuration You can customize policy controller configurations on your managed clusters by using the ManagedClusterAddOn custom resources. The following ManagedClusterAddOns configure the policy framework, Kubernetes configuration policy controller, and the Certificate policy controller. Required access: Cluster administrator Configure the concurrency of the governance framework Configure the concurrency of the configuration policy controller Configure the rate of requests to the API server Configure debug log Governance metric Verify configuration changes 2.4.1. Configure the concurrency of the governance framework Configure the concurrency of the governance framework for each managed cluster. To change the default value of 2 , set the policy-evaluation-concurrency annotation with a nonzero integer within quotation marks. Then set the value on the ManagedClusterAddOn object name to governance-policy-framework in the managed cluster namespace of the hub cluster. See the following YAML example where the concurrency is set to 2 on the managed cluster named cluster1 : apiVersion: addon.open-cluster-management.io/v1alpha1 kind: ManagedClusterAddOn metadata: name: governance-policy-framework namespace: cluster1 annotations: policy-evaluation-concurrency: "2" spec: installNamespace: open-cluster-management-agent-addon To set the client-qps and client-burst annotations, update the ManagedClusterAddOn resource and define the parameters. See the following YAML example where the queries for each second is set to 30 and the burst is set to 45 on the managed cluster called cluster1 : apiVersion: addon.open-cluster-management.io/v1alpha1 kind: ManagedClusterAddOn metadata: name: governance-policy-framework namespace: cluster1 annotations: client-qps: "30" client-burst: "45" spec: installNamespace: open-cluster-management-agent-addon 2.4.2. Configure the concurrency of the configuration policy controller You can configure the concurrency of the configuration policy controller for each managed cluster to change how many configuration policies it can evaluate at the same time. To change the default value of 2 , set the policy-evaluation-concurrency annotation with a nonzero integer within quotation marks. Then set the value on the ManagedClusterAddOn object name to config-policy-controller in the managed cluster namespace of the hub cluster. Note: Increased concurrency values increase CPU and memory utilization on the config-policy-controller pod, Kubernetes API server, and OpenShift API server. See the following YAML example where the concurrency is set to 5 on the managed cluster named cluster1 : apiVersion: addon.open-cluster-management.io/v1alpha1 kind: ManagedClusterAddOn metadata: name: config-policy-controller namespace: cluster1 annotations: policy-evaluation-concurrency: "5" spec: installNamespace: open-cluster-management-agent-addon 2.4.3. Configure the rate of requests to the API server Configure the rate of requests to the API server that the configuration policy controller makes on each managed cluster. An increased rate improves the responsiveness of the configuration policy controller, which also increases the CPU and memory utilization of the Kubernetes API server and OpenShift API server. By default, the rate of requests scales with the policy-evaluation-concurrency setting and is set to 30 queries for each second (QPS), with a 45 burst value, representing a higher number of requests over short periods of time. You can configure the rate and burst by setting the client-qps and client-burst annotations with nonzero integers within quotation marks. You can set the value on the ManagedClusterAddOn object name to config-policy-controller in the managed cluster namespace of the hub cluster. See the following YAML example where the queries for each second is set to 20 and the burst is set to 100 on the managed cluster called cluster1 : apiVersion: addon.open-cluster-management.io/v1alpha1 kind: ManagedClusterAddOn metadata: name: config-policy-controller namespace: cluster1 annotations: client-qps: "20" client-burst: "100" spec: installNamespace: open-cluster-management-agent-addon 2.4.4. Configure debug log When you configure and collect debug logs for each policy controller, you can adjust the log level. Note: Reducing the volume of debug logs means there is less information displayed from the logs. You can reduce the debug logs emitted by the policy controllers to be display error-only bugs in the logs. To reduce the debug logs, set the debug log value to -1 in the annotation. See what each value represents: -1 : error logs only 0 : informative logs 1 : debug logs 2 : verbose debugging logs To receive the second level of debugging information for the Kubernetes configuration controller, add the log-level annotation with the value of 2 to the ManagedClusterAddOn custom resource. By default, the log-level is set to 0 , which means you receive informative messages. View the following example: apiVersion: addon.open-cluster-management.io/v1alpha1 kind: ManagedClusterAddOn metadata: name: config-policy-controller namespace: cluster1 annotations: log-level: "2" spec: installNamespace: open-cluster-management-agent-addon Additionally, for each spec.object-template[] in a ConfigurationPolicy resource, you can set the parameter recordDiff to Log . The difference between the objectDefinition and the object on the managed cluster is logged in the config-policy-controller pod on the managed cluster. View the following example: This ConfigurationPolicy resource with recordDiff: Log : apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: my-config-policy spec: object-templates: - complianceType: musthave recordDiff: Log objectDefinition: apiVersion: v1 kind: ConfigMap metadata: name: my-configmap data: fieldToUpdate: "2" If the ConfigMap resource on the cluster lists fieldToUpdate: "1" , then the diff appears in the config-policy-controller pod logs with the following information: Important: Avoid logging the difference for a secure object. The difference is logged in plain text. 2.4.5. Governance metric The policy framework exposes metrics that show policy distribution and compliance. Use the policy_governance_info metric on the hub cluster to view trends and analyze any policy failures. See the following topics for an overview of metrics: 2.4.5.1. Metric: policy_governance_info The OpenShift Container Platform monitoring component collects the policy_governance_info metric. If you enable observability, the component collects some aggregate data. Note: If you enable observability, enter a query for the metric from the Grafana Explore page. When you create a policy, you are creating a root policy. The framework watches for root policies, Placement resources, and PlacementBindings resources to for information about where to create propagated policies, to distribute the policy to managed clusters. For both root and propagated policies, a metric of 0 is recorded if the policy is compliant, and 1 if it is non-compliant. The policy_governance_info metric uses the following labels: type : The label values are root or propagated . policy : The name of the associated root policy. policy_namespace : The namespace on the hub cluster where the root policy is defined. cluster_namespace : The namespace for the cluster where the policy is distributed. These labels and values enable queries that can show us many things happening in the cluster that might be difficult to track. Note: If you do not need the metrics, and you have any concerns about performance or security, you can disable the metric collection. Set the DISABLE_REPORT_METRICS environment variable to true in the propagator deployment. You can also add policy_governance_info metric to the observability allowlist as a custom metric. See Adding custom metrics for more details. 2.4.5.2. Metric: config_policies_evaluation_duration_seconds The config_policies_evaluation_duration_seconds histogram tracks the number of seconds it takes to process all configuration policies that are ready to be evaluated on the cluster. Use the following metrics to query the histogram: config_policies_evaluation_duration_seconds_bucket : The buckets are cumulative and represent seconds with the following possible entries: 1, 3, 9, 10.5, 15, 30, 60, 90, 120, 180, 300, 450, 600, and greater. config_policies_evaluation_duration_seconds_count : The count of all events. config_policies_evaluation_duration_seconds_sum : The sum of all values. Use the config_policies_evaluation_duration_seconds metric to determine if the ConfigurationPolicy evaluationInterval setting needs to be changed for resource intensive policies that do not need frequent evaluation. You can also increase the concurrency at the cost of higher resource utilization on the Kubernetes API server. See Configure the concurrency section for more details. To receive information about the time used to evaluate configuration policies, perform a Prometheus query that resembles the following expression: rate(config_policies_evaluation_duration_seconds_sum[10m])/rate (config_policies_evaluation_duration_seconds_count[10m] The config-policy-controller pod running on managed clusters in the open-cluster-management-agent-addon namespace calculates the metric. The config-policy-controller does not send the metric to observability by default. 2.4.6. Verify configuration changes When you apply the new configuration with the controller, the ManifestApplied parameter is updated in the ManagedClusterAddOn . That condition timestamp helps verify the configuration correctly. For example, this command can verify when the cert-policy-controller on the local-cluster was updated: You might receive the following output: 2.4.7. Additional resources See Kubernetes configuration policy controller Return to the Governance topic for more topics. Return to the beginning of this topic, Policy controller advanced configuration . 2.5. Policy compliance history (Technology Preview) The policy compliance history API is an optional technical preview feature if you want long-term storage of Red Hat Advanced Cluster Management for Kubernetes policy compliance events in a queryable format. You can use the API to get additional details such as the spec field to audit and troubleshoot your policy, and get compliance events when a policy is disabled or removed from a cluster. The policy compliance history API can also generate a comma-separated values (CSV) spreadsheet of policy compliance events to help you with auditing and troubleshooting. The policy compliance history API can also generate a comma-separated values (CSV) spreadsheet of policy compliance events for further auditing and troubleshooting. 2.5.1. Prerequisites The policy compliance history API requires a PostgreSQL server on version 13 or newer. Some Red Hat supported options include using the registry.redhat.io/rhel9/postgresql-15 container image, the registry.redhat.io/rhel8/postgresql-13 container image, the postgresql-server RPM, or postgresql/server module. Review the applicable official Red Hat documentation on setup and configuration for the path you choose. The policy compliance history API is compatible with any standard PostgreSQL and is not limited to the official Red Hat supported offerings. This PostgreSQL server must be reachable from the Red Hat Advanced Cluster Management hub cluster. If the PostgreSQL server is running externally of the hub cluster, ensure the routing and firewall configuration allows the hub cluster to connect to port 5432 of the PostgreSQL server. This port might be a different value if it is overridden in the PostgreSQL configuration. 2.5.2. Enable the compliance history API Configure your managed clusters to record policy compliance events to the API. You can enable this on all clusters or a subset of clusters. Complete the following steps: Configure the PostgreSQL server as a cluster administrator. If you deployed PostgreSQL on your Red Hat Advanced Cluster Management hub cluster, temporarily port-forward the PostgreSQL port to use the psql command. Run the following command: oc -n <PostgreSQL namespace> port-forward <PostgreSQL pod name> 5432:5432 In a different terminal, connect to the PostgreSQL server locally similar to the following command: psql 'postgres://postgres:@127.0.0.1:5432/postgres' Create a user and database for your Red Hat Advanced Cluster Management hub cluster with the following SQL statements: CREATE USER "rhacm-policy-compliance-history" WITH PASSWORD '<replace with password>'; CREATE DATABASE "rhacm-policy-compliance-history" WITH OWNER="rhacm-policy-compliance-history"; Create the governance-policy-database Secret resource to use this database for the policy compliance history API. Run the following command: oc -n open-cluster-management create secret generic governance-policy-database \ 1 --from-literal="user=rhacm-policy-compliance-history" \ --from-literal="password=rhacm-policy-compliance-history" \ --from-literal="host=<replace with host name of the Postgres server>" \ 2 --from-literal="dbname=ocm-compliance-history" \ --from-literal="sslmode=verify-full" \ --from-file="ca=<replace>" 3 1 Add the namespace where Red Hat Advanced Cluster Management is installed. By default, Red Hat Advanced Cluster Management is installed in the open-cluster-management namespace. 2 Add the host name of the PostgresQL server. If you deployed the PostgreSQL server on the Red Hat Advanced Cluster Management hub cluster and it is not exposed outside of the cluster, you can use the Service object for the host value. The format is <service name>.<namespace>.svc . Note, this approach depends on the network policies of the Red Hat Advanced Cluster Management hub cluster. 3 You must specify the Certificate Authority certificate file in the ca data field that signed the TLS certificate of the PostgreSQL server. If you do not provide this value, you must change the sslmode value accordingly, though it is not recommended since it reduces the security of the database connection. Add the cluster.open-cluster-management.io/backup label to backup the Secret resource for a Red Hat Advanced Cluster Management hub cluster restore operation. Run the following command: oc -n open-cluster-management label secret governance-policy-database cluster.open-cluster-management.io/backup="" For more customization of the PostgreSQL connection, use the connectionURL data field directly and provide a value in the format of a PostgreSQL connection URI. Special characters in the password must be URL encoded. One option is to use Python to generate the URL encoded format of the password. For example, if the password is USDuper<Secr&t%> , run the following Python command to get the output %24uper%3CSecr%26t%25%3E : python -c 'import urllib.parse; import sys; print(urllib.parse.quote(sys.argv[1]))' 'USDuper<Secr&t%>' Run the command to test the policy compliance history API after you create the governance-policy-database Secret . An OpenShift Route object is automatically created in the same namespace. If routes on the Red Hat Advanced Cluster Management hub cluster do not utilize a trusted certificate, you can choose to provide the -k flag in the curl command to skip TLS verification, though this is not recommended: curl -H "Authorization: Bearer USD(oc whoami --show-token)" \ "https://USD(oc -n open-cluster-management get route governance-history-api -o jsonpath='{.spec.host}')/api/v1/compliance-events" If successful, the curl command returns a value similar to the following message: If it is not successful, the curl command might return either of the two messages: If you receive a message, view the Kubernetes events in the open-cluster-management namespace with the following command: oc -n open-cluster-management get events --field-selector reason=OCMComplianceEventsDBError If you receive instructions from the event to view the governance-policy-propagator logs, run the following command: oc -n open-cluster-management logs -l name=governance-policy-propagator -f You might receive an error message that indicates the user, password, or database is incorrectly specified. See the following message example: Update the governance-policy-database Secret resource with the correct PostgreSQL connection settings with the following command: oc -n open-cluster-management edit secret governance-policy-database 2.5.3. Set the compliance history API URL Set the policy compliance history API URL to enable the feature on managed clusters. Complete the following steps: Retrieve the external URL of the policy compliance history API with the following command: echo "https://USD(oc -n open-cluster-management get route governance-history-api -o=jsonpath='{.spec.host}')" The output might resemble the following information, with the domain name of your Red Hat Advanced Cluster Management hub cluster: Create an AddOnDeploymentConfig object similar to the following example: apiVersion: addon.open-cluster-management.io/v1alpha1 kind: AddOnDeploymentConfig metadata: name: governance-policy-framework namespace: open-cluster-management spec: customizedVariables: - name: complianceHistoryAPIURL value: <replace with URL from command> Replace the value parameter value with your compliance history external URL. 2.5.3.1. Enable on all managed clusters Enable the compliance history API on all managed clusters to record compliance events from your managed clusters. Complete the following steps: Configure the governance-policy-framework ClusterManagementAddOn object to use the AddOnDeploymentConfig with the following command: oc edit ClusterManagementAddOn governance-policy-framework Add or update the spec.supportedConfigs array. Your resource might have the following configuration: - group: addon.open-cluster-management.io resource: addondeploymentconfigs defaultConfig: name: governance-policy-framework namespace: open-cluster-management 2.5.3.2. Enable a single managed cluster Enable the compliance history API on a single managed cluster to record compliance events from the managed cluster. Complete the following steps: Configure the governance-policy-framework ManagedClusterAddOn resource in the managed cluster namespace. Run the following command from your Red Hat Advanced Cluster Management hub cluster with the following command: oc -n <manage-cluster-namespace> edit ManagedClusterAddOn governance-policy-framework Replace the <manage-cluster-namespace> placeholder with the managed cluster name you intend to enable. Add or update the spec.configs array to have an entry similar to the following example: - group: addon.open-cluster-management.io resource: addondeploymentconfigs name: governance-policy-framework namespace: open-cluster-management To verify the configuration, confirm that the deployment on your managed cluster is using the --compliance-api-url container argument. Run the following command: oc -n open-cluster-management-agent-addon get deployment governance-policy-framework -o jsonpath='{.spec.template.spec.containers[1].args}' The output might resemble the following: Any new policy compliance events are recorded in the policy compliance history API. If policy compliance events are not being recorded for a specific managed cluster, view the governance-policy-framework logs on the affected managed cluster: oc -n open-cluster-management-agent-addon logs deployment/governance-policy-framework -f Log messages similar to the following message are displayed. If the message value is empty, the policy compliance history API URL is incorrect or there is a network communication issue: If the policy compliance history API URL is incorrect, edit the URL on the hub cluster with the following command: oc -n open-cluster-management edit AddOnDeploymentConfig governance-policy-framework Note: If you experience a network communication issue, you must diagnose the problem based on your network infrastructure. 2.5.4. Additional resource See Policy compliance history API (Technology Preview) . 2.6. Supported policies View the supported policies to learn how to define rules, processes, and controls on the hub cluster when you create and manage policies in Red Hat Advanced Cluster Management for Kubernetes. 2.6.1. Table of sample configuration policies View the following sample configuration policies: Table 2.5. Table list of configuration policies Policy sample Description Namespace policy Ensure consistent environment isolation and naming with Namespaces. See the Kubernetes Namespace documentation . Pod policy Ensure cluster workload configuration. See the Kubernetes Pod documentation . Memory usage policy Limit workload resource usage using Limit Ranges. See the Limit Range documentation . Pod security policy (Deprecated) Ensure consistent workload security. See the Kubernetes Pod security policy documentation . Role policy Role binding policy Manage role permissions and bindings using roles and role bindings. See the Kubernetes RBAC documentation . Security content constraints (SCC) policy Manage workload permissions with Security Context Constraints. See Managing Security Context Constraints documentation in the OpenShift Container Platform documentation. ETCD encryption policy Ensure data security with etcd encryption. See Encrypting etcd data in the OpenShift Container Platform documentation. Compliance operator policy Deploy the Compliance Operator to scan and enforce the compliance state of clusters leveraging OpenSCAP. See Understanding the Compliance Operator in the OpenShift Container Platform documentation. Compliance operator E8 scan After applying the Compliance operator policy, deploy an Essential 8 (E8) scan to check for compliance with E8 security profiles. See Understanding the Compliance Operator in the OpenShift Container Platform documentation. Compliance operator CIS scan After applying the Compliance operator policy, deploy a Center for Internet Security (CIS) scan to check for compliance with CIS security profiles. See Understanding the Compliance Operator in the OpenShift Container Platform documentation. Image vulnerability policy Deploy the Container Security Operator and detect known image vulnerabilities in pods running on the cluster. See the Container Security Operator GitHub repository. Gatekeeper operator deployment Gatekeeper is an admission webhook that enforces custom resource definition-based policies that are run by the Open Policy Agent (OPA) policy engine. See the Gatekeeper documentation. The Gatekeeper operator is available for installing Gatekeeper. For more information, see the Gatekeeper operator overview Gatekeeper compliance policy After deploying Gatekeeper to the clusters, deploy this sample Gatekeeper policy that ensures namespaces that are created on the cluster are labeled as specified. For more information, see Integrating Gatekeeper constraints and constraint templates . Red Hat OpenShift Platform Plus policy set Red Hat OpenShift Platform Plus is a hybrid-cloud suite of products to securely build, deploy, run, and manage applications for multiple infrastructures. You can deploy Red Hat OpenShift Platform Plus to managed clusters using PolicySets delivered through a Red Hat Advanced Cluster Management application. For details on OpenShift Platform Plus, see the documentation for OpenShift Platform Plus . Red Hat OpenShift Container Platform 4.x also supports the Red Hat Advanced Cluster Management configuration policies. View the following policy documentation to learn how policies are applied: Namespace policy Pod policy Memory usage policy Pod security policy Role policy Role binding policy Security context constraints policy ETCD encryption policy Compliance operator policy E8 scan policy OpenShift CIS scan policy Image vulnerability policy Red Hat OpenShift Platform Plus policy set Refer to Governance for more topics. 2.6.2. Namespace policy The Kubernetes configuration policy controller monitors the status of your namespace policy. Apply the namespace policy to define specific rules for your namespace. Learn more details about the namespace policy structure in the following sections: Namespace policy YAML structure Namespace policy table Namespace policy sample 2.6.2.1. Namespace policy YAML structure apiVersion: policy.open-cluster-management.io/v1 kind: Policy metadata: name: namespace: annotations: policy.open-cluster-management.io/standards: policy.open-cluster-management.io/categories: policy.open-cluster-management.io/controls: policy.open-cluster-management.io/description: spec: remediationAction: disabled: policy-templates: - objectDefinition: apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: spec: remediationAction: severity: object-templates: - complianceType: objectDefinition: kind: Namespace apiVersion: v1 metadata: name: ... 2.6.2.2. Namespace policy YAML table Field Optional or required Description apiVersion Required Set the value to policy.open-cluster-management.io/v1 . kind Required Set the value to Policy to indicate the type of policy. metadata.name Required The name for identifying the policy resource. metadata.namespace Required The namespace of the policy. spec.remediationAction Optional Specifies the remediation of your policy. The parameter values are enforce and inform . This value is optional because it overrides any values provided in spec.policy-templates . spec.disabled Required Set the value to true or false . The disabled parameter provides the ability to enable and disable your policies. spec.policy-templates[].objectDefinition Required Used to list configuration policies containing Kubernetes objects that must be evaluated or applied to the managed clusters. 2.6.2.3. Namespace policy sample See policy-namespace.yaml to view the policy sample. See Managing security policies for more details. Refer to Policy overview documentation, and to the Kubernetes configuration policy controller to learn about other configuration policies. 2.6.3. Pod policy The Kubernetes configuration policy controller monitors the status of your pod policies. Apply the pod policy to define the container rules for your pods. A pod must exist in your cluster to use this information. Learn more details about the pod policy structure in the following sections: Pod policy YAML structure Pod policy table Pod policy sample 2.6.3.1. Pod policy YAML structure apiVersion: policy.open-cluster-management.io/v1 kind: Policy metadata: name: namespace: annotations: policy.open-cluster-management.io/standards: policy.open-cluster-management.io/categories: policy.open-cluster-management.io/controls: policy.open-cluster-management.io/description: spec: remediationAction: disabled: policy-templates: - objectDefinition: apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: spec: remediationAction: severity: namespaceSelector: exclude: include: matchLabels: matchExpressions: object-templates: - complianceType: objectDefinition: apiVersion: v1 kind: Pod metadata: name: spec: containers: - image: name: ... 2.6.3.2. Pod policy table Table 2.6. Parameter table Field Optional or required Description apiVersion Required Set the value to policy.open-cluster-management.io/v1 . kind Required Set the value to Policy to indicate the type of policy. metadata.name Required The name for identifying the policy resource. metadata.namespace Required The namespace of the policy. spec.remediationAction Optional Specifies the remediation of your policy. The parameter values are enforce and inform . This value is optional because the value overrides any values provided in spec.policy-templates . spec.disabled Required Set the value to true or false . The disabled parameter provides the ability to enable and disable your policies. spec.policy-templates[].objectDefinition Required Used to list configuration policies containing Kubernetes objects that must be evaluated or applied to the managed clusters. 2.6.3.3. Pod policy sample See policy-pod.yaml to view the policy sample. Refer to Kubernetes configuration policy controller to view other configuration policies that are monitored by the configuration controller, and see the Policy overview documentation to see a full description of the policy YAML structure and additional fields. Return to Managing configuration policies documentation to manage other policies. 2.6.4. Memory usage policy The Kubernetes configuration policy controller monitors the status of the memory usage policy. Use the memory usage policy to limit or restrict your memory and compute usage. For more information, see Limit Ranges in the Kubernetes documentation . Learn more details about the memory usage policy structure in the following sections: Memory usage policy YAML structure Memory usage policy table Memory usage policy sample 2.6.4.1. Memory usage policy YAML structure Your memory usage policy might resemble the following YAML file: apiVersion: policy.open-cluster-management.io/v1 kind: Policy metadata: name: namespace: annotations: policy.open-cluster-management.io/standards: policy.open-cluster-management.io/categories: policy.open-cluster-management.io/controls: policy.open-cluster-management.io/description: spec: remediationAction: disabled: policy-templates: - objectDefinition: apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: spec: remediationAction: severity: namespaceSelector: exclude: include: matchLabels: matchExpressions: object-templates: - complianceType: mustonlyhave objectDefinition: apiVersion: v1 kind: LimitRange metadata: name: spec: limits: - default: memory: defaultRequest: memory: type: ... 2.6.4.2. Memory usage policy table Table 2.7. Parameter table Field Optional or required Description apiVersion Required Set the value to policy.open-cluster-management.io/v1 . kind Required Set the value to Policy to indicate the type of policy. metadata.name Required The name for identifying the policy resource. metadata.namespace Required The namespace of the policy. spec.remediationAction Optional Specifies the remediation of your policy. The parameter values are enforce and inform . This value is optional because the value overrides any values provided in spec.policy-templates . spec.disabled Required Set the value to true or false . The disabled parameter provides the ability to enable and disable your policies. spec.policy-templates[].objectDefinition Required Used to list configuration policies containing Kubernetes objects that must be evaluated or applied to the managed clusters. 2.6.4.3. Memory usage policy sample See the policy-limitmemory.yaml to view a sample of the policy. See Managing security policies for more details. Refer to the Policy overview documentation, and to Kubernetes configuration policy controller to view other configuration policies that are monitored by the controller. 2.6.5. Pod security policy (Deprecated) The Kubernetes configuration policy controller monitors the status of the pod security policy. Apply a pod security policy to secure pods and containers. Learn more details about the pod security policy structure in the following sections: Pod security policy YAML structure Pod security policy table Pod security policy sample 2.6.5.1. Pod security policy YAML structure apiVersion: policy.open-cluster-management.io/v1 kind: Policy metadata: name: namespace: annotations: policy.open-cluster-management.io/standards: policy.open-cluster-management.io/categories: policy.open-cluster-management.io/controls: policy.open-cluster-management.io/description: spec: remediationAction: disabled: policy-templates: - objectDefinition: apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: spec: remediationAction: severity: namespaceSelector: exclude: include: matchLabels: matchExpressions: object-templates: - complianceType: objectDefinition: apiVersion: policy/v1beta1 kind: PodSecurityPolicy metadata: name: annotations: seccomp.security.alpha.kubernetes.io/allowedProfileNames: spec: privileged: allowPrivilegeEscalation: allowedCapabilities: volumes: hostNetwork: hostPorts: hostIPC: hostPID: runAsUser: seLinux: supplementalGroups: fsGroup: ... 2.6.5.2. Pod security policy table Table 2.8. Parameter table Field Optional or required Description apiVersion Required Set the value to policy.open-cluster-management.io/v1 . kind Required Set the value to Policy to indicate the type of policy. metadata.name Required The name for identifying the policy resource. metadata.namespace Required The namespace of the policy. spec.remediationAction Optional Specifies the remediation of your policy. The parameter values are enforce and inform . This value is optional because the value overrides any values provided in spec.policy-templates . spec.disabled Required Set the value to true or false . The disabled parameter provides the ability to enable and disable your policies. spec.policy-templates[].objectDefinition Required Used to list configuration policies containing Kubernetes objects that must be evaluated or applied to the managed clusters. 2.6.5.3. Pod security policy sample The support of pod security policies is removed from OpenShift Container Platform and from Kubernetes v1.25 and later. If you apply a PodSecurityPolicy resource, you might receive the following non-compliant message: For more information including the deprecation notice, see Pod Security Policies in the Kubernetes documentation . See policy-psp.yaml to view the sample policy. View Managing configuration policies for more information. Refer to the Policy overview documentation for a full description of the policy YAML structure, and Kubernetes configuration policy controller to view other configuration policies that are monitored by the controller. 2.6.6. Role policy The Kubernetes configuration policy controller monitors the status of role policies. Define roles in the object-template to set rules and permissions for specific roles in your cluster. Learn more details about the role policy structure in the following sections: Role policy YAML structure Role policy table Role policy sample 2.6.6.1. Role policy YAML structure apiVersion: policy.open-cluster-management.io/v1 kind: Policy metadata: name: namespace: annotations: policy.open-cluster-management.io/standards: policy.open-cluster-management.io/categories: policy.open-cluster-management.io/controls: policy.open-cluster-management.io/description: spec: remediationAction: disabled: policy-templates: - objectDefinition: apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: spec: remediationAction: severity: namespaceSelector: exclude: include: matchLabels: matchExpressions: object-templates: - complianceType: objectDefinition: apiVersion: rbac.authorization.k8s.io/v1 kind: Role metadata: name: rules: - apiGroups: resources: verbs: ... 2.6.6.2. Role policy table Table 2.9. Parameter table Field Optional or required Description apiVersion Required Set the value to policy.open-cluster-management.io/v1 . kind Required Set the value to Policy to indicate the type of policy. metadata.name Required The name for identifying the policy resource. metadata.namespace Required The namespace of the policy. spec.remediationAction Optional Specifies the remediation of your policy. The parameter values are enforce and inform . This value is optional because the value overrides any values provided in spec.policy-templates . spec.disabled Required Set the value to true or false . The disabled parameter provides the ability to enable and disable your policies. spec.policy-templates[].objectDefinition Required Used to list configuration policies containing Kubernetes objects that must be evaluated or applied to the managed clusters. 2.6.6.3. Role policy sample Apply a role policy to set rules and permissions for specific roles in your cluster. For more information on roles, see Role-based access control . View a sample of a role policy, see policy-role.yaml . To learn how to manage role policies, refer to Managing configuration policies for more information. See the Kubernetes configuration policy controller to view other configuration policies that are monitored the controller. 2.6.7. Role binding policy The Kubernetes configuration policy controller monitors the status of your role binding policy. Apply a role binding policy to bind a policy to a namespace in your managed cluster. Learn more details about the namespace policy structure in the following sections: Role binding policy YAML structure Role binding policy table Role binding policy sample 2.6.7.1. Role binding policy YAML structure apiVersion: policy.open-cluster-management.io/v1 kind: Policy metadata: name: namespace: annotations: policy.open-cluster-management.io/standards: policy.open-cluster-management.io/categories: policy.open-cluster-management.io/controls: policy.open-cluster-management.io/description: spec: remediationAction: disabled: policy-templates: - objectDefinition: apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: spec: remediationAction: severity: namespaceSelector: exclude: include: matchLabels: matchExpressions: object-templates: - complianceType: objectDefinition: kind: RoleBinding # role binding must exist apiVersion: rbac.authorization.k8s.io/v1 metadata: name: subjects: - kind: name: apiGroup: roleRef: kind: name: apiGroup: ... 2.6.7.2. Role binding policy table Field Optional or required Description apiVersion Required Set the value to policy.open-cluster-management.io/v1 . kind Required Set the value to Policy to indicate the type of policy. metadata.name Required The name for identifying the policy resource. metadata.namespace Required The namespace of the policy. spec.remediationAction Optional Specifies the remediation of your policy. The parameter values are enforce and inform . This value is optional since it overrides any values provided in spec.policy-templates . spec.disabled Required Set the value to true or false . The disabled parameter provides the ability to enable and disable your policies. spec.policy-templates[].objectDefinition Required Used to list configuration policies containing Kubernetes objects that must be evaluated or applied to the managed clusters. 2.6.7.3. Role binding policy sample See policy-rolebinding.yaml to view the policy sample. For a full description of the policy YAML structure and additional fields, see the Policy overview documentation . Refer to Kubernetes configuration policy controller documentation to learn about other configuration policies. 2.6.8. Security Context Constraints policy The Kubernetes configuration policy controller monitors the status of your Security Context Constraints (SCC) policy. Apply an Security Context Constraints (SCC) policy to control permissions for pods by defining conditions in the policy. Learn more details about SCC policies in the following sections: SCC policy YAML structure SCC policy table SCC policy sample 2.6.8.1. SCC policy YAML structure apiVersion: policy.open-cluster-management.io/v1 kind: Policy metadata: name: namespace: annotations: policy.open-cluster-management.io/standards: policy.open-cluster-management.io/categories: policy.open-cluster-management.io/controls: policy.open-cluster-management.io/description: spec: remediationAction: disabled: policy-templates: - objectDefinition: apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: spec: remediationAction: severity: namespaceSelector: exclude: include: matchLabels: matchExpressions: object-templates: - complianceType: objectDefinition: apiVersion: security.openshift.io/v1 kind: SecurityContextConstraints metadata: name: allowHostDirVolumePlugin: allowHostIPC: allowHostNetwork: allowHostPID: allowHostPorts: allowPrivilegeEscalation: allowPrivilegedContainer: fsGroup: readOnlyRootFilesystem: requiredDropCapabilities: runAsUser: seLinuxContext: supplementalGroups: users: volumes: ... 2.6.8.2. SCC policy table Field Optional or required Description apiVersion Required Set the value to policy.open-cluster-management.io/v1 . kind Required Set the value to Policy to indicate the type of policy. metadata.name Required The name for identifying the policy resource. metadata.namespace Required The namespace of the policy. spec.remediationAction Optional Specifies the remediation of your policy. The parameter values are enforce and inform . This value is optional since it overrides any values provided in spec.policy-templates . spec.disabled Required Set the value to true or false . The disabled parameter provides the ability to enable and disable your policies. spec.policy-templates[].objectDefinition Required Used to list configuration policies containing Kubernetes objects that must be evaluated or applied to the managed clusters. For explanations on the contents of a SCC policy, see Managing Security Context Constraints from the OpenShift Container Platform documentation. 2.6.8.3. SCC policy sample Apply a Security context constraints (SCC) policy to control permissions for pods by defining conditions in the policy. For more information, see Managing Security Context Constraints (SCC) . See policy-scc.yaml to view the policy sample. For a full description of the policy YAML structure and additional fields, see the Policy overview documentation. Refer to Kubernetes configuration policy controller documentation to learn about other configuration policies. 2.6.9. ETCD encryption policy Apply the etcd-encryption policy to detect, or enable encryption of sensitive data in the ETCD data-store. The Kubernetes configuration policy controller monitors the status of the etcd-encryption policy. For more information, see Encrypting etcd data in the OpenShift Container Platform documentation. Note: The ETCD encryption policy only supports Red Hat OpenShift Container Platform 4 and later. Learn more details about the etcd-encryption policy structure in the following sections: ETCD encryption policy YAML structure ETCD encryption policy table ETCD encryption policy sample 2.6.9.1. ETCD encryption policy YAML structure Your etcd-encryption policy might resemble the following YAML file: apiVersion: policy.open-cluster-management.io/v1 kind: Policy metadata: name: namespace: annotations: policy.open-cluster-management.io/standards: policy.open-cluster-management.io/categories: policy.open-cluster-management.io/controls: policy.open-cluster-management.io/description: spec: remediationAction: disabled: policy-templates: - objectDefinition: apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: spec: remediationAction: severity: object-templates: - complianceType: objectDefinition: apiVersion: config.openshift.io/v1 kind: APIServer metadata: name: spec: encryption: ... 2.6.9.2. ETCD encryption policy table Table 2.10. Parameter table Field Optional or required Description apiVersion Required Set the value to policy.open-cluster-management.io/v1 . kind Required Set the value to Policy to indicate the type of policy. metadata.name Required The name for identifying the policy resource. metadata.namespace Required The namespace of the policy. spec.remediationAction Optional Specifies the remediation of your policy. The parameter values are enforce and inform . This value is optional because it overrides any values provided in spec.policy-templates . spec.disabled Required Set the value to true or false . The disabled parameter provides the ability to enable and disable your policies. spec.policy-templates[].objectDefinition Required Used to list configuration policies containing Kubernetes objects that must be evaluated or applied to the managed clusters. 2.6.9.3. ETCD encryption policy sample See policy-etcdencryption.yaml for the policy sample. See the Policy overview documentation and the Kubernetes configuration policy controller to view additional details on policy and configuration policy fields. 2.6.10. Compliance Operator policy You can use the Compliance Operator to automate the inspection of numerous technical implementations and compare those against certain aspects of industry standards, benchmarks, and baselines. The Compliance Operator is not an auditor. To be compliant or certified with these various standards, you need to engage an authorized auditor such as a Qualified Security Assessor (QSA), Joint Authorization Board (JAB), or other industry recognized regulatory authority to assess your environment. Recommendations that are generated from the Compliance Operator are based on generally available information and practices regarding such standards, and might assist you with remediations, but actual compliance is your responsibility. Work with an authorized auditor to achieve compliance with a standard. For the latest updates, see the Compliance Operator release notes . 2.6.10.1. Compliance Operator policy overview You can install the Compliance Operator on your managed cluster by using the Compliance Operator policy. The Compliance operator policy is created as a Kubernetes configuration policy in Red Hat Advanced Cluster Management. OpenShift Container Platform supports the compliance operator policy. Note: The Compliance operator policy relies on the OpenShift Container Platform Compliance Operator, which is not supported on the IBM Power or IBM Z architectures. See Understanding the Compliance Operator in the OpenShift Container Platform documentation for more information about the Compliance Operator. 2.6.10.2. Compliance operator resources When you create a compliance operator policy, the following resources are created: A compliance operator namespace ( openshift-compliance ) for the operator installation: apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: comp-operator-ns spec: remediationAction: inform # will be overridden by remediationAction in parent policy severity: high object-templates: - complianceType: musthave objectDefinition: apiVersion: v1 kind: Namespace metadata: name: openshift-compliance An operator group ( compliance-operator ) to specify the target namespace: apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: comp-operator-operator-group spec: remediationAction: inform # will be overridden by remediationAction in parent policy severity: high object-templates: - complianceType: musthave objectDefinition: apiVersion: operators.coreos.com/v1 kind: OperatorGroup metadata: name: compliance-operator namespace: openshift-compliance spec: targetNamespaces: - openshift-compliance A subscription ( comp-operator-subscription ) to reference the name and channel. The subscription pulls the profile, as a container, that it supports. See the following sample, with the current version replacing 4.x : apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: comp-operator-subscription spec: remediationAction: inform # will be overridden by remediationAction in parent policy severity: high object-templates: - complianceType: musthave objectDefinition: apiVersion: operators.coreos.com/v1alpha1 kind: Subscription metadata: name: compliance-operator namespace: openshift-compliance spec: channel: "4.x" installPlanApproval: Automatic name: compliance-operator source: redhat-operators sourceNamespace: openshift-marketplace After you install the compliance operator policy, the following pods are created: compliance-operator , ocp4 , and rhcos4 . See a sample of the policy-compliance-operator-install.yaml . 2.6.10.3. Additional resources For more information, see Managing the Compliance Operator in the OpenShift Container Platform documentation for more details. You can also create and apply the E8 scan policy and OpenShift CIS scan policy, after you have installed the compliance operator. For more information, see E8 scan policy and OpenShift CIS scan policy . To learn about managing compliance operator policies, see Managing security policies for more details. Refer to Kubernetes configuration policy controller for more topics about configuration policies. 2.6.11. E8 scan policy An Essential 8 (E8) scan policy deploys a scan that checks the master and worker nodes for compliance with the E8 security profiles. You must install the compliance operator to apply the E8 scan policy. The E8 scan policy is created as a Kubernetes configuration policy in Red Hat Advanced Cluster Management. OpenShift Container Platform supports the E8 scan policy. For more information, see Managing the Compliance Operator in the OpenShift Container Platform documentation for more details. 2.6.11.1. E8 scan policy resources When you create an E8 scan policy the following resources are created: A ScanSettingBinding resource ( e8 ) to identify which profiles to scan: apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: compliance-suite-e8 spec: remediationAction: inform severity: high object-templates: - complianceType: musthave # this template checks if scan has completed by checking the status field objectDefinition: apiVersion: compliance.openshift.io/v1alpha1 kind: ScanSettingBinding metadata: name: e8 namespace: openshift-compliance profiles: - apiGroup: compliance.openshift.io/v1alpha1 kind: Profile name: ocp4-e8 - apiGroup: compliance.openshift.io/v1alpha1 kind: Profile name: rhcos4-e8 settingsRef: apiGroup: compliance.openshift.io/v1alpha1 kind: ScanSetting name: default A ComplianceSuite resource ( compliance-suite-e8 ) to verify if the scan is complete by checking the status field: apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: compliance-suite-e8 spec: remediationAction: inform severity: high object-templates: - complianceType: musthave # this template checks if scan has completed by checking the status field objectDefinition: apiVersion: compliance.openshift.io/v1alpha1 kind: ComplianceSuite metadata: name: e8 namespace: openshift-compliance status: phase: DONE A ComplianceCheckResult resource ( compliance-suite-e8-results ) which reports the results of the scan suite by checking the ComplianceCheckResult custom resources (CR): apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: compliance-suite-e8-results spec: remediationAction: inform severity: high object-templates: - complianceType: mustnothave # this template reports the results for scan suite: e8 by looking at ComplianceCheckResult CRs objectDefinition: apiVersion: compliance.openshift.io/v1alpha1 kind: ComplianceCheckResult metadata: namespace: openshift-compliance labels: compliance.openshift.io/check-status: FAIL compliance.openshift.io/suite: e8 Note: Automatic remediation is supported. Set the remediation action to enforce to create ScanSettingBinding resource. See a sample of the policy-compliance-operator-e8-scan.yaml . See Managing security policies for more information. Note: After your E8 policy is deleted, it is removed from your target cluster or clusters. 2.6.12. OpenShift CIS scan policy An OpenShift CIS scan policy deploys a scan that checks the master and worker nodes for compliance with the OpenShift CIS security benchmark. You must install the compliance operator to apply the OpenShift CIS policy. The OpenShift CIS scan policy is created as a Kubernetes configuration policy in Red Hat Advanced Cluster Management. OpenShift Container Platform supports the OpenShift CIS scan policy. For more information, see Understanding the Compliance Operator in the OpenShift Container Platform documentation for more details. 2.6.12.1. OpenShift CIS resources When you create an OpenShift CIS scan policy the following resources are created: A ScanSettingBinding resource ( cis ) to identify which profiles to scan: apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: compliance-cis-scan spec: remediationAction: inform severity: high object-templates: - complianceType: musthave # this template creates ScanSettingBinding:cis objectDefinition: apiVersion: compliance.openshift.io/v1alpha1 kind: ScanSettingBinding metadata: name: cis namespace: openshift-compliance profiles: - apiGroup: compliance.openshift.io/v1alpha1 kind: Profile name: ocp4-cis - apiGroup: compliance.openshift.io/v1alpha1 kind: Profile name: ocp4-cis-node settingsRef: apiGroup: compliance.openshift.io/v1alpha1 kind: ScanSetting name: default A ComplianceSuite resource ( compliance-suite-cis ) to verify if the scan is complete by checking the status field: apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: compliance-suite-cis spec: remediationAction: inform severity: high object-templates: - complianceType: musthave # this template checks if scan has completed by checking the status field objectDefinition: apiVersion: compliance.openshift.io/v1alpha1 kind: ComplianceSuite metadata: name: cis namespace: openshift-compliance status: phase: DONE A ComplianceCheckResult resource ( compliance-suite-cis-results ) which reports the results of the scan suite by checking the ComplianceCheckResult custom resources (CR): apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: compliance-suite-cis-results spec: remediationAction: inform severity: high object-templates: - complianceType: mustnothave # this template reports the results for scan suite: cis by looking at ComplianceCheckResult CRs objectDefinition: apiVersion: compliance.openshift.io/v1alpha1 kind: ComplianceCheckResult metadata: namespace: openshift-compliance labels: compliance.openshift.io/check-status: FAIL compliance.openshift.io/suite: cis See a sample of the policy-compliance-operator-cis-scan.yaml file. For more information on creating policies, see Managing security policies . 2.6.13. Image vulnerability policy Apply the image vulnerability policy to detect if container images have vulnerabilities by leveraging the Container Security Operator. The policy installs the Container Security Operator on your managed cluster if it is not installed. The image vulnerability policy is checked by the Kubernetes configuration policy controller. For more information about the Security Operator, see the Container Security Operator from the Quay repository . Notes: Image vulnerability policy is not functional during a disconnected installation. The Image vulnerability policy is not supported on the IBM Power and IBM Z architectures. It relies on the Quay Container Security Operator . There are no ppc64le or s390x images in the container-security-operator registry . View the following sections to learn more: Image vulnerability policy YAML structure Image vulnerability policy sample 2.6.13.1. Image vulnerability policy YAML structure When you create the container security operator policy, it involves the following policies: A policy that creates the subscription ( container-security-operator ) to reference the name and channel. This configuration policy must have spec.remediationAction set to enforce to create the resources. The subscription pulls the profile, as a container, that the subscription supports. View the following example: apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: policy-imagemanifestvuln-example-sub spec: remediationAction: enforce # will be overridden by remediationAction in parent policy severity: high object-templates: - complianceType: musthave objectDefinition: apiVersion: operators.coreos.com/v1alpha1 kind: Subscription metadata: name: container-security-operator namespace: openshift-operators spec: # channel: quay-v3.3 # specify a specific channel if desired installPlanApproval: Automatic name: container-security-operator source: redhat-operators sourceNamespace: openshift-marketplace An inform configuration policy to audit the ClusterServiceVersion to ensure that the container security operator installation succeeded. View the following example: apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: policy-imagemanifestvuln-status spec: remediationAction: inform # will be overridden by remediationAction in parent policy severity: high object-templates: - complianceType: musthave objectDefinition: apiVersion: operators.coreos.com/v1alpha1 kind: ClusterServiceVersion metadata: namespace: openshift-operators spec: displayName: Red Hat Quay Container Security Operator status: phase: Succeeded # check the CSV status to determine if operator is running or not An inform configuration policy to audit whether any ImageManifestVuln objects were created by the image vulnerability scans. View the following example: apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: policy-imagemanifestvuln-example-imv spec: remediationAction: inform # will be overridden by remediationAction in parent policy severity: high namespaceSelector: exclude: ["kube-*"] include: ["*"] object-templates: - complianceType: mustnothave # mustnothave any ImageManifestVuln object objectDefinition: apiVersion: secscan.quay.redhat.com/v1alpha1 kind: ImageManifestVuln # checking for a Kind 2.6.13.2. Image vulnerability policy sample See policy-imagemanifestvuln.yaml . See Managing security policies for more information. Refer to Kubernetes configuration policy controller to view other configuration policies that are monitored by the configuration controller. 2.6.14. Red Hat OpenShift Platform Plus policy set Configure and apply the OpenShift Platform Plus policy set ( openshift-plus ) to install Red Hat OpenShift Platform Plus. The OpenShift Platform Plus policy set contains two PolicySets that are deployed. The OpenShift Plus policy set applies multiple policies that are set to install OpenShift Platform Plus products. The Red Hat Advanced Cluster Security secured cluster services and the Compliance Operator are deployed onto all of your OpenShift Container Platform managed clusters. 2.6.14.1. Prerequisites Install Red Hat OpenShift Container Platform on Amazon Web Services (AWS) environment. Install Red Hat Advanced Cluster Management for Kubernetes. Install the Policy Generator Kustomize plugin. See the Policy Generator documentation for more information. 2.6.14.2. OpenShift Platform Plus policy set components When you apply the policy set to the hub cluster, the following OpenShift Platform Plus components are installed: Table 2.11. Component table Component Policy Description Red Hat Advanced Cluster Security policy-acs-central-ca-bundle Policy used to install the central server onto the Red Hat Advanced Cluster Management for Kubernetes hub cluster and the managed clusters. policy-acs-central-status Deployments to receive Red Hat Advanced Cluster Security status. policy-acs-operator-central Configuration for the Red Hat Advanced Cluster Security central operator. policy-acs-sync-resources Policy used to verify that the Red Hat Advanced Cluster Security resources are created. OpenShift Container Platform policy-advanced-managed-cluster-status The managed hub cluster. Manager of the managed cluster. Compliance operator policy-compliance-operator-install Policy used to install the Compliance operator. Red Hat Quay policy-config-quay Configuration policy for Red Hat Quay. policy-install-quay Policy used to install Red Hat Quay. policy-quay-status Installed onto the Red Hat Advanced Cluster Management hub cluster. Red Hat Advanced Cluster Management policy-ocm-observability Sets up the Red Hat Advanced Cluster Management observability service. Red Hat OpenShift Data Platform policy-odf Available storage for the hub cluster components that is used by Red Hat Advanced Cluster Management observability and Quay. policy-odf-status Policy used to configure the Red Hat OpenShift Data Platform status. 2.6.14.3. Additional resources See Installing Red Hat OpenShift Platform Plus by using a policy set . Return to Policy set controller . View the openshift-plus policy set sample for all of the policies included in the policy set. 2.7. Manage Governance dashboard Manage your security policies and policy violations by using the Governance dashboard to create, view, and edit your resources. You can create YAML files for your policies from the command line and console. Continue reading for details about the Governance dashboard from the console. 2.7.1. Governance page The following tabs are displayed on the Governance page Overview , Policy sets , and Policies . Read the following descriptions to know which information is displayed: Overview The following summary cards are displayed from the Overview tab: Policy set violations , Policy violations , Clusters , Categories , Controls , and Standards . Policy sets Create and manage hub cluster policy sets. Policies Create and manage security policies. The table of policies list the following details of a policy: Name , Namespace , and Cluster violations are displayed. You can edit, enable or disable, set remediation to inform or enforce, or remove a policy by selecting the Actions icon. You can view the categories and standards of a specific policy by selecting the drop-down arrow to expand the row. Reorder your table columns in the Manage column dialog box. Select the Manage column icon for the dialog box to be displayed. To reorder your columns, select the Reorder icon and move the column name. For columns that you want to appear in the table, click the checkbox for specific column names and select the Save button. Complete bulk actions by selecting multiple policies and clicking the Actions button. You can also customize your policy table by clicking the Filter button. When you select a policy in the table list, the following tabs of information are displayed from the console: Details : Select the Details tab to view policy details and placement details. In the Placement table, the Compliance column provides links to view the compliance of the clusters that are displayed. Results : Select the Results tab to view a table list of all clusters that are associated to the policy. From the Message column, click the View details link to view the template details, template YAML, and related resources. You can also view related resources. Click the View history link to view the violation message and a time of the last report. 2.7.2. Governance automation configuration If there is a configured automation for a specific policy, you can select the automation to view more details. View the following descriptions of the schedule frequency options for your automation: Manual run : Manually set this automation to run once. After the automation runs, it is set to disabled . Note: You can only select Manual run mode when the schedule frequency is disabled. Run once mode : When a policy is violated, the automation runs one time. After the automation runs, it is set to disabled . After the automation is set to disabled , you must continue to run the automation manually. When you run once mode , the extra variable of target_clusters is automatically supplied with the list of clusters that violated the policy. The Ansible Automation Platform Job template must have PROMPT ON LAUNCH enabled for the EXTRA VARIABLES section (also known as extra_vars ). Run everyEvent mode : When a policy is violated, the automation runs every time for each unique policy violation per managed cluster. Use the DelayAfterRunSeconds parameter to set the minimum seconds before an automation can be restarted on the same cluster. If the policy is violated multiple times during the delay period and kept in the violated state, the automation runs one time after the delay period. The default is 0 seconds and is only applicable for the everyEvent mode. When you run everyEvent mode, the extra variable of target_clusters and Ansible Automation Platform Job template is the same as once mode . Disable automation : When the scheduled automation is set to disabled , the automation does not run until the setting is updated. The following variables are automatically provided in the extra_vars of the Ansible Automation Platform Job: policy_name : The name of the non-compliant root policy that initiates the Ansible Automation Platform job on the hub cluster. policy_namespace : The namespace of the root policy. hub_cluster : The name of the hub cluster, which is determined by the value in the clusters DNS object. policy_sets : This parameter contains all associated policy set names of the root policy. If the policy is not within a policy set, the policy_set parameter is empty. policy_violations : This parameter contains a list of non-compliant cluster names, and the value is the policy status field for each non-compliant cluster. 2.7.3. Additional resources Review the following topics to learn more about creating and updating your security policies: Managing security policies Managing configuration policies Configuring Ansible Automation Platform for governance Governance 2.7.4. Configuring Ansible Automation Platform for governance Red Hat Advanced Cluster Management for Kubernetes governance can be integrated with Red Hat Ansible Automation Platform to create policy violation automations. You can configure the automation from the Red Hat Advanced Cluster Management console. Prerequisites Creating a policy violation automation from the console Creating a policy violation automation from the CLI 2.7.4.1. Prerequisites A supported OpenShift Container Platform version You must have Ansible Automation Platform version 3.7.3 or a later version installed. It is best practice to install the latest supported version of Ansible Automation Platform. See Red Hat Ansible Automation Platform documentation for more details. Install the Ansible Automation Platform Resource Operator from the Operator Lifecycle Manager. In the Update Channel section, select stable-2.x-cluster-scoped . Select the All namespaces on the cluster (default) installation mode. Note: Ensure that the Ansible Automation Platform job template is idempotent when you run it. If you do not have Ansible Automation Platform Resource Operator, you can find it from the Red Hat OpenShift Container Platform OperatorHub page. For more information about installing and configuring Red Hat Ansible Automation Platform, see Setting up Ansible tasks . 2.7.4.2. Creating a policy violation automation from the console After you log in to your Red Hat Advanced Cluster Management hub cluster, select Governance from the navigation menu, and then click on the Policies tab to view the policy tables. Configure an automation for a specific policy by clicking Configure in the Automation column. You can create automation when the policy automation panel appears. From the Ansible credential section, click the drop-down menu to select an Ansible credential. If you need to add a credential, see Managing credentials overview . Note: This credential is copied to the same namespace as the policy. The credential is used by the AnsibleJob resource that is created to initiate the automation. Changes to the Ansible credential in the Credentials section of the console is automatically updated. After a credential is selected, click the Ansible job drop-down list to select a job template. In the Extra variables section, add the parameter values from the extra_vars section of the PolicyAutomation . Select the frequency of the automation. You can select Run once mode , Run everyEvent mode , or Disable automation . Save your policy violation automation by selecting Submit . When you select the View Job link from the Ansible job details side panel, the link directs you to the job template on the Search page. After you successfully create the automation, it is displayed in the Automation column. Note: When you delete a policy that has an associated policy automation, the policy automation is automatically deleted as part of clean up. Your policy violation automation is created from the console. 2.7.4.3. Creating a policy violation automation from the CLI Complete the following steps to configure a policy violation automation from the CLI: From your terminal, log in to your Red Hat Advanced Cluster Management hub cluster using the oc login command. Find or create a policy that you want to add an automation to. Note the policy name and namespace. Create a PolicyAutomation resource using the following sample as a guide: apiVersion: policy.open-cluster-management.io/v1beta1 kind: PolicyAutomation metadata: name: policyname-policy-automation spec: automationDef: extra_vars: your_var: your_value name: Policy Compliance Template secret: ansible-tower type: AnsibleJob mode: disabled policyRef: policyname The Automation template name in the sample is Policy Compliance Template . Change that value to match your job template name. In the extra_vars section, add any parameters you need to pass to the Automation template. Set the mode to either once , everyEvent , or disabled . Set the policyRef to the name of your policy. Create a secret in the same namespace as this PolicyAutomation resource that contains the Ansible Automation Platform credential. In the example, the secret name is ansible-tower . Use the sample from application lifecycle to see how to create the secret. Create the PolicyAutomation resource. Notes: An immediate run of the policy automation can be initiated by adding the following annotation to the PolicyAutomation resource: metadata: annotations: policy.open-cluster-management.io/rerun: "true" When the policy is in once mode, the automation runs when the policy is non-compliant. The extra_vars variable, named target_clusters is added and the value is an array of each managed cluster name where the policy is non-compliant. When the policy is in everyEvent mode and the DelayAfterRunSeconds exceeds the defined time value, the policy is non-compliant and the automation runs for every policy violation. 2.8. Template processing Configuration policies and operator policies support the inclusion of Golang text templates. These templates are resolved at runtime either on the hub cluster or the target managed cluster using configurations related to that cluster. This gives you the ability to define policies with dynamic content, and inform or enforce Kubernetes resources that are customized to the target cluster. A policy definition can contain both hub cluster and managed cluster templates. Hub cluster templates are processed first on the hub cluster, then the policy definition with resolved hub cluster templates is propagated to the target clusters. A controller on the managed cluster processes any managed cluster templates in the policy definition and then enforces or verifies the fully resolved object definition. The template must conform to the Golang template language specification, and the resource definition generated from the resolved template must be a valid YAML. See the Golang documentation about Package templates for more information. Any errors in template validation are recognized as policy violations. When you use a custom template function, the values are replaced at runtime. Important: If you use hub cluster templates to propagate secrets or other sensitive data, the sensitive data exists in the managed cluster namespace on the hub cluster and on the managed clusters where that policy is distributed. The template content is expanded in the policy, and policies are not encrypted by the OpenShift Container Platform ETCD encryption support. To address this, use fromSecret or copySecretData , which automatically encrypts the values from the secret, or protect to encrypt other values. When you add multiline string values such as, certificates, always add | toRawJson | toLiteral syntax at the end of the template pipeline to handle line breaks. For example, if you are copying a certificate from a Secret resource and including it in a ConfigMap resource, your template pipeline might be similar to the following syntax: The toRawJson template function converts the input value to a JSON string with new lines escaped to not affect the YAML structure. The toLiteral template function removes the outer single quotes from the output. For example, when templates are processed for the key: '{{ 'hello\nworld' | toRawJson }}' template pipeline, the output is key: '"hello\nworld"' . The output of the key: '{{ 'hello\nworld' | toRawJson | toLiteral }}' template pipeline is key: "hello\nworld" . See the following table for a comparison of hub cluster and managed cluster templates: 2.8.1. Comparison of hub cluster and managed cluster templates Table 2.12. Comparison table Templates Hub cluster Managed cluster Syntax Golang text template specification Golang text template specification Delimiter {{hub ... hub}} {{ ... }} Context A .ManagedClusterName variable is available, which at runtime, resolves to the name of the target cluster where the policy is propagated. The .ManagedClusterLabels variable is also available, which resolves to a map of keys and values of the labels on the managed cluster where the policy is propagated. No context variables Access control You can only reference namespaced Kubernetes objects that are in the same namespace as the Policy resource. You can reference any resource on the cluster. Functions A set of template functions that support dynamic access to Kubernetes resources and string manipulation. See Template functions for more information. See the Access control row for lookup restrictions. The fromSecret template function on the hub cluster stores the resulting value as an encrypted string on the replicated policy, in the managed cluster namespace. The equivalent call might use the following syntax: {{hub "(lookup "v1" "Secret" "default" "my-hub-secret").data.message | protect hub}} A set of template functions support dynamic access to Kubernetes resources and string manipulation. See Template functions for more information. Function output storage The output of template functions are stored in Policy resource objects in each applicable managed cluster namespace on the hub cluster, before it is synced to the managed cluster. This means that any sensitive results from template functions are readable by anyone with read access to the Policy resource objects on the hub cluster, and anyone with read access to the ConfigurationPolicy or OperatorPolicy resource objects on the managed clusters. Additionally, if etcd encryption is enabled, the policy resource objects are not encrypted. It is best to carefully consider this when using template functions that return sensitive output (e.g. from a secret). The output of template functions are not stored in policy related resource objects. Processing Processing occurs at runtime on the hub cluster during propagation of replicated policies to clusters. Policies and the hub cluster templates within the policies are processed on the hub cluster only when templates are created or updated. Processing occurs on the managed cluster. Configuration policies are processed periodically, which automatically updates the resolved object definition with data in the referenced resources. Operator policies automatically update whenever a referenced resource changes. Processing errors Errors from the hub cluster templates are displayed as violations on the managed clusters the policy applies to. Errors from the managed cluster templates are displayed as violations on the specific target cluster where the violation occurred. Continue reading the following topics: Template functions Advanced template processing in configuration policies 2.8.2. Template functions Reference Kubernetes resources such as resource-specific and generic template functions on your hub cluster by using the {{hub ... hub}} delimiters, or on your managed cluster by using the {{ ... }} delimiters. You can use resource-specific functions for convenience and to make the content of your resources more accessible. 2.8.2.1. Template function descriptions If you use the generic function, lookup , which is more advanced, familiarize yourself with the YAML structure of the resource that is being looked up. In addition to these functions, utility functions such as base64enc , base64dec , indent , autoindent , toInt , toBool , and more are available. To conform templates with YAML syntax, you must define templates in the policy resource as strings using quotes or a block character ( | or > ). This causes the resolved template value to also be a string. To override this, use toInt or toBool as the final function in the template to initiate further processing that forces the value to be interpreted as an integer or boolean respectively. Continue reading to view the descriptions and examples for some of the custom template functions that are supported: fromSecret fromConfigMap fromClusterClaim lookup base64enc base64dec indent autoindent toInt toBool protect toLiteral copySecretData copyConfigMapData Sprig open source 2.8.2.1.1. fromSecret The fromSecret function returns the value of the given data key in the secret. View the following syntax for the function: When you use this function, enter the namespace, name, and data key of a Kubernetes Secret resource. You must use the same namespace that is used for the policy when using the function in a hub cluster template. See Template processing for more details. View the following configuration policy that enforces a Secret resource on the target cluster: apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: demo-fromsecret namespace: test spec: namespaceSelector: exclude: - kube-* include: - default object-templates: - complianceType: musthave objectDefinition: apiVersion: v1 data: 1 USER_NAME: YWRtaW4= PASSWORD: '{{ fromSecret "default" "localsecret" "PASSWORD" }}' 2 kind: Secret 3 metadata: name: demosecret namespace: test type: Opaque remediationAction: enforce severity: low 1 When you use this function with hub cluster templates, the output is automatically encrypted using the protect function. 2 The value for the PASSWORD data key is a template that references the secret on the target cluster. 3 You receive a policy violation if the Kubernetes Secret resource does not exist on the target cluster. If the data key does not exist on the target cluster, the value becomes an empty string. Important: When you add multiline string values such as, certificates, always add | toRawJson | toLiteral syntax at the end of the template pipeline to handle line breaks. For example, if you are copying a certificate from a Secret resource and including it in a ConfigMap resource, your template pipeline might be similar to the following syntax: The toRawJson template function converts the input value to a JSON string with new lines escaped to not affect the YAML structure. The toLiteral template function removes the outer single quotes from the output. For example, when templates are processed for the key: '{{ 'hello\nworld' | toRawJson }}' template pipeline, the output is key: '"hello\nworld"' . The output of the key: '{{ 'hello\nworld' | toRawJson | toLiteral }}' template pipeline is key: "hello\nworld" . 2.8.2.1.2. fromConfigmap The fromConfigMap function returns the value of the given data key in the config map. When you use this function, enter the namespace, name, and data key of a Kubernetes ConfigMap resource. You must use the same namespace that is used for the policy using the function in a hub cluster template. See Template processing for more details. View the following syntax for the function: View the following configuration policy that enforces a Kubernetes resource on the target managed cluster: apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: demo-fromcm-lookup namespace: test-templates spec: namespaceSelector: exclude: - kube-* include: - default object-templates: - complianceType: musthave objectDefinition: kind: ConfigMap 1 apiVersion: v1 metadata: name: demo-app-config namespace: test data: 2 app-name: sampleApp app-description: "this is a sample app" log-file: '{{ fromConfigMap "default" "logs-config" "log-file" }}' 3 log-level: '{{ fromConfigMap "default" "logs-config" "log-level" }}' 4 remediationAction: enforce severity: low 1 You receive a policy violation if the Kubernetes ConfigMap resource does not exist on the target cluster. 2 If the data key does not exist on the target cluster, the value becomes an empty string. 3 The value for the log-file data key is a template that retrieves the value of the log-file from the logs-config config map in the default namespace. 4 The log-level is a tempalte that retrieves the value of the log-level data key in the default namespace. 2.8.2.1.3. fromClusterClaim The fromClusterClaim function returns the value of the Spec.Value in the ClusterClaim resource. View the following syntax for the function: View the following example of the configuration policy that enforces a Kubernetes resource on the target managed cluster: apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: demo-clusterclaims 1 namespace: default spec: namespaceSelector: exclude: - kube-* include: - default object-templates: - complianceType: musthave objectDefinition: kind: ConfigMap apiVersion: v1 metadata: name: sample-app-config namespace: default data: 2 platform: '{{ fromClusterClaim "platform.open-cluster-management.io" }}' 3 product: '{{ fromClusterClaim "product.open-cluster-management.io" }}' version: '{{ fromClusterClaim "version.openshift.io" }}' remediationAction: enforce severity: low 1 When you use this function, enter the name of a Kubernetes ClusterClaim resource. You receive a policy violation if the ClusterClaim resource does not exist. 2 Configuration values can be set as key-value properties. 3 The value for the platform data key is a template that retrieves the value of the platform.open-cluster-management.io cluster claim. Similarly, it retrieves values for product and version from the ClusterClaim resource. 2.8.2.1.4. lookup The lookup function returns the Kubernetes resource as a JSON compatible map. When you use this function, enter the API version, kind, namespace, name, and optional label selectors of the Kubernetes resource. You must use the same namespace that is used for the policy within the hub cluster template. See Template processing for more details. If the requested resource does not exist, an empty map is returned. If the resource does not exist and the value is provided to another template function, you might get the following error: invalid value; expected string . Note: Use the default template function, so the correct type is provided to later template functions. See the Sprig open source section. View the following syntax for the function: For label selector examples, see the reference to the Kubernetes labels and selectors documentation, in the Additional resources section. View the following example of the configuration policy that enforces a Kubernetes resource on the target managed cluster: apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: demo-lookup namespace: test-templates spec: namespaceSelector: exclude: - kube-* include: - default object-templates: - complianceType: musthave objectDefinition: kind: ConfigMap apiVersion: v1 metadata: name: demo-app-config namespace: test data: 1 app-name: sampleApp app-description: "this is a sample app" metrics-url: | 2 http://{{ (lookup "v1" "Service" "default" "metrics").spec.clusterIP }}:8080 remediationAction: enforce severity: low 1 Configuration values can be set as key-value properties. 2 The value for the metrics-url data key is a template that retrieves the v1/Service Kubernetes resource metrics from the default namespace, and is set to the value of the Spec.ClusterIP in the queried resource. 2.8.2.1.5. base64enc The base64enc function returns a base64 encoded value of the input data string . When you use this function, enter a string value. View the following syntax for the function: View the following example of the configuration policy that uses the base64enc function: apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: demo-fromsecret namespace: test spec: namespaceSelector: exclude: - kube-* include: - default object-templates: - complianceType: musthave objectDefinition: ... data: USER_NAME: '{{ fromConfigMap "default" "myconfigmap" "admin-user" | base64enc }}' 2.8.2.1.6. base64dec The base64dec function returns a base64 decoded value of the input enc-data string . When you use this function, enter a string value. View the following syntax for the function: View the following example of the configuration policy that uses the base64dec function: apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: demo-fromsecret namespace: test spec: namespaceSelector: exclude: - kube-* include: - default object-templates: - complianceType: musthave objectDefinition: ... data: app-name: | "{{ ( lookup "v1" "Secret" "testns" "mytestsecret") .data.appname ) | base64dec }}" 2.8.2.1.7. indent The indent function returns the padded data string . When you use this function, enter a data string with the specific number of spaces. View the following syntax for the function: View the following example of the configuration policy that uses the indent function: apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: demo-fromsecret namespace: test spec: namespaceSelector: exclude: - kube-* include: - default object-templates: - complianceType: musthave objectDefinition: ... data: Ca-cert: | {{ ( index ( lookup "v1" "Secret" "default" "mycert-tls" ).data "ca.pem" ) | base64dec | indent 4 }} 2.8.2.1.8. autoindent The autoindent function acts like the indent function that automatically determines the number of leading spaces based on the number of spaces before the template. View the following example of the configuration policy that uses the autoindent function: apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: demo-fromsecret namespace: test spec: namespaceSelector: exclude: - kube-* include: - default object-templates: - complianceType: musthave objectDefinition: ... data: Ca-cert: | {{ ( index ( lookup "v1" "Secret" "default" "mycert-tls" ).data "ca.pem" ) | base64dec | autoindent }} 2.8.2.1.9. toInt The toInt function casts and returns the integer value of the input value. When this is the last function in the template, there is further processing of the source content. This is to ensure that the value is interpreted as an integer by the YAML. When you use this function, enter the data that needs to be casted as an integer. View the following syntax for the function: View the following example of the configuration policy that uses the toInt function: apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: demo-template-function namespace: test spec: namespaceSelector: exclude: - kube-* include: - default object-templates: - complianceType: musthave objectDefinition: ... spec: vlanid: | {{ (fromConfigMap "site-config" "site1" "vlan") | toInt }} 2.8.2.1.10. toBool The toBool function converts the input string into a boolean, and returns the boolean. When this is the last function in the template, there is further processing of the source content. This is to ensure that the value is interpreted as a boolean by the YAML. When you use this function, enter the string data that needs to be converted to a boolean. View the following syntax for the function: View the following example of the configuration policy that uses the toBool function: apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: demo-template-function namespace: test spec: namespaceSelector: exclude: - kube-* include: - default object-templates: - complianceType: musthave objectDefinition: ... spec: enabled: | {{ (fromConfigMap "site-config" "site1" "enabled") | toBool }} 2.8.2.1.11. protect The protect function enables you to encrypt a string in a hub cluster policy template. It is automatically decrypted on the managed cluster when the policy is evaluated. View the following example of the configuration policy that uses the protect function: apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: demo-template-function namespace: test spec: namespaceSelector: exclude: - kube-* include: - default object-templates: - complianceType: musthave objectDefinition: ... spec: enabled: | {{hub (lookup "v1" "Secret" "default" "my-hub-secret").data.message | protect hub}} In the YAML example, there is an existing hub cluster policy template that is defined to use the lookup function. On the replicated policy in the managed cluster namespace, the value might resemble the following syntax: USDocm_encrypted:okrrBqt72oI+3WT/0vxeI3vGa+wpLD7Z0ZxFMLvL204= Each encryption algorithm used is AES-CBC using 256-bit keys. Each encryption key is unique per managed cluster and is automatically rotated every 30 days. This ensures that your decrypted value is to never be stored in the policy on the managed cluster. To force an immediate rotation, delete the policy.open-cluster-management.io/last-rotated annotation on the policy-encryption-key Secret in the managed cluster namespace on the hub cluster. Policies are then reprocessed to use the new encryption key. 2.8.2.1.12. toLiteral The toLiteral function removes any quotation marks around the template string after it is processed. You can use this function to convert a JSON string from a config map field to a JSON value in the manifest. Run the following function to remove quotation marks from the key parameter value: After using the toLiteral function, the following update is displayed: 2.8.2.1.13. copySecretData The copySecretData function copies all of the data contents of the specified secret. View the following sample of the function: complianceType: musthave objectDefinition: apiVersion: v1 kind: Secret metadata: name: my-secret-copy data: '{{ copySecretData "default" "my-secret" }}' 1 1 When you use this function with hub cluster templates, the output is automatically encrypted using the protect function. 2.8.2.1.14. copyConfigMapData The copyConfigMapData function copies all of the data content of the specified config map. View the following sample of the function: complianceType: musthave objectDefinition: apiVersion: v1 kind: ConfigMap metadata: name: my-secret-copy data: '{{ copyConfigMapData "default" "my-configmap" }}' 2.8.2.2. Sprig open source Red Hat Advanced Cluster Management supports the following template functions that are included from the sprig open source project: Table 2.13. Table of supported, community Sprig functions Sprig library Functions Cryptographic and security htpasswd Date date , mustToDate , now , toDate Default default , empty , fromJson , mustFromJson , ternary , toJson , toRawJson Dictionaries and dict dict , dig , get , hasKey , merge , mustMerge , set , unset Integer math add , mul , div , round , sub Integer slice until , untilStep , Lists append , concat , has , list , mustAppend , mustHas , mustPrepend , mustSlice , prepend , slice String functions cat , contains , hasPrefix , hasSuffix , join , lower , mustRegexFind , mustRegexFindAll , mustRegexMatch , quote , regexFind , regexFindAll , regexMatch , regexQuoteMeta , replace , split , splitn , substr , trim , trimAll , trunc , upper Version comparison semver , semverCompare 2.8.2.3. Additional resources See Template processing for more details. See Advanced template processing in configuration policies for use-cases. For label selector examples, see the Kubernetes labels and selectors documentation. Refer to the Golang documentation - Package templates . See the Sprig Function Documentation for more details. 2.8.3. Advanced template processing in configuration policies Use both managed cluster and hub cluster templates to reduce the need to create separate policies for each target cluster or hardcode configuration values in the policy definitions. For security, both resource-specific and the generic lookup functions in hub cluster templates are restricted to the namespace of the policy on the hub cluster. Important: If you use hub cluster templates to propagate secrets or other sensitive data, that causes sensitive data exposure in the managed cluster namespace on the hub cluster and on the managed clusters where that policy is distributed. The template content is expanded in the policy, and policies are not encrypted by the OpenShift Container Platform ETCD encryption support. To address this, use fromSecret or copySecretData , which automatically encrypts the values from the secret, or protect to encrypt other values. Continue reading for advanced template use-cases: Special annotation for reprocessing Object template processing Bypass template processing 2.8.3.1. Special annotation for reprocessing Hub cluster templates are resolved to the data in the referenced resources during policy creation, or when the referenced resources are updated. If you need to manually initiate an update, use the special annotation, policy.open-cluster-management.io/trigger-update , to indicate changes for the data referenced by the templates. Any change to the special annotation value automatically initiates template processing. Additionally, the latest contents of the referenced resource are read and updated in the policy definition that is propagated for processing on managed clusters. A way to use this annotation is to increment the value by one each time. 2.8.3.2. Object template processing Set object templates with a YAML string representation. The object-template-raw parameter is an optional parameter that supports advanced templating use-cases, such as if-else and the range function. The following example is defined to add the species-category: mammal label to any ConfigMap in the default namespace that has a name key equal to Sea Otter : object-templates-raw: | {{- range (lookup "v1" "ConfigMap" "default" "").items }} {{- if eq .data.name "Sea Otter" }} - complianceType: musthave objectDefinition: kind: ConfigMap apiVersion: v1 metadata: name: {{ .metadata.name }} namespace: {{ .metadata.namespace }} labels: species-category: mammal {{- end }} {{- end }} Note: While spec.object-templates and spec.object-templates-raw are optional, exactly one of the two parameter fields must be set. View the following policy example that uses advanced templates to create and configure infrastructure MachineSet objects for your managed clusters. apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: create-infra-machineset spec: remediationAction: enforce severity: low object-templates-raw: | {{- /* Specify the parameters needed to create the MachineSet */ -}} {{- USDmachineset_role := "infra" }} {{- USDregion := "ap-southeast-1" }} {{- USDzones := list "ap-southeast-1a" "ap-southeast-1b" "ap-southeast-1c" }} {{- USDinfrastructure_id := (lookup "config.openshift.io/v1" "Infrastructure" "" "cluster").status.infrastructureName }} {{- USDworker_ms := (index (lookup "machine.openshift.io/v1beta1" "MachineSet" "openshift-machine-api" "").items 0) }} {{- /* Generate the MachineSet for each zone as specified */ -}} {{- range USDzone := USDzones }} - complianceType: musthave objectDefinition: apiVersion: machine.openshift.io/v1beta1 kind: MachineSet metadata: labels: machine.openshift.io/cluster-api-cluster: {{ USDinfrastructure_id }} name: {{ USDinfrastructure_id }}-{{ USDmachineset_role }}-{{ USDzone }} namespace: openshift-machine-api spec: replicas: 1 selector: matchLabels: machine.openshift.io/cluster-api-cluster: {{ USDinfrastructure_id }} machine.openshift.io/cluster-api-machineset: {{ USDinfrastructure_id }}-{{ USDmachineset_role }}-{{ USDzone }} template: metadata: labels: machine.openshift.io/cluster-api-cluster: {{ USDinfrastructure_id }} machine.openshift.io/cluster-api-machine-role: {{ USDmachineset_role }} machine.openshift.io/cluster-api-machine-type: {{ USDmachineset_role }} machine.openshift.io/cluster-api-machineset: {{ USDinfrastructure_id }}-{{ USDmachineset_role }}-{{ USDzone }} spec: metadata: labels: node-role.kubernetes.io/{{ USDmachineset_role }}: "" taints: - key: node-role.kubernetes.io/{{ USDmachineset_role }} effect: NoSchedule providerSpec: value: ami: id: {{ USDworker_ms.spec.template.spec.providerSpec.value.ami.id }} apiVersion: awsproviderconfig.openshift.io/v1beta1 blockDevices: - ebs: encrypted: true iops: 2000 kmsKey: arn: '' volumeSize: 500 volumeType: io1 credentialsSecret: name: aws-cloud-credentials deviceIndex: 0 instanceType: {{ USDworker_ms.spec.template.spec.providerSpec.value.instanceType }} iamInstanceProfile: id: {{ USDinfrastructure_id }}-worker-profile kind: AWSMachineProviderConfig placement: availabilityZone: {{ USDzone }} region: {{ USDregion }} securityGroups: - filters: - name: tag:Name values: - {{ USDinfrastructure_id }}-worker-sg subnet: filters: - name: tag:Name values: - {{ USDinfrastructure_id }}-private-{{ USDzone }} tags: - name: kubernetes.io/cluster/{{ USDinfrastructure_id }} value: owned userDataSecret: name: worker-user-data {{- end }} 2.8.3.3. Bypass template processing You might create a policy that contains a template that is not intended to be processed by Red Hat Advanced Cluster Management. By default, Red Hat Advanced Cluster Management processes all templates. To bypass template processing for your hub cluster, you must change {{ template content }} to {{ `{{ template content }}` }} . Alternatively, you can add the following annotation in the ConfigurationPolicy section of your Policy : policy.open-cluster-management.io/disable-templates: "true" . When this annotation is included, the workaround is not necessary. Template processing is bypassed for the ConfigurationPolicy . 2.8.3.4. Additional resources See Template functions for more details. Return to Template processing . See Kubernetes configuration policy controller for more details. Also refer to the Red Hat OpenShift Container Platform etcd encryption documentation . 2.9. Managing security policies Create a security policy to report and validate your cluster compliance based on your specified security standards, categories, and controls. View the following sections: Creating a security policy Updating security policies Deleting a security policy Cleaning up resources that are created by policies 2.9.1. Creating a security policy You can create a security policy from the command line interface (CLI) or from the console. Required access: Cluster administrator Important: * You must define a placement and placement binding to apply your policy to a specific cluster. The PlacementBinding resource binds the placement. Enter a valid value for the cluster Label selector field to define a Placement and PlacementBinding resource. * In order to use a Placement resource, a ManagedClusterSet resource must be bound to the namespace of the Placement resource with a ManagedClusterSetBinding resource. Refer to Creating a ManagedClusterSetBinding resource for additional details. 2.9.1.1. Creating a security policy from the command line interface Complete the following steps to create a policy from the command line interface (CLI): Create a policy by running the following command: Define the template that the policy uses. Edit your YAML file by adding a policy-templates field to define a template. Your policy might resemble the following YAML file: apiVersion: policy.open-cluster-management.io/v1 kind: Policy metadata: name: policy1 spec: remediationAction: "enforce" # or inform disabled: false # or true namespaceSelector: include: - "default" - "my-namespace" policy-templates: - objectDefinition: apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: operator # namespace: # will be supplied by the controller via the namespaceSelector spec: remediationAction: "inform" object-templates: - complianceType: "musthave" # at this level, it means the role must exist and must have the following rules apiVersion: rbac.authorization.k8s.io/v1 kind: Role metadata: name: example objectDefinition: rules: - complianceType: "musthave" # at this level, it means if the role exists the rule is a musthave apiGroups: ["extensions", "apps"] resources: ["deployments"] verbs: ["get", "list", "watch", "create", "delete","patch"] Define a PlacementBinding resource to bind your policy to your Placement resource. Your PlacementBinding resource might resemble the following YAML sample: apiVersion: policy.open-cluster-management.io/v1 kind: PlacementBinding metadata: name: binding1 placementRef: name: placement1 apiGroup: cluster.open-cluster-management.io kind: Placement subjects: - name: policy1 apiGroup: policy.open-cluster-management.io kind: Policy 2.9.1.1.1. Viewing your security policy from the CLI Complete the following steps to view your security policy from the CLI: View details for a specific security policy by running the following command: View a description of your security policy by running the following command: 2.9.1.2. Creating a cluster security policy from the console After you log in to your Red Hat Advanced Cluster Management, navigate to the Governance page and click Create policy . As you create your new policy from the console, a YAML file is also created in the YAML editor. To view the YAML editor, select the toggle at the beginning of the Create policy form to enable it. Complete the Create policy form, then select the Submit button. Your YAML file might resemble the following policy: apiVersion: policy.open-cluster-management.io/v1 kind: Policy metadata: name: policy-pod annotations: policy.open-cluster-management.io/categories: 'SystemAndCommunicationsProtections,SystemAndInformationIntegrity' policy.open-cluster-management.io/controls: 'control example' policy.open-cluster-management.io/standards: 'NIST,HIPAA' policy.open-cluster-management.io/description: spec: complianceType: musthave namespaces: exclude: ["kube*"] include: ["default"] pruneObjectBehavior: None object-templates: - complianceType: musthave objectDefinition: apiVersion: v1 kind: Pod metadata: name: pod1 spec: containers: - name: pod-name image: 'pod-image' ports: - containerPort: 80 remediationAction: enforce disabled: false See the following PlacementBinding example: apiVersion: policy.open-cluster-management.io/v1 kind: PlacementBinding metadata: name: binding-pod placementRef: name: placement-pod kind: Placement apiGroup: cluster.open-cluster-management.io subjects: - name: policy-pod kind: Policy apiGroup: policy.open-cluster-management.io See the following Placement example: apiVersion: cluster.open-cluster-management.io/v1beta1 kind: Placement metadata: name: placement-pod spec: predicates: - requiredClusterSelector: labelSelector: matchLabels: cloud: "IBM" Optional: Add a description for your policy. Click Create Policy . A security policy is created from the console. 2.9.1.2.1. Viewing your security policy from the console View any security policy and the status from the console. Navigate to the Governance page to view a table list of your policies. Note: You can filter the table list of your policies by selecting the Policies tab or Cluster violations tab. Select one of your policies to view more details. The Details , Clusters , and Templates tabs are displayed. When the cluster or policy status cannot be determined, the following message is displayed: No status . Alternatively, select the Policies tab to view the list of policies. Expand a policy row to view the Description , Standards , Controls , and Categories details. 2.9.1.3. Creating policy sets from the CLI By default, the policy set is created with no policies or placements. You must create a placement for the policy set and have at least one policy that exists on your cluster. When you create a policy set, you can add numerous policies. Run the following command to create a policy set from the CLI: 2.9.1.4. Creating policy sets from the console From the navigation menu, select Governance . Select the Policy sets tab. Select the Create policy set button and complete the form. Add the details for your policy set and select the Submit button. Your policy is listed from the policy table. 2.9.2. Updating security policies Learn to update security policies. 2.9.2.1. Adding a policy to a policy set from the CLI Run the following command to edit your policy set: Add the policy name to the list in the policies section of the policy set. Apply your added policy in the placement section of your policy set with the following command: PlacementBinding and Placement are both created. Note: If you delete the placement binding, the policy is still placed by the policy set. 2.9.2.2. Adding a policy to a policy set from the console Add a policy to the policy set by selecting the Policy sets tab. Select the Actions icon and select Edit . The Edit policy set form appears. Navigate to the Policies section of the form to select a policy to add to the policy set. 2.9.2.3. Disabling security policies Your policy is enabled by default. Disable your policy from the console. After you log in to your Red Hat Advanced Cluster Management for Kubernetes console, navigate to the Governance page to view a table list of your policies. Select the Actions icon > Disable policy . The Disable Policy dialog box appears. Click Disable policy . Your policy is disabled. 2.9.3. Deleting a security policy Delete a security policy from the CLI or the console. Delete a security policy from the CLI: Delete a security policy by running the following command: After your policy is deleted, it is removed from your target cluster or clusters. Verify that your policy is removed by running the following command: oc get policies.policy.open-cluster-management.io <policy-name> -n <policy-namespace> Delete a security policy from the console: From the navigation menu, click Governance to view a table list of your policies. Click the Actions icon for the policy you want to delete in the policy violation table. Click Remove . From the Remove policy dialog box, click Remove policy . 2.9.3.1. Deleting policy sets from the console From the Policy sets tab, select the Actions icon for the policy set. When you click Delete , the Permanently delete Policyset? dialogue box appears. Click the Delete button. 2.9.4. Cleaning up resources that are created by policies Use the pruneObjectBehavior parameter in a configuration policy to clean up resources that are created by the policy. When pruneObjectBehavior is set, the related objects are only cleaned up after the configuration policy (or parent policy) associated with them is deleted. View the following descriptions of the values that can be used for the parameter: DeleteIfCreated : Cleans up any resources created by the policy. DeleteAll : Cleans up all resources managed by the policy. None : This is the default value and maintains the same behavior from releases, where no related resources are deleted. You can set the value directly in the YAML file as you create a policy from the command line. From the console, you can select the value in the Prune Object Behavior section of the Policy templates step. Notes: If a policy that installs an operator has the pruneObjectBehavior parameter defined, then additional clean up is needed to complete the operator uninstall. You might need to delete the operator ClusterServiceVersion object as part of this cleanup. As you disable the config-policy-addon resource on the managed cluster, the pruneObjbectBehavior is ignored. To automatically clean up the related resources on the policies, you must remove the policies from the managed cluster before the add-on is disabled. 2.9.5. Additional resources View more descriptions of the policy YAML files in the Policy overview . See Resources that support support set-based requirements in the Kubernetes documentation for a valid expression. View the stable Policysets , which require the Policy Generator for deployment, PolicySets-- Stable . Refer to Governance for more topics about policies. 2.9.6. Managing configuration policies Learn to create, apply, view, and update your configuration policies. Required access : Administrator or cluster administrator Creating a configuration policy Updating configuration policies Deleting a configuration policy 2.9.6.1. Creating a configuration policy You can create a YAML file for your configuration policy from the command line interface (CLI) or from the console. If you have an existing Kubernetes manifest, consider using the Policy Generator to automatically include the manifests in a policy. See the Policy Generator documentation. View the following sections to create a configuration policy: 2.9.6.1.1. Creating a configuration policy from the CLI Complete the following steps to create a configuration policy from the (CLI): Create a YAML file for your configuration policy. Run the following command: Your configuration policy might resemble the following policy: apiVersion: policy.open-cluster-management.io/v1 kind: Policy metadata: name: policy-1 namespace: my-policies policy-templates: - apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: mustonlyhave-configuration spec: namespaceSelector: include: ["default"] exclude: ["kube-system"] remediationAction: inform disabled: false complianceType: mustonlyhave object-templates: Apply the policy by running the following command: Verify and list the policies by running the following command: Your configuration policy is created. 2.9.6.1.2. Viewing your configuration policy from the CLI Complete the following steps to view your configuration policy from the CLI: View details for a specific configuration policy by running the following command: View a description of your configuration policy by running the following command: 2.9.6.1.3. Creating a configuration policy from the console As you create a configuration policy from the console, a YAML file is also created in the YAML editor. Log in to your cluster from the console, and select Governance from the navigation menu. Click Create policy . Specify the policy you want to create by selecting one of the configuration policies for the specification parameter. Continue with configuration policy creation by completing the policy form. Enter or select the appropriate values for the following fields: Name Specifications Cluster selector Remediation action Standards Categories Controls Click Create . Your configuration policy is created. 2.9.6.1.4. Viewing your configuration policy from the console View any configuration policy and its status from the console. After you log in to your cluster from the console, select Governance to view a table list of your policies. Note: You can filter the table list of your policies by selecting the All policies tab or Cluster violations tab. Select one of your policies to view more details. The Details , Clusters , and Templates tabs are displayed. 2.9.6.2. Updating configuration policies Learn to update configuration policies by viewing the following section. 2.9.6.2.1. Disabling configuration policies Disable your configuration policy. Similar to the instructions mentioned earlier, log in and navigate to the Governance page to complete the tasks. Select the Actions icon for a configuration policy from the table list, then click Disable . The Disable Policy dialog box appears. Click Disable policy . The policy is disabled, but not deleted. 2.9.6.3. Deleting a configuration policy Delete a configuration policy from the CLI or the console. Delete a configuration policy from the CLI with the following procedure: Run the following command to delete the policy from your target cluster or clusters: Verify that your policy is removed by running the following command: Delete a configuration policy from the console with the following procedure: From the navigation menu, click Governance to view a table list of your policies. Click the Actions icon for the policy you want to delete in the policy violation table, then click Remove . From the Remove policy dialog box, click Remove policy . Your policy is deleted. 2.9.6.4. Additional resources See configuration policy samples that are supported by Red Hat Advanced Cluster Management from the CM-Configuration-Management folder . Alternatively, you can refer to the Table of sample configuration policies to view other configuration policies that are monitored by the controller. For details to manage other policies, refer to Managing security policies . 2.9.7. Managing operator policies in disconnected environments You might need to deploy Red Hat Advanced Cluster Management for Kubernetes policies on Red Hat OpenShift Container Platform clusters that are not connected to the internet (disconnected). If the policies you deploy are used to deploy policies that install an Operator Lifecycle Manager operator, you must follow the procedure for Mirroring an Operator catalog . Complete the following steps to validate access to the operator images: See Verify required packages are available to validate that packages you require to use with policies are available. You must validate availability for each image registry used by any managed cluster that the following policies are deployed to: container-security-operator Deprecated: gatekeeper-operator-product compliance-operator See Configure image content source policies to validate that the sources are available. The image content source policies must exist on each of the disconnected managed clusters and can be deployed using a policy to simplify the process. See the following table of image source locations: Governance policy type Image source location Container security registry.redhat.io/quay Compliance registry.redhat.io/compliance Gatekeeper registry.redhat.io/rhacm2 2.9.8. Installing Red Hat OpenShift Platform Plus by using a policy set Continue reading for guidance to apply the Red Hat Openshift Platform Plus policy set. When you apply the Red Hat OpenShift policy set, the Red Hat Advanced Cluster Security secured cluster services and the Compliance Operator are deployed onto all of your OpenShift Container Platform managed clusters. 2.9.8.1. Prerequisites Complete the following steps before you apply the policy set: To allow for subscriptions to be applied to your cluster, you must apply the policy-configure-subscription-admin-hub.yaml policy and set the remediation action to enforce . Copy and paste the following YAML into the YAML editor of the console: apiVersion: policy.open-cluster-management.io/v1 kind: Policy metadata: name: policy-configure-subscription-admin-hub annotations: policy.open-cluster-management.io/standards: NIST SP 800-53 policy.open-cluster-management.io/categories: CM Configuration Management policy.open-cluster-management.io/controls: CM-2 Baseline Configuration spec: remediationAction: inform disabled: false policy-templates: - objectDefinition: apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: policy-configure-subscription-admin-hub spec: remediationAction: inform severity: low object-templates: - complianceType: musthave objectDefinition: apiVersion: rbac.authorization.k8s.io/v1 kind: ClusterRole metadata: name: open-cluster-management:subscription-admin rules: - apiGroups: - app.k8s.io resources: - applications verbs: - '*' - apiGroups: - apps.open-cluster-management.io resources: - '*' verbs: - '*' - apiGroups: - "" resources: - configmaps - secrets - namespaces verbs: - '*' - complianceType: musthave objectDefinition: apiVersion: rbac.authorization.k8s.io/v1 kind: ClusterRoleBinding metadata: name: open-cluster-management:subscription-admin roleRef: apiGroup: rbac.authorization.k8s.io kind: ClusterRole name: open-cluster-management:subscription-admin subjects: - apiGroup: rbac.authorization.k8s.io kind: User name: kube:admin - apiGroup: rbac.authorization.k8s.io kind: User name: system:admin --- apiVersion: policy.open-cluster-management.io/v1 kind: PlacementBinding metadata: name: binding-policy-configure-subscription-admin-hub placementRef: name: placement-policy-configure-subscription-admin-hub kind: Placement apiGroup: cluster.open-cluster-management.io subjects: - name: policy-configure-subscription-admin-hub kind: Policy apiGroup: policy.open-cluster-management.io --- apiVersion: cluster.open-cluster-management.io/v1beta1 kind: Placement metadata: name: placement-policy-configure-subscription-admin-hub spec: predicates: - requiredClusterSelector: labelSelector: matchExpressions: - {key: name, operator: In, values: ["local-cluster"]} To apply the YAML from the command line interface, run the following command: Install the Policy Generator kustomize plugin. Use Kustomize v4.5 or newer. See Generating a policy to install an Operator . Policies are installed to the policies namespace. You must bind that namespace to a ClusterSet . For example, copy and apply the following example YAML to bind the namespace to the default ClusterSet : apiVersion: cluster.open-cluster-management.io/v1beta2 kind: ManagedClusterSetBinding metadata: name: default namespace: policies spec: clusterSet: default Run the following command to apply the ManagedClusterSetBinding resource from the command line interface: After you meet the prerequisite requirements, you can apply the policy set. 2.9.8.2. Applying Red Hat OpenShift Platform Plus policy set Use the openshift-plus/policyGenerator.yaml file that includes the prerequisite configuration for Red Hat OpenShift Plus. See openshift-plus/policyGenerator.yaml . Apply the policies to your hub cluster by using the kustomize command: Note: For any components of OpenShift Platform Plus that you do not want to install, edit the policyGenerator.yaml file and remove or comment out the policies for those components. 2.9.8.3. Additional resources See Red Hat OpenShift Platform Plus policy set for an overview of the policy set. Return to the beginning of the topic, Installing Red Hat OpenShift Platform Plus by using a policy set 2.9.9. Installing an operator by using the OperatorPolicy resource To install Operator Lifecycle Manager (OLM) managed operators on your managed clusters, use an OperatorPolicy policy template in a Policy definition. 2.9.9.1. Creating an OperatorPolicy resource to install Quay See the following operator policy sample that installs the latest Quay operator in the stable-3.11 channel using the Red Hat operator catalog: apiVersion: policy.open-cluster-management.io/v1 kind: Policy metadata: name: install-quay namespace: open-cluster-management-global-set spec: disabled: false policy-templates: - objectDefinition: apiVersion: policy.open-cluster-management.io/v1beta1 kind: OperatorPolicy metadata: name: install-quay spec: remediationAction: enforce severity: critical complianceType: musthave upgradeApproval: None subscription: channel: stable-3.11 name: quay-operator source: redhat-operators sourceNamespace: openshift-marketplace After you add the OperatorPolicy policy template, the operatorGroup and subscription objects are created on the cluster by using the controller. As a result, the rest of the installation is completed by OLM. You can view the health of owned resources in the .status.Conditions and .status.relatedObjects fields of the OperatorPolicy resource on your managed cluster. To verify the operator policy status, run the following command on your managed cluster: oc -n <managed cluster namespace> get operatorpolicy install-quay 2.9.9.2. Additional resources See Operator policy controller 2.10. Policy dependencies Dependencies can be used to activate a policy only when other policies on your cluster are in a certain state. When the dependency criteria is not met, the policy is labeled as Pending and resources are not created on your managed cluster. There are more details about the the criteria status in the policy status. You can use policy dependencies to control the ordering of how objects are applied. For example, if you have a policy for an operator and another policy for a resource that the operator manages, you can set a dependency on the second policy so that it does not attempt to create the resource until the operator is installed. This can help with the performance on the managed cluster. Required access: Policy administrator View the following policy dependency example, where the ScanSettingBinding is only created if the upstream-compliance-operator policy is already compliant on the managed cluster: 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: moderate-compliance-scan namespace: default spec: dependencies: 1 - apiVersion: policy.open-cluster-management.io/v1 compliance: Compliant kind: Policy name: upstream-compliance-operator namespace: default disabled: false policy-templates: - extraDependencies: 2 - apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy name: scan-setting-prerequisite compliance: Compliant ignorePending: false 3 objectDefinition: apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: moderate-compliance-scan spec: object-templates: - complianceType: musthave objectDefinition: apiVersion: compliance.openshift.io/v1alpha1 kind: ScanSettingBinding metadata: name: moderate namespace: openshift-compliance profiles: - apiGroup: compliance.openshift.io/v1alpha1 kind: Profile name: ocp4-moderate - apiGroup: compliance.openshift.io/v1alpha1 kind: Profile name: ocp4-moderate-node settingsRef: apiGroup: compliance.openshift.io/v1alpha1 kind: ScanSetting name: default remediationAction: enforce severity: low 1 The dependencies field is set on a Policy object, and the requirements apply to all policy templates in the policy. 2 The extraDependencies field can be set on individual policy template. For example the parameter can be set for a configuration policy, and defines criteria that must be satisfied in addition to any dependencies set in the policy. 3 The ignorePending field can be set on each individual policy template, and configures whether the Pending status on that template is considered as Compliant or NonCompliant when the overall policy compliance is calculated. By default, this is set to false and a Pending template causes the policy to be NonCompliant . When you set this to true the policy can still be Compliant when this template is Pending , which is useful when that is expected status of the template. Note: You cannot use a dependency to apply a policy on one cluster based on the status of a policy in another cluster. 2.11. Secure the hub cluster Secure your Red Hat Advanced Cluster Management for Kubernetes installation by enhancing the hub cluster security. Complete the following steps: Secure Red Hat OpenShift Container Platform. For more information, see OpenShift Container Platform security and compliance . Setup role-based access control (RBAC). For more information, see Role-based access control . Customize certificates, see Certificates . Define your cluster credentials, see Managing credentials overview Review the policies that are available to help you harden your cluster security. See Supported policies

Commands:
apiVersion: cluster.open-cluster-management.io/v1beta1 kind: Placement metadata: name: placement-policy-role spec: predicates: - requiredClusterSelector: labelSelector: matchExpressions: - {key: environment, operator: In, values: ["dev"]}
apiVersion: policy.open-cluster-management.io/v1 kind: PlacementBinding metadata: name: binding-policy-role placementRef: name: placement-policy-role 1 kind: Placement apiGroup: cluster.open-cluster-management.io subjects: 2 - name: policy-role kind: Policy apiGroup: policy.open-cluster-management.io
apiVersion: policy.open-cluster-management.io/v1 kind: Policy metadata: name: annotations: policy.open-cluster-management.io/standards: policy.open-cluster-management.io/categories: policy.open-cluster-management.io/controls: policy.open-cluster-management.io/description: spec: disabled: remediationAction: dependencies: - apiVersion: policy.open-cluster-management.io/v1 compliance: kind: Policy name: namespace: policy-templates: - objectDefinition: apiVersion: kind: metadata: name: spec: --- apiVersion: policy.open-cluster-management.io/v1 kind: PlacementBinding metadata: bindingOverrides: remediationAction: subFilter: name: placementRef: name: kind: Placement apiGroup: cluster.open-cluster-management.io subjects: - name: kind: apiGroup: --- apiVersion: cluster.open-cluster-management.io/v1beta1 kind: Placement metadata: name: spec:
apiVersion: policy.open-cluster-management.io/v1 kind: Policy metadata: name: policy-role annotations: policy.open-cluster-management.io/standards: NIST SP 800-53 policy.open-cluster-management.io/categories: AC Access Control policy.open-cluster-management.io/controls: AC-3 Access Enforcement policy.open-cluster-management.io/description: spec: remediationAction: inform disabled: false policy-templates: - objectDefinition: apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: policy-role-example spec: remediationAction: inform # the policy-template spec.remediationAction is overridden by the preceding parameter value for spec.remediationAction. severity: high namespaceSelector: include: ["default"] object-templates: - complianceType: mustonlyhave # role definition should exact match objectDefinition: apiVersion: rbac.authorization.k8s.io/v1 kind: Role metadata: name: sample-role rules: - apiGroups: ["extensions", "apps"] resources: ["deployments"] verbs: ["get", "list", "watch", "delete","patch"] --- apiVersion: policy.open-cluster-management.io/v1 kind: PlacementBinding metadata: name: binding-policy-role placementRef: name: placement-policy-role kind: Placement apiGroup: cluster.open-cluster-management.io subjects: - name: policy-role kind: Policy apiGroup: policy.open-cluster-management.io --- apiVersion: cluster.open-cluster-management.io/v1beta1 kind: Placement metadata: name: placement-policy-role spec: predicates: - requiredClusterSelector: labelSelector: matchExpressions: - {key: environment, operator: In, values: ["dev"]}
apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: policy-config spec: namespaceSelector: include: ["default"] exclude: [] matchExpressions: [] matchLabels: {} remediationAction: inform severity: low evaluationInterval: compliant: noncompliant: object-templates: - complianceType: musthave objectDefinition: apiVersion: v1 kind: Pod metadata: name: pod spec: containers: - image: pod-image name: pod-name ports: - containerPort: 80 - complianceType: musthave objectDefinition: apiVersion: v1 kind: ConfigMap metadata: name: myconfig namespace: default data: testData: hello spec:
apiVersion: policy.open-cluster-management.io/v1 kind: CertificatePolicy metadata: name: certificate-policy-example spec: namespaceSelector: include: ["default"] exclude: [] matchExpressions: [] matchLabels: {} labelSelector: myLabelKey: myLabelValue remediationAction: severity: minimumDuration: minimumCADuration: maximumDuration: maximumCADuration: allowedSANPattern: disallowedSANPattern:
apiVersion: policy.open-cluster-management.io/v1beta1 kind: PolicySet metadata: name: demo-policyset spec: policies: - policy-demo --- apiVersion: policy.open-cluster-management.io/v1 kind: PlacementBinding metadata: name: demo-policyset-pb placementRef: apiGroup: cluster.open-cluster-management.io kind: Placement name: demo-policyset-pr subjects: - apiGroup: policy.open-cluster-management.io kind: PolicySet name: demo-policyset --- apiVersion: cluster.open-cluster-management.io/v1beta1 kind: Placement metadata: name: demo-policyset-pr spec: predicates: - requiredClusterSelector: labelSelector: matchExpressions: - key: name operator: In values: - local-cluster
apiVersion: policy.open-cluster-management.io/v1beta1 kind: PolicySet metadata: name: pci namespace: default spec: description: Policies for PCI compliance policies: - policy-pod - policy-namespace status: compliant: NonCompliant placement: - placementBinding: binding1 placement: placement1 policySet: policyset-ps
apiVersion: addon.open-cluster-management.io/v1alpha1 kind: ManagedClusterAddOn metadata: name: governance-policy-framework namespace: cluster1 annotations: policy-evaluation-concurrency: "2" spec: installNamespace: open-cluster-management-agent-addon
apiVersion: addon.open-cluster-management.io/v1alpha1 kind: ManagedClusterAddOn metadata: name: governance-policy-framework namespace: cluster1 annotations: client-qps: "30" client-burst: "45" spec: installNamespace: open-cluster-management-agent-addon
apiVersion: addon.open-cluster-management.io/v1alpha1 kind: ManagedClusterAddOn metadata: name: config-policy-controller namespace: cluster1 annotations: policy-evaluation-concurrency: "5" spec: installNamespace: open-cluster-management-agent-addon
apiVersion: addon.open-cluster-management.io/v1alpha1 kind: ManagedClusterAddOn metadata: name: config-policy-controller namespace: cluster1 annotations: client-qps: "20" client-burst: "100" spec: installNamespace: open-cluster-management-agent-addon
apiVersion: addon.open-cluster-management.io/v1alpha1 kind: ManagedClusterAddOn metadata: name: config-policy-controller namespace: cluster1 annotations: log-level: "2" spec: installNamespace: open-cluster-management-agent-addon
apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: my-config-policy spec: object-templates: - complianceType: musthave recordDiff: Log objectDefinition: apiVersion: v1 kind: ConfigMap metadata: name: my-configmap data: fieldToUpdate: "2"
Logging the diff: --- default/my-configmap : existing +++ default/my-configmap : updated @@ -2,3 +2,3 @@ data: - fieldToUpdate: "1" + fieldToUpdate: "2" kind: ConfigMap
get -n local-cluster managedclusteraddon cert-policy-controller | grep -B4 'type: ManifestApplied'
- lastTransitionTime: "2023-01-26T15:42:22Z" message: manifests of addon are applied successfully reason: AddonManifestApplied status: "True" type: ManifestApplied
-n <PostgreSQL namespace> port-forward <PostgreSQL pod name> 5432:5432
psql 'postgres://postgres:@127.0.0.1:5432/postgres'
CREATE USER "rhacm-policy-compliance-history" WITH PASSWORD '<replace with password>'; CREATE DATABASE "rhacm-policy-compliance-history" WITH OWNER="rhacm-policy-compliance-history";
-n open-cluster-management create secret generic governance-policy-database \ 1 --from-literal="user=rhacm-policy-compliance-history" --from-literal="password=rhacm-policy-compliance-history" --from-literal="host=<replace with host name of the Postgres server>" \ 2 --from-literal="dbname=ocm-compliance-history" --from-literal="sslmode=verify-full" --from-file="ca=<replace>" 3
-n open-cluster-management label secret governance-policy-database cluster.open-cluster-management.io/backup=""
python -c 'import urllib.parse; import sys; print(urllib.parse.quote(sys.argv[1]))' 'USDuper<Secr&t%>'
curl -H "Authorization: Bearer USD(oc whoami --show-token)" "https://USD(oc -n open-cluster-management get route governance-history-api -o jsonpath='{.spec.host}')/api/v1/compliance-events"
{"data":[],"metadata":{"page":1,"pages":0,"per_page":20,"total":0}}
message: The database is unavailable
message: Internal Error
-n open-cluster-management get events --field-selector reason=OCMComplianceEventsDBError
-n open-cluster-management logs -l name=governance-policy-propagator -f
2024-03-05T12:17:14.500-0500 info compliance-events-api complianceeventsapi/complianceeventsapi_controller.go:261 The database connection failed: pq: password authentication failed for user "rhacm-policy-compliance-history"
-n open-cluster-management edit secret governance-policy-database
echo "https://USD(oc -n open-cluster-management get route governance-history-api -o=jsonpath='{.spec.host}')"
https://governance-history-api-open-cluster-management.apps.openshift.redhat.com
apiVersion: addon.open-cluster-management.io/v1alpha1 kind: AddOnDeploymentConfig metadata: name: governance-policy-framework namespace: open-cluster-management spec: customizedVariables: - name: complianceHistoryAPIURL value: <replace with URL from previous command>
edit ClusterManagementAddOn governance-policy-framework
- group: addon.open-cluster-management.io resource: addondeploymentconfigs defaultConfig: name: governance-policy-framework namespace: open-cluster-management
-n <manage-cluster-namespace> edit ManagedClusterAddOn governance-policy-framework
- group: addon.open-cluster-management.io resource: addondeploymentconfigs name: governance-policy-framework namespace: open-cluster-management
-n open-cluster-management-agent-addon get deployment governance-policy-framework -o jsonpath='{.spec.template.spec.containers[1].args}'
--enable-lease=true
--hub-cluster-configfile=/var/run/klusterlet/kubeconfig
--leader-elect=false
--log-encoder=console
--log-level=0
--v=-1
--evaluation-concurrency=2
--client-max-qps=30
--client-burst=45
--disable-spec-sync=true
--cluster-namespace=local-cluster
--compliance-api-url=https://governance-history-api-open-cluster-management.apps.openshift.redhat.com
-n open-cluster-management-agent-addon logs deployment/governance-policy-framework -f
024-03-05T19:28:38.063Z info policy-status-sync statussync/policy_status_sync.go:750 Failed to record the compliance event with the compliance API. Will requeue. {"statusCode": 503, "message": ""}
-n open-cluster-management edit AddOnDeploymentConfig governance-policy-framework
apiVersion: policy.open-cluster-management.io/v1 kind: Policy metadata: name: namespace: annotations: policy.open-cluster-management.io/standards: policy.open-cluster-management.io/categories: policy.open-cluster-management.io/controls: policy.open-cluster-management.io/description: spec: remediationAction: disabled: policy-templates: - objectDefinition: apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: spec: remediationAction: severity: object-templates: - complianceType: objectDefinition: kind: Namespace apiVersion: v1 metadata: name:
apiVersion: policy.open-cluster-management.io/v1 kind: Policy metadata: name: namespace: annotations: policy.open-cluster-management.io/standards: policy.open-cluster-management.io/categories: policy.open-cluster-management.io/controls: policy.open-cluster-management.io/description: spec: remediationAction: disabled: policy-templates: - objectDefinition: apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: spec: remediationAction: severity: namespaceSelector: exclude: include: matchLabels: matchExpressions: object-templates: - complianceType: objectDefinition: apiVersion: v1 kind: Pod metadata: name: spec: containers: - image: name:
apiVersion: policy.open-cluster-management.io/v1 kind: Policy metadata: name: namespace: annotations: policy.open-cluster-management.io/standards: policy.open-cluster-management.io/categories: policy.open-cluster-management.io/controls: policy.open-cluster-management.io/description: spec: remediationAction: disabled: policy-templates: - objectDefinition: apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: spec: remediationAction: severity: namespaceSelector: exclude: include: matchLabels: matchExpressions: object-templates: - complianceType: mustonlyhave objectDefinition: apiVersion: v1 kind: LimitRange metadata: name: spec: limits: - default: memory: defaultRequest: memory: type:
apiVersion: policy.open-cluster-management.io/v1 kind: Policy metadata: name: namespace: annotations: policy.open-cluster-management.io/standards: policy.open-cluster-management.io/categories: policy.open-cluster-management.io/controls: policy.open-cluster-management.io/description: spec: remediationAction: disabled: policy-templates: - objectDefinition: apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: spec: remediationAction: severity: namespaceSelector: exclude: include: matchLabels: matchExpressions: object-templates: - complianceType: objectDefinition: apiVersion: policy/v1beta1 kind: PodSecurityPolicy metadata: name: annotations: seccomp.security.alpha.kubernetes.io/allowedProfileNames: spec: privileged: allowPrivilegeEscalation: allowedCapabilities: volumes: hostNetwork: hostPorts: hostIPC: hostPID: runAsUser: seLinux: supplementalGroups: fsGroup:
violation - couldn't find mapping resource with kind PodSecurityPolicy, please check if you have CRD deployed
apiVersion: policy.open-cluster-management.io/v1 kind: Policy metadata: name: namespace: annotations: policy.open-cluster-management.io/standards: policy.open-cluster-management.io/categories: policy.open-cluster-management.io/controls: policy.open-cluster-management.io/description: spec: remediationAction: disabled: policy-templates: - objectDefinition: apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: spec: remediationAction: severity: namespaceSelector: exclude: include: matchLabels: matchExpressions: object-templates: - complianceType: objectDefinition: apiVersion: rbac.authorization.k8s.io/v1 kind: Role metadata: name: rules: - apiGroups: resources: verbs:
apiVersion: policy.open-cluster-management.io/v1 kind: Policy metadata: name: namespace: annotations: policy.open-cluster-management.io/standards: policy.open-cluster-management.io/categories: policy.open-cluster-management.io/controls: policy.open-cluster-management.io/description: spec: remediationAction: disabled: policy-templates: - objectDefinition: apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: spec: remediationAction: severity: namespaceSelector: exclude: include: matchLabels: matchExpressions: object-templates: - complianceType: objectDefinition: kind: RoleBinding # role binding must exist apiVersion: rbac.authorization.k8s.io/v1 metadata: name: subjects: - kind: name: apiGroup: roleRef: kind: name: apiGroup:
apiVersion: policy.open-cluster-management.io/v1 kind: Policy metadata: name: namespace: annotations: policy.open-cluster-management.io/standards: policy.open-cluster-management.io/categories: policy.open-cluster-management.io/controls: policy.open-cluster-management.io/description: spec: remediationAction: disabled: policy-templates: - objectDefinition: apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: spec: remediationAction: severity: namespaceSelector: exclude: include: matchLabels: matchExpressions: object-templates: - complianceType: objectDefinition: apiVersion: security.openshift.io/v1 kind: SecurityContextConstraints metadata: name: allowHostDirVolumePlugin: allowHostIPC: allowHostNetwork: allowHostPID: allowHostPorts: allowPrivilegeEscalation: allowPrivilegedContainer: fsGroup: readOnlyRootFilesystem: requiredDropCapabilities: runAsUser: seLinuxContext: supplementalGroups: users: volumes:
apiVersion: policy.open-cluster-management.io/v1 kind: Policy metadata: name: namespace: annotations: policy.open-cluster-management.io/standards: policy.open-cluster-management.io/categories: policy.open-cluster-management.io/controls: policy.open-cluster-management.io/description: spec: remediationAction: disabled: policy-templates: - objectDefinition: apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: spec: remediationAction: severity: object-templates: - complianceType: objectDefinition: apiVersion: config.openshift.io/v1 kind: APIServer metadata: name: spec: encryption:
apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: comp-operator-ns spec: remediationAction: inform # will be overridden by remediationAction in parent policy severity: high object-templates: - complianceType: musthave objectDefinition: apiVersion: v1 kind: Namespace metadata: name: openshift-compliance
apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: comp-operator-operator-group spec: remediationAction: inform # will be overridden by remediationAction in parent policy severity: high object-templates: - complianceType: musthave objectDefinition: apiVersion: operators.coreos.com/v1 kind: OperatorGroup metadata: name: compliance-operator namespace: openshift-compliance spec: targetNamespaces: - openshift-compliance
apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: comp-operator-subscription spec: remediationAction: inform # will be overridden by remediationAction in parent policy severity: high object-templates: - complianceType: musthave objectDefinition: apiVersion: operators.coreos.com/v1alpha1 kind: Subscription metadata: name: compliance-operator namespace: openshift-compliance spec: channel: "4.x" installPlanApproval: Automatic name: compliance-operator source: redhat-operators sourceNamespace: openshift-marketplace
apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: compliance-suite-e8 spec: remediationAction: inform severity: high object-templates: - complianceType: musthave # this template checks if scan has completed by checking the status field objectDefinition: apiVersion: compliance.openshift.io/v1alpha1 kind: ScanSettingBinding metadata: name: e8 namespace: openshift-compliance profiles: - apiGroup: compliance.openshift.io/v1alpha1 kind: Profile name: ocp4-e8 - apiGroup: compliance.openshift.io/v1alpha1 kind: Profile name: rhcos4-e8 settingsRef: apiGroup: compliance.openshift.io/v1alpha1 kind: ScanSetting name: default
apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: compliance-suite-e8 spec: remediationAction: inform severity: high object-templates: - complianceType: musthave # this template checks if scan has completed by checking the status field objectDefinition: apiVersion: compliance.openshift.io/v1alpha1 kind: ComplianceSuite metadata: name: e8 namespace: openshift-compliance status: phase: DONE
apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: compliance-suite-e8-results spec: remediationAction: inform severity: high object-templates: - complianceType: mustnothave # this template reports the results for scan suite: e8 by looking at ComplianceCheckResult CRs objectDefinition: apiVersion: compliance.openshift.io/v1alpha1 kind: ComplianceCheckResult metadata: namespace: openshift-compliance labels: compliance.openshift.io/check-status: FAIL compliance.openshift.io/suite: e8
apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: compliance-cis-scan spec: remediationAction: inform severity: high object-templates: - complianceType: musthave # this template creates ScanSettingBinding:cis objectDefinition: apiVersion: compliance.openshift.io/v1alpha1 kind: ScanSettingBinding metadata: name: cis namespace: openshift-compliance profiles: - apiGroup: compliance.openshift.io/v1alpha1 kind: Profile name: ocp4-cis - apiGroup: compliance.openshift.io/v1alpha1 kind: Profile name: ocp4-cis-node settingsRef: apiGroup: compliance.openshift.io/v1alpha1 kind: ScanSetting name: default
apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: compliance-suite-cis spec: remediationAction: inform severity: high object-templates: - complianceType: musthave # this template checks if scan has completed by checking the status field objectDefinition: apiVersion: compliance.openshift.io/v1alpha1 kind: ComplianceSuite metadata: name: cis namespace: openshift-compliance status: phase: DONE
apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: compliance-suite-cis-results spec: remediationAction: inform severity: high object-templates: - complianceType: mustnothave # this template reports the results for scan suite: cis by looking at ComplianceCheckResult CRs objectDefinition: apiVersion: compliance.openshift.io/v1alpha1 kind: ComplianceCheckResult metadata: namespace: openshift-compliance labels: compliance.openshift.io/check-status: FAIL compliance.openshift.io/suite: cis
apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: policy-imagemanifestvuln-example-sub spec: remediationAction: enforce # will be overridden by remediationAction in parent policy severity: high object-templates: - complianceType: musthave objectDefinition: apiVersion: operators.coreos.com/v1alpha1 kind: Subscription metadata: name: container-security-operator namespace: openshift-operators spec: # channel: quay-v3.3 # specify a specific channel if desired installPlanApproval: Automatic name: container-security-operator source: redhat-operators sourceNamespace: openshift-marketplace
apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: policy-imagemanifestvuln-status spec: remediationAction: inform # will be overridden by remediationAction in parent policy severity: high object-templates: - complianceType: musthave objectDefinition: apiVersion: operators.coreos.com/v1alpha1 kind: ClusterServiceVersion metadata: namespace: openshift-operators spec: displayName: Red Hat Quay Container Security Operator status: phase: Succeeded # check the CSV status to determine if operator is running or not
apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: policy-imagemanifestvuln-example-imv spec: remediationAction: inform # will be overridden by remediationAction in parent policy severity: high namespaceSelector: exclude: ["kube-*"] include: ["*"] object-templates: - complianceType: mustnothave # mustnothave any ImageManifestVuln object objectDefinition: apiVersion: secscan.quay.redhat.com/v1alpha1 kind: ImageManifestVuln # checking for a Kind
apiVersion: policy.open-cluster-management.io/v1beta1 kind: PolicyAutomation metadata: name: policyname-policy-automation spec: automationDef: extra_vars: your_var: your_value name: Policy Compliance Template secret: ansible-tower type: AnsibleJob mode: disabled policyRef: policyname
metadata: annotations: policy.open-cluster-management.io/rerun: "true"
ca.crt: '{{ fromSecret "openshift-config" "ca-config-map-secret" "ca.crt" | base64dec | toRawJson | toLiteral }}'
func fromSecret (ns string, secretName string, datakey string) (dataValue string, err error)
apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: demo-fromsecret namespace: test spec: namespaceSelector: exclude: - kube-* include: - default object-templates: - complianceType: musthave objectDefinition: apiVersion: v1 data: 1 USER_NAME: YWRtaW4= PASSWORD: '{{ fromSecret "default" "localsecret" "PASSWORD" }}' 2 kind: Secret 3 metadata: name: demosecret namespace: test type: Opaque remediationAction: enforce severity: low
ca.crt: '{{ fromSecret "openshift-config" "ca-config-map-secret" "ca.crt" | base64dec | toRawJson | toLiteral }}'
func fromConfigMap (ns string, configmapName string, datakey string) (dataValue string, err Error)
apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: demo-fromcm-lookup namespace: test-templates spec: namespaceSelector: exclude: - kube-* include: - default object-templates: - complianceType: musthave objectDefinition: kind: ConfigMap 1 apiVersion: v1 metadata: name: demo-app-config namespace: test data: 2 app-name: sampleApp app-description: "this is a sample app" log-file: '{{ fromConfigMap "default" "logs-config" "log-file" }}' 3 log-level: '{{ fromConfigMap "default" "logs-config" "log-level" }}' 4 remediationAction: enforce severity: low
func fromClusterClaim (clusterclaimName string) (dataValue string, err Error)
apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: demo-clusterclaims 1 namespace: default spec: namespaceSelector: exclude: - kube-* include: - default object-templates: - complianceType: musthave objectDefinition: kind: ConfigMap apiVersion: v1 metadata: name: sample-app-config namespace: default data: 2 platform: '{{ fromClusterClaim "platform.open-cluster-management.io" }}' 3 product: '{{ fromClusterClaim "product.open-cluster-management.io" }}' version: '{{ fromClusterClaim "version.openshift.io" }}' remediationAction: enforce severity: low
func lookup (apiversion string, kind string, namespace string, name string, labelselector ...string) (value string, err Error)
apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: demo-lookup namespace: test-templates spec: namespaceSelector: exclude: - kube-* include: - default object-templates: - complianceType: musthave objectDefinition: kind: ConfigMap apiVersion: v1 metadata: name: demo-app-config namespace: test data: 1 app-name: sampleApp app-description: "this is a sample app" metrics-url: | 2 http://{{ (lookup "v1" "Service" "default" "metrics").spec.clusterIP }}:8080 remediationAction: enforce severity: low
func base64enc (data string) (enc-data string)
apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: demo-fromsecret namespace: test spec: namespaceSelector: exclude: - kube-* include: - default object-templates: - complianceType: musthave objectDefinition: data: USER_NAME: '{{ fromConfigMap "default" "myconfigmap" "admin-user" | base64enc }}'
func base64dec (enc-data string) (data string)
apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: demo-fromsecret namespace: test spec: namespaceSelector: exclude: - kube-* include: - default object-templates: - complianceType: musthave objectDefinition: data: app-name: | "{{ ( lookup "v1" "Secret" "testns" "mytestsecret") .data.appname ) | base64dec }}"
func indent (spaces int, data string) (padded-data string)
apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: demo-fromsecret namespace: test spec: namespaceSelector: exclude: - kube-* include: - default object-templates: - complianceType: musthave objectDefinition: data: Ca-cert: | {{ ( index ( lookup "v1" "Secret" "default" "mycert-tls" ).data "ca.pem" ) | base64dec | indent 4 }}
apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: demo-fromsecret namespace: test spec: namespaceSelector: exclude: - kube-* include: - default object-templates: - complianceType: musthave objectDefinition: data: Ca-cert: | {{ ( index ( lookup "v1" "Secret" "default" "mycert-tls" ).data "ca.pem" ) | base64dec | autoindent }}
func toInt (input interface{}) (output int)
apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: demo-template-function namespace: test spec: namespaceSelector: exclude: - kube-* include: - default object-templates: - complianceType: musthave objectDefinition: spec: vlanid: | {{ (fromConfigMap "site-config" "site1" "vlan") | toInt }}
func toBool (input string) (output bool)
apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: demo-template-function namespace: test spec: namespaceSelector: exclude: - kube-* include: - default object-templates: - complianceType: musthave objectDefinition: spec: enabled: | {{ (fromConfigMap "site-config" "site1" "enabled") | toBool }}
apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: demo-template-function namespace: test spec: namespaceSelector: exclude: - kube-* include: - default object-templates: - complianceType: musthave objectDefinition: spec: enabled: | {{hub (lookup "v1" "Secret" "default" "my-hub-secret").data.message | protect hub}}
key: '{{ "[\"10.10.10.10\", \"1.1.1.1\"]" | toLiteral }}'
key: ["10.10.10.10", "1.1.1.1"]
complianceType: musthave objectDefinition: apiVersion: v1 kind: Secret metadata: name: my-secret-copy data: '{{ copySecretData "default" "my-secret" }}' 1
complianceType: musthave objectDefinition: apiVersion: v1 kind: ConfigMap metadata: name: my-secret-copy data: '{{ copyConfigMapData "default" "my-configmap" }}'
object-templates-raw: | {{- range (lookup "v1" "ConfigMap" "default" "").items }} {{- if eq .data.name "Sea Otter" }} - complianceType: musthave objectDefinition: kind: ConfigMap apiVersion: v1 metadata: name: {{ .metadata.name }} namespace: {{ .metadata.namespace }} labels: species-category: mammal {{- end }} {{- end }}
apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: create-infra-machineset spec: remediationAction: enforce severity: low object-templates-raw: | {{- /* Specify the parameters needed to create the MachineSet */ -}} {{- USDmachineset_role := "infra" }} {{- USDregion := "ap-southeast-1" }} {{- USDzones := list "ap-southeast-1a" "ap-southeast-1b" "ap-southeast-1c" }} {{- USDinfrastructure_id := (lookup "config.openshift.io/v1" "Infrastructure" "" "cluster").status.infrastructureName }} {{- USDworker_ms := (index (lookup "machine.openshift.io/v1beta1" "MachineSet" "openshift-machine-api" "").items 0) }} {{- /* Generate the MachineSet for each zone as specified */ -}} {{- range USDzone := USDzones }} - complianceType: musthave objectDefinition: apiVersion: machine.openshift.io/v1beta1 kind: MachineSet metadata: labels: machine.openshift.io/cluster-api-cluster: {{ USDinfrastructure_id }} name: {{ USDinfrastructure_id }}-{{ USDmachineset_role }}-{{ USDzone }} namespace: openshift-machine-api spec: replicas: 1 selector: matchLabels: machine.openshift.io/cluster-api-cluster: {{ USDinfrastructure_id }} machine.openshift.io/cluster-api-machineset: {{ USDinfrastructure_id }}-{{ USDmachineset_role }}-{{ USDzone }} template: metadata: labels: machine.openshift.io/cluster-api-cluster: {{ USDinfrastructure_id }} machine.openshift.io/cluster-api-machine-role: {{ USDmachineset_role }} machine.openshift.io/cluster-api-machine-type: {{ USDmachineset_role }} machine.openshift.io/cluster-api-machineset: {{ USDinfrastructure_id }}-{{ USDmachineset_role }}-{{ USDzone }} spec: metadata: labels: node-role.kubernetes.io/{{ USDmachineset_role }}: "" taints: - key: node-role.kubernetes.io/{{ USDmachineset_role }} effect: NoSchedule providerSpec: value: ami: id: {{ USDworker_ms.spec.template.spec.providerSpec.value.ami.id }} apiVersion: awsproviderconfig.openshift.io/v1beta1 blockDevices: - ebs: encrypted: true iops: 2000 kmsKey: arn: '' volumeSize: 500 volumeType: io1 credentialsSecret: name: aws-cloud-credentials deviceIndex: 0 instanceType: {{ USDworker_ms.spec.template.spec.providerSpec.value.instanceType }} iamInstanceProfile: id: {{ USDinfrastructure_id }}-worker-profile kind: AWSMachineProviderConfig placement: availabilityZone: {{ USDzone }} region: {{ USDregion }} securityGroups: - filters: - name: tag:Name values: - {{ USDinfrastructure_id }}-worker-sg subnet: filters: - name: tag:Name values: - {{ USDinfrastructure_id }}-private-{{ USDzone }} tags: - name: kubernetes.io/cluster/{{ USDinfrastructure_id }} value: owned userDataSecret: name: worker-user-data {{- end }}
create -f policy.yaml -n <policy-namespace>
apiVersion: policy.open-cluster-management.io/v1 kind: Policy metadata: name: policy1 spec: remediationAction: "enforce" # or inform disabled: false # or true namespaceSelector: include: - "default" - "my-namespace" policy-templates: - objectDefinition: apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: operator # namespace: # will be supplied by the controller via the namespaceSelector spec: remediationAction: "inform" object-templates: - complianceType: "musthave" # at this level, it means the role must exist and must have the following rules apiVersion: rbac.authorization.k8s.io/v1 kind: Role metadata: name: example objectDefinition: rules: - complianceType: "musthave" # at this level, it means if the role exists the rule is a musthave apiGroups: ["extensions", "apps"] resources: ["deployments"] verbs: ["get", "list", "watch", "create", "delete","patch"]
apiVersion: policy.open-cluster-management.io/v1 kind: PlacementBinding metadata: name: binding1 placementRef: name: placement1 apiGroup: cluster.open-cluster-management.io kind: Placement subjects: - name: policy1 apiGroup: policy.open-cluster-management.io kind: Policy
get policies.policy.open-cluster-management.io <policy-name> -n <policy-namespace> -o yaml
describe policies.policy.open-cluster-management.io <policy-name> -n <policy-namespace>
apiVersion: policy.open-cluster-management.io/v1 kind: Policy metadata: name: policy-pod annotations: policy.open-cluster-management.io/categories: 'SystemAndCommunicationsProtections,SystemAndInformationIntegrity' policy.open-cluster-management.io/controls: 'control example' policy.open-cluster-management.io/standards: 'NIST,HIPAA' policy.open-cluster-management.io/description: spec: complianceType: musthave namespaces: exclude: ["kube*"] include: ["default"] pruneObjectBehavior: None object-templates: - complianceType: musthave objectDefinition: apiVersion: v1 kind: Pod metadata: name: pod1 spec: containers: - name: pod-name image: 'pod-image' ports: - containerPort: 80 remediationAction: enforce disabled: false
apiVersion: policy.open-cluster-management.io/v1 kind: PlacementBinding metadata: name: binding-pod placementRef: name: placement-pod kind: Placement apiGroup: cluster.open-cluster-management.io subjects: - name: policy-pod kind: Policy apiGroup: policy.open-cluster-management.io
apiVersion: cluster.open-cluster-management.io/v1beta1 kind: Placement metadata: name: placement-pod spec: predicates: - requiredClusterSelector: labelSelector: matchLabels: cloud: "IBM"
apply -f <policyset-filename>
edit policysets <your-policyset-name>
apply -f <your-added-policy.yaml>
delete policies.policy.open-cluster-management.io <policy-name> -n <policy-namespace>
create -f configpolicy-1.yaml
apiVersion: policy.open-cluster-management.io/v1 kind: Policy metadata: name: policy-1 namespace: my-policies policy-templates: - apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: mustonlyhave-configuration spec: namespaceSelector: include: ["default"] exclude: ["kube-system"] remediationAction: inform disabled: false complianceType: mustonlyhave object-templates:
apply -f <policy-file-name> --namespace=<namespace>
get policies.policy.open-cluster-management.io --namespace=<namespace>
get policies.policy.open-cluster-management.io <policy-name> -n <namespace> -o yaml
describe policies.policy.open-cluster-management.io <name> -n <namespace>
delete policies.policy.open-cluster-management.io <policy-name> -n <namespace>
get policies.policy.open-cluster-management.io <policy-name> -n <namespace>
apiVersion: policy.open-cluster-management.io/v1 kind: Policy metadata: name: policy-configure-subscription-admin-hub annotations: policy.open-cluster-management.io/standards: NIST SP 800-53 policy.open-cluster-management.io/categories: CM Configuration Management policy.open-cluster-management.io/controls: CM-2 Baseline Configuration spec: remediationAction: inform disabled: false policy-templates: - objectDefinition: apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: policy-configure-subscription-admin-hub spec: remediationAction: inform severity: low object-templates: - complianceType: musthave objectDefinition: apiVersion: rbac.authorization.k8s.io/v1 kind: ClusterRole metadata: name: open-cluster-management:subscription-admin rules: - apiGroups: - app.k8s.io resources: - applications verbs: - '*' - apiGroups: - apps.open-cluster-management.io resources: - '*' verbs: - '*' - apiGroups: - "" resources: - configmaps - secrets - namespaces verbs: - '*' - complianceType: musthave objectDefinition: apiVersion: rbac.authorization.k8s.io/v1 kind: ClusterRoleBinding metadata: name: open-cluster-management:subscription-admin roleRef: apiGroup: rbac.authorization.k8s.io kind: ClusterRole name: open-cluster-management:subscription-admin subjects: - apiGroup: rbac.authorization.k8s.io kind: User name: kube:admin - apiGroup: rbac.authorization.k8s.io kind: User name: system:admin --- apiVersion: policy.open-cluster-management.io/v1 kind: PlacementBinding metadata: name: binding-policy-configure-subscription-admin-hub placementRef: name: placement-policy-configure-subscription-admin-hub kind: Placement apiGroup: cluster.open-cluster-management.io subjects: - name: policy-configure-subscription-admin-hub kind: Policy apiGroup: policy.open-cluster-management.io --- apiVersion: cluster.open-cluster-management.io/v1beta1 kind: Placement metadata: name: placement-policy-configure-subscription-admin-hub spec: predicates: - requiredClusterSelector: labelSelector: matchExpressions: - {key: name, operator: In, values: ["local-cluster"]}
apply -f policy-configure-subscription-admin-hub.yaml
apiVersion: cluster.open-cluster-management.io/v1beta2 kind: ManagedClusterSetBinding metadata: name: default namespace: policies spec: clusterSet: default
apply -f managed-cluster.yaml
kustomize build --enable-alpha-plugins | oc apply -f -
apiVersion: policy.open-cluster-management.io/v1 kind: Policy metadata: name: install-quay namespace: open-cluster-management-global-set spec: disabled: false policy-templates: - objectDefinition: apiVersion: policy.open-cluster-management.io/v1beta1 kind: OperatorPolicy metadata: name: install-quay spec: remediationAction: enforce severity: critical complianceType: musthave upgradeApproval: None subscription: channel: stable-3.11 name: quay-operator source: redhat-operators sourceNamespace: openshift-marketplace
-n <managed cluster namespace> get operatorpolicy install-quay
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: moderate-compliance-scan namespace: default spec: dependencies: 1 - apiVersion: policy.open-cluster-management.io/v1 compliance: Compliant kind: Policy name: upstream-compliance-operator namespace: default disabled: false policy-templates: - extraDependencies: 2 - apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy name: scan-setting-prerequisite compliance: Compliant ignorePending: false 3 objectDefinition: apiVersion: policy.open-cluster-management.io/v1 kind: ConfigurationPolicy metadata: name: moderate-compliance-scan spec: object-templates: - complianceType: musthave objectDefinition: apiVersion: compliance.openshift.io/v1alpha1 kind: ScanSettingBinding metadata: name: moderate namespace: openshift-compliance profiles: - apiGroup: compliance.openshift.io/v1alpha1 kind: Profile name: ocp4-moderate - apiGroup: compliance.openshift.io/v1alpha1 kind: Profile name: ocp4-moderate-node settingsRef: apiGroup: compliance.openshift.io/v1alpha1 kind: ScanSetting name: default remediationAction: enforce severity: low