The gatekeeper component facilitates the management and enforcement of policies executed by Open Policy Agent (OPA) in Kubernetes clusters. This allows you to manage the labels of namespaces. This topic describes the features and usage notes of gatekeeper. It also lists the latest changes to gatekeeper.

Introduction

OPA is an open source policy engine that is commonly used to implement policies in stacks in a standardized and context-aware manner. You can use the gatekeeper component to manage and implement OPA policies, and manage labels of namespaces in ACK clusters. For more information about OPA, see Open Policy Agent. The following figure shows the architecture of gatekeeper.

Component architecture

Usage notes

You can use gatekeeper to constrain pod deployments in specified namespaces based on labels. In this example, a Constraint is defined to declare that all pods created in a specified namespace must be labeled with gatekeeper-test-label. For more information about how to use gatekeeper, see Use gatekeeper.

  1. Run the following commands in sequence to create a test-gatekeeper namespace and add the name=test-gatekeeper label to the namespace:
    kubectl create ns test-gatekeeper
    kubectl label ns test-gatekeeper name=test-gatekeeper
  2. Run the following command to create a Constraint template that can be used to define Constraints on pod labels:
    kubectl apply -f - <<EOF
    apiVersion: templates.gatekeeper.sh/v1beta1
    kind: ConstraintTemplate
    metadata:
      name: k8srequiredlabels
    spec:
      crd:
        spec:
          names:
            kind: K8sRequiredLabels
          validation:
            openAPIV3Schema:
              properties:
                labels:
                  type: array
                  items:
                    type: string
      targets:
        - target: admission.k8s.gatekeeper.sh
          rego: |
            package k8srequiredlabels
            violation[{"msg": msg, "details": {"missing_labels": missing}}] {
              provided := {label | input.review.object.metadata.labels[label]}
              required := {label | label := input.parameters.labels[_]}
              missing := required - provided
              count(missing) > 0
              msg := sprintf("you must provide labels: %v", [missing])
            }
    EOF
    It requires about 10 seconds to initialize the Constraint template.
  3. Run the following command to create a Constraint from the preceding Constraint template. This Constraint declares that all pods created in a namespace that is added with the name=test-gatekeeper label must be labeled with gatekeeper-test-label.
    kubectl apply -f - <<EOF
    apiVersion: constraints.gatekeeper.sh/v1beta1
    kind: K8sRequiredLabels
    metadata:
      name: pod-must-have-gatekeeper-test-label
    spec:
      match:
        kinds:
          - apiGroups: [""]
            kinds: ["Pod"]
        namespaceSelector:
          matchExpressions:
          - key: name
            operator: In
            values: ["test-gatekeeper"]
      parameters:
        labels: ["gatekeeper-test-label"]
    
    EOF
    It takes about 10 seconds to initialize the Constraint.
  4. Check whether the namespace is constrained.
    • Run the following command to create a pod that is not labeled with gatekeeper-test-label in the test-gatekeeper namespace. The test-gatekeeper namespace is added with the name=test-gatekeeper label.
      kubectl -n test-gatekeeper run test-deny --image=nginx --restart=Never

      Expected output:

      Error from server ([denied by pod-must-have-gatekeeper-test-label] you must provide labels: {"gatekeeper-test-label"}): admission webhook "validation.gatekeeper.sh" denied the request: [denied by pod-must-have-gatekeeper-test-label] you must provide labels: {"gatekeeper-test-label"}

      The test-gatekeeper namespace is added with the name=test-gatekeeper label. The pod is to be created without the gatekeeper-test-label label. Therefore, the creation fails.

    • Run the following command to create a pod that is labeled with gatekeeper-test-label in the test-gatekeeper namespace. The test-gatekeeper namespace is added with the name=test-gatekeeper label.
      kubectl -n test-gatekeeper run test-pass -l gatekeeper-test-label=pass --image=nginx --restart=Never

      Expected output:

      pod/test-pass created

      The test-gatekeeper namespace is added with the name=test-gatekeeper label. The pod is to be created with the gatekeeper-test-label label. Therefore, the creation succeeds.

    • Run the following command to create a pod that is not labeled with name=test-gatekeeper in a namespace that is not subject to the Constraint:
      kubectl -n default run test-deny --image=nginx --restart=Never

      Expected output:

      pod/test-deny created

      The namespace is not subject to the Constraint. Therefore, the creation succeeds. The created pod is not added with the name=test-gatekeeper label.

    The preceding steps show that gatekeeper can be used to constrain pod creations in a specific namespace. In this example, the pod to be created in the namespace must be added with the gatekeeper-test-label label.

Release notes

January 2022

Version Image address Release date Description Impact
v3.7.0.82-gafe4391b-aliyun registry.cn-hangzhou.aliyuncs.com/acs/gatekeeper:v3.7.0.82-gafe4391b-aliyun 2022-01-14

This image version is in canary release.

  • OPA Gatekeeper is upgraded to V3.7.0. The gatekeeper component is dependent on OPA Gatekeeper. For more information about OPA Gatekeeper V3.7.0, see Releases V3.7.0.
  • Support for ARM 64 architecture.
If exceptions occur during the component upgrade, changes to cluster resources may fail. We recommend that you perform the upgrade during off-peak hours.

September 2021

Version Image address Release date Description Impact
v3.6.0.62-g156146d-aliyun registry.cn-hangzhou.aliyuncs.com/acs/gatekeeper:v3.6.0.62-g156146d-aliyun 2021-09-20
  • gatekeeper V3.6.0.62 and later versions support only ACK clusters of Kubernetes V1.16.9 and later.
  • OPA Gatekeeper is upgraded to V3.6.0. The gatekeeper component is dependent on OPA Gatekeeper. For more information about OPA Gatekeeper V3.6.0, see Releases V3.6.0.
If exceptions occur during the component upgrade, changes to cluster resources may fail. We recommend that you perform the upgrade during off-peak hours.

March 2021

Version Image address Release date Description Impact
v3.3.0.24-8e68abc-aliyun registry.cn-hangzhou.aliyuncs.com/acs/gatekeeper:v3.3.0.24-8e68abc-aliyun 2021-03-16
  • gatekeeper can be installed in registered Kubernetes clusters.
  • OPA Gatekeeper is upgraded to V3.3.0. The gatekeeper component is dependent on OPA Gatekeeper.
If exceptions occur during the component upgrade, changes to cluster resources may fail. We recommend that you perform the upgrade during off-peak hours.

August 2020

Version Image address Release date Description Impact
v3.1.0.11-24bab09-aliyun registry.cn-hangzhou.aliyuncs.com/acs/gatekeeper:v3.1.0.11-24bab09-aliyun 2020-08-20 OPA Gatekeeper is upgraded to V3.1.0-beta.12. The gatekeeper component is dependent on OPA Gatekeeper.
Note OPA Gatekeeper is an open source project based on which gatekeeper is developed.
If exceptions occur during the component upgrade, changes to cluster resources may fail. We recommend that you perform the upgrade during off-peak hours.