Skip to main content
Version: v2.6

OPA Gatekeeper

To ensure consistency and compliance, every organization needs the ability to define and enforce policies in its environment in an automated way. OPA (Open Policy Agent) is a policy engine that facilitates policy-based control for cloud native environments. Rancher provides the ability to enable OPA Gatekeeper in Kubernetes clusters, and also installs a couple of built-in policy definitions, which are also called constraint templates.

OPA provides a high-level declarative language that lets you specify policy as code and ability to extend simple APIs to offload policy decision-making.

OPA Gatekeeper is a project that provides integration between OPA and Kubernetes. OPA Gatekeeper provides:

  • An extensible, parameterized policy library.
  • Native Kubernetes CRDs for instantiating the policy library, also called “constraints."
  • Native Kubernetes CRDs for extending the policy library, also called "constraint templates."
  • Audit functionality.

To read more about OPA, please refer to the official documentation.

How the OPA Gatekeeper Integration Works​

Kubernetes provides the ability to extend API server functionality via admission controller webhooks, which are invoked whenever a resource is created, updated or deleted. Gatekeeper is installed as a validating webhook and enforces policies defined by Kubernetes custom resource definitions. In addition to the admission control usage, Gatekeeper provides the capability to audit existing resources in Kubernetes clusters and mark current violations of enabled policies.

OPA Gatekeeper is made available via Rancher's Helm system chart, and it is installed in a namespace named gatekeeper-system.

Enabling OPA Gatekeeper in a Cluster​

note

In Rancher v2.5, the OPA Gatekeeper application was improved. The Rancher v2.4 feature can't be upgraded to the new version in Rancher v2.5. If you installed OPA Gatekeeper in Rancher v2.4, you will need to uninstall OPA Gatekeeper and its CRDs from the old UI, then reinstall it in Rancher v2.5. To uninstall the CRDs run the following command in the kubectl console kubectl delete crd configs.config.gatekeeper.sh constrainttemplates.templates.gatekeeper.sh.

Prerequisite:

Only administrators and cluster owners can enable OPA Gatekeeper.

Enabling OPA Gatekeeper​

  1. In the upper left corner, click ☰ > Cluster Management.
  2. In the Clusters page, go to the cluster where you want to enable OPA Gatekeeper and click Explore.
  3. In the left navigation bar, click Apps.
  4. Click Charts and click OPA Gatekeeper.
  5. Click Install.

Result: OPA Gatekeeper is deployed in your Kubernetes cluster.

Constraint Templates​

Constraint templates are Kubernetes custom resources that define the schema and Rego logic of the OPA policy to be applied by Gatekeeper. For more information on the Rego policy language, refer to the official documentation.

When OPA Gatekeeper is enabled, Rancher installs some templates by default.

To list the constraint templates installed in the cluster, go to the left side menu under OPA Gatekeeper and click on Templates.

Rancher also provides the ability to create your own constraint templates by importing YAML definitions.

Creating and Configuring Constraints​

Constraints are Kubernetes custom resources that define the scope of objects to which a specific constraint template applies to. The complete policy is defined by constraint templates and constraints together.

Prerequisite:

OPA Gatekeeper must be enabled in the cluster.

To list the constraints installed, go to the left side menu under OPA Gatekeeper, and click on Constraints.

New constraints can be created from a constraint template.

Rancher provides the ability to create a constraint by using a convenient form that lets you input the various constraint fields.

The Edit as yaml option is also available to configure the the constraint's yaml definition.

Exempting Rancher's System Namespaces from Constraints​

When a constraint is created, ensure that it does not apply to any Rancher or Kubernetes system namespaces. If the system namespaces are not excluded, then it is possible to see many resources under them marked as violations of the constraint.

To limit the scope of the constraint only to user namespaces, always specify these namespaces under the Match field of the constraint.

Also, the constraint may interfere with other Rancher functionality and deny system workloads from being deployed. To avoid this, exclude all Rancher-specific namespaces from your constraints.

Enforcing Constraints in your Cluster​

When the Enforcement Action is Deny, the constraint is immediately enabled and will deny any requests that violate the policy defined. By default, the enforcement value is Deny.

When the Enforcement Action is Dryrun, then any resources that violate the policy are only recorded under the constraint's status field.

To enforce constraints, create a constraint using the form. In the Enforcement Action field, choose Deny.

Audit and Violations in your Cluster​

OPA Gatekeeper runs a periodic audit to check if any existing resource violates any enforced constraint. The audit-interval (default 300s) can be configured while installing Gatekeeper.

On the Gatekeeper page, any violations of the defined constraints are listed.

Also under Constraints, the number of violations of the constraint can be found.

The detail view of each constraint lists information about the resource that violated the constraint.

Disabling Gatekeeper​

  1. Navigate to the cluster's Dashboard view
  2. On the left side menu, expand the cluster menu and click on OPA Gatekeeper.
  3. Click the ⋮ > Disable.

Result: Upon disabling OPA Gatekeeper, all constraint templates and constraints will also be deleted.