[WIP] Two step admission deocumentation

kubernetes-sigs · Oct 5, 2023 · 9c4deab · 9c4deab
1 parent f3bb6f2
commit 9c4deab
Show file tree

Hide file tree

Showing 5 changed files with 53 additions and 7 deletions.
diff --git a/site/content/en/docs/concepts/_index.md b/site/content/en/docs/concepts/_index.md
@@ -34,18 +34,25 @@ single tenant.
 An application that will run to completion. It is the unit of _admission_ in
 Kueue. Sometimes referred to as _job_.
 
+### [Admission Check]()
+
+### [Preemption Admission Check Controller]()
+
 ![Components](/images/queueing-components.svg)
 
 ## Glossary
 
-### Admission
-
-The process of admitting a Workload to start (Pods to be created). A Workload
-is admitted by a ClusterQueue according to the available resources and gets
-resource flavors assigned for each requested resource.
+### Quota Reservation
 
 Sometimes referred to as _workload scheduling_ or _job scheduling_
 (not to be confused with [pod scheduling](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/)).
+Is the process during which the kueue scheduler locks the resources needed by a workload within the targeted [ClusterQueues ResourceGroups](/docs/concepts/cluster_queue/#resource-groups)
+
+### Admission
+
+The process of admitting a Workload to start (Pods to be created). A Workload
+is admitted when it has a Quota Reservation and all it's potential AdmissionCheckStates
+are `Ready`.
 
 ### [Cohort](/docs/concepts/cluster_queue#cohort)
 

diff --git a/site/content/en/docs/concepts/admission_check.md b/site/content/en/docs/concepts/admission_check.md
@@ -0,0 +1,7 @@
+---
+title: "Admission Check"
+date: 2023-10-05
+weight: 6
+description: >
+  Desc.
+---
diff --git a/site/content/en/docs/concepts/cluster_queue.md b/site/content/en/docs/concepts/cluster_queue.md
@@ -304,8 +304,10 @@ borrow `12+9` CPUs.
 ## Preemption
 
 When there is not enough quota left in a ClusterQueue or its cohort, an incoming
-Workload can trigger preemption of previously admitted Workloads, based on
-policies for the ClusterQueue.
+Workload can still get a Quota Reservation, based on policies for the ClusterQueue
+and the workloads priority. Following this the builtin 
+[Preemption Admission Check Controller]() will manage the eviction of its Preemption
+targets and admission check state.
 
 A configuration for a ClusterQueue that enables preemption looks like the
 following:

diff --git a/site/content/en/docs/concepts/preemption_controller.md b/site/content/en/docs/concepts/preemption_controller.md
@@ -0,0 +1,8 @@
+---
+title: "Preemption Admission Check Controller"
+date: 2023-10-05
+weight: 7
+description: >
+  Desc.
+---
+
diff --git a/site/static/examples/sample-admission-check.yaml b/site/static/examples/sample-admission-check.yaml
@@ -0,0 +1,22 @@
+apiVersion: kueue.x-k8s.io/v1beta1
+kind: AdmissionCheck
+metadata:
+  name: prov-test
+spec:
+  controllerName: ProvisioningRequestController
+  parameters:
+    apiGroup: kueue.x-k8s.io
+    kind: ProvisioningRequestConfig
+    name: prov-test-config
+
+---
+
+
+apiVersion: kueue.x-k8s.io/v1beta1
+kind: ProvisioningRequestConfig
+metadata:
+  name: prov-test-config
+spec:
+  provisioningClassName: test-class
+  parameters:
+    parma1: value1