Setup a Job Admission Policy
This page shows how you can set up for Kueue a Job Admission Policy using the Kubernetes Validating Admission Policy, based on the Common Expression Language (CEL).
Before you begin
Ensure the following conditions are met:
- A Kubernetes cluster is running.
- The kubectl command-line tool can communicate with your cluster.
- Kueue is installed.
Example
The example below shows you how to set up the Job Admission Policy to reject early all Job or JobSets
without the queue-name if sent to a namespace labeled as a kueue-managed
namespace.
You should set manageJobsWithoutQueueName
to false
in the Kueue Configuration to let an admin
to execute Jobs in any namespace that is not labeled as kueue-managed
. Jobs sent to unlabeled namespaces aren’t rejected, or managed
by Kueue.
apiVersion: admissionregistration.k8s.io/v1
kind: ValidatingAdmissionPolicy
metadata:
name: sample-validating-admission-policy
spec:
failurePolicy: Fail
matchConstraints:
resourceRules:
- apiGroups: ["batch"]
apiVersions: ["v1"]
operations: ["CREATE", "UPDATE"]
resources: ["jobs"]
- apiGroups: ["jobset.x-k8s.io"]
apiVersions: ["v1alpha2"]
operations: ["CREATE", "UPDATE"]
resources: ["jobsets"]
validations:
- expression: "has(object.metadata.labels) && 'kueue.x-k8s.io/queue-name' in object.metadata.labels && object.metadata.labels['kueue.x-k8s.io/queue-name'] != ''"
message: "The label 'kueue.x-k8s.io/queue-name' is either missing or does not have a value set."
To create the policy, download the above file and run the following command:
kubectl create -f sample-validating-policy.yaml
Then, apply the validating admission policy to the namespace by creating a ValidatingAdmissionPolicyBinding
. The policy binding links the namespaces to the defined admission policy and it instructs Kubernetes how to respond to the validation outcome.
The following is an example of a policy binding:
apiVersion: admissionregistration.k8s.io/v1
kind: ValidatingAdmissionPolicyBinding
metadata:
name: sample-validating-admission-policy-binding
spec:
policyName: sample-validating-admission-policy
validationActions: [Deny]
matchResources:
namespaceSelector:
matchLabels:
kueue-managed: "true"
To create the binding, download the above file and run the following command:
kubectl create -f sample-validating-policy-binding.yaml
Run the following command to label each namespace where you want this policy to be enforced:
kubectl label namespace my-user-namespace 'kueue-managed=true'
Now, when you try to create a Job
or a JobSet
without the kueue.x-k8s.io/queue-name
label or value in any namespace
that is labeled as kueue-managed
, the error message will be similar to the following:
ValidatingAdmissionPolicy 'sample-validating-admission-policy' with binding 'sample-validating-admission-policy-binding' denied request: The label 'kueue.x-k8s.io/queue-name' is either missing or does not have a value set.
Feedback
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.