Awesome

Policy Collection

A collection of policy examples for Open Cluster Management.

Important: The PlacementRule resource has been deprecated so policy users must begin moving to the Placement API instead. See the Transitioning from PlacementRule(deprecated) to Placement that provides details below to learn how to begin using Placement. Policies will no longer include placement details as part of contributions since placement resources can be shared to avoid duplication and to allow users to choose different ways of including placement with gitops.

Repository structure

This repository hosts policies for Open Cluster Management. You can deploy these policies using Open Cluster Management which includes a policy framework that is available as an addon. Policies are organized in two ways:

By support expectations which are detailed below.
By NIST Special Publication 800-53.

The following folders are used to separate policies by the support expectations:

stable -- Policies in the stable folder are contributions that are being supported by the Open Cluster Management Policy SIG.
3rd-party -- Policies in the 3rd-party folder are contributions that are being supported, but not by the Open Cluster Management Policy SIG. See the details of the policy to understand the support being provided.
community -- Policies in the community folder are contributed from the open source community. Contributions should start in the community.

In addition to policy contributions, there is the option to contribute groups of policies as a set. This is known as PolicySets and these contributions are made in directories organized as PolicyGenerator projects. The folder containing these contributions is located here: PolicySet projects.

Using GitOps to deploy policies to a cluster

Fork this repository and use the forked version as the target to run the sync. This avoids unintended changes to your cluster. To get the latest policies from the policy-collection repository, pull the latest changes from policy-collection and then create a pull request to merge these changes into your forked repository. Any further changes to your repository will be applied to your cluster automatically.

Make sure you have kubectl installed and that you are logged into your hub cluster in terminal.

Run kubectl create ns policies to create a "policies" ns on hub. If you prefer to call the namespace something else, you can run kubectl create ns <custom ns> instead.

From within this directory in terminal, run cd deploy to access the deployment directory, then run bash ./deploy.sh -u <url> -p <path> -n <namespace>. (Details on all of the parameters for this command can be viewed in its README.) This script assumes you have enabled Application lifecycle management as an addon in your Open Cluster Management installation. See Application lifecycle management for details on installing the Application addon. Note: If you are using ArgoCD for gitops, a similar script argoDeploy.sh is provided that does not require the Application Lifecycle addon.

Subscription Administrator

In new versions of Open Cluster Management you must be a subscription administrator in order to deploy policies using a subscription. In these cases the subscription is still successfully created, but policy resources are not distributed as expected. You can view the status of the subscription to see the subscription errors. If the subscription administrator role is required, a message similar to the following one appears for any resource that is not created:

        demo-stable-policies-chan-Policy-policy-cert-ocp4:
          lastUpdateTime: "2021-10-15T20:37:59Z"
          phase: Failed
          reason: 'not deployed by a subscription admin. the resource apiVersion: policy.open-cluster-management.io/v1 kind: Policy is not deployed'

To become a subscription administrator, you must add an entry for your user to the ClusterRoleBinding named open-cluster-management:subscription-admin. A new entry may look like the following:

subjects:
  - kind: User
    apiGroup: rbac.authorization.k8s.io
    name: my-username

After updating the ClusterRoleBinding, you need to delete the subscription and deploy the subscription again.

Policy Generator

GitOps through Open Cluster Management is able to handle Kustomize files, so you can also use the Policy Generator Kustomize plugin to generate policies from Kubernetes manifests in your repository. The Policy Generator handles Kubernetes manifests as well as policy engine manifests from policy engines like Gatekeeper and Kyverno.

For additional information about the Policy Generator:

Distributing Policies to Managed Clusters

Distributing a Policy to a managed cluster requires four parts, all of which must be in the same namespace:

Policy is a grouping mechanism for Policy Templates and is the smallest deployable unit on the hub cluster. Embedded Policy Templates are distributed to applicable managed clusters and acted upon by the appropriate policy controller.
PlacementBinding binds a Placement to a Policy or PolicySet.
Placement: Dynamically selects a set of ManagedClusters in one or multiple ManagedClusterSets.
ManagedClusterSetBinding: Binds a ManagedClusterSet to a namespace, making this group of managed clusters available for selection by Placement.

When the Policy is bound to a Placement using a PlacementBinding, the Policy is distributed to the managed clusters and the Policy status will report on each cluster returned by the bound Placement.

Using `Placement` with `Policies`

See the Placement documentation for additional details on selecting managed clusters using Placement.

NOTE: PlacementRule is deprecated. See the migration section for detail on migrating to Placement.

To use Placement to distribute Policies, bind the Policy to the Placement using a PlacementBinding. All of the objects must be in the same namespace. View the following sample Placement and PlacementBinding bound to a Policy named policy-example in the namespace example-ns. The Placement selects managed clusters that have the label environment: dev:

apiVersion: cluster.open-cluster-management.io/v1beta1
kind: Placement
metadata:
  name: placement-policy-example
  namespace: example-ns
spec:
  predicates:
    - requiredClusterSelector:
        labelSelector:
          matchExpressions:
            - { key: environment, operator: In, values: ["dev"] }
---
apiVersion: policy.open-cluster-management.io/v1
kind: PlacementBinding
metadata:
  name: binding-policy-example
  namespace: example-ns
placementRef:
  name: placement-policy-example
  kind: Placement
  apiGroup: cluster.open-cluster-management.io
subjects:
  - name: policy-example
    kind: Policy
    apiGroup: policy.open-cluster-management.io

Transitioning from `PlacementRule`(deprecated) to `Placement`

PlacementRule had unrestricted access to selecting managed clusters. However, Placement requires binding managed clusters to the Policy namespace in order for Policies to be distributed to those managed clusters, bringing an additional layer of control to system administrators. View the following steps on migrating from PlacementRule to Placement:

The desired managed clusters must be contained in a ManagedClusterSet. See the ManagedClusterSet documentation to read more, including the default sets that are available that include all managed clusters that would replicate PlacementRule behavior.
Create a ManagedClusterSetBinding to bind the ManagedClusterSet to the namespace where you are authoring policies. See the ManagedClusterSet documentation.

Create the Placement manifest to replace the PlacementRule. To do this, take the selector spec.clusterSelector from the PlacementRule and put it into spec.predicates.requiredClusterSelector.labelSelector. For example, to select managed clusters with the label environment: dev:

apiVersion: cluster.open-cluster-management.io/v1beta1
kind: Placement
metadata:
  name: placement-policy-example
  namespace: example-ns // Ensure this namespace matches the ManagedClusterSetBinding
spec:
  predicates:
  - requiredClusterSelector:
      labelSelector:
        matchExpressions: // From PlacementRule
        - {key: environment, operator: In, values: ["dev"]}

See the Placement documentation for additional details on selecting managed clusters using Placement.

Identify any PlacementBinding resources that reference a PlacementRule. Update the PlacementBinding to reference the new Placement:

Change the placementRef.kind to Placement
Update the placementRef.apiGroup to cluster.open-cluster-management.io to reflect the Placement's API version

View the following sample PlacementBinding that references a Placement:

apiVersion: policy.open-cluster-management.io/v1
kind: PlacementBinding
metadata:
  name: binding-policy-example
placementRef:
  apiGroup: cluster.open-cluster-management.io // Set to cluster.open-cluster-management.io
  kind: Placement                              // Set to Placement
  name: placement-policy-example
subjects:
  - name: policy-example
    kind: Policy
    apiGroup: policy.open-cluster-management.io

Community, discussion, contribution, and support

Check the Contributing policies document for guidelines on how to contribute to the repository.

Blogs: Read our blogs that are in the blogs folder.

Resources: View the following resources for more information on the components and mechanisms are implemented in the product governance framework.

Open Cluster Management Quick Start