Merge pull request #70653 from bergerhoffer/OSDOCS-8969

bergerhoffer · web-flow · commit 9b7d992f9378 · 2024-01-24T15:22:31.000-05:00
OSDOCS#8969: Restructuring docs for the descheduler operator being async
diff --git a/_attributes/common-attributes.adoc b/_attributes/common-attributes.adoc
@@ -58,6 +58,7 @@ endif::openshift-origin[]
 :cert-manager-operator: cert-manager Operator for Red Hat OpenShift
 :secondary-scheduler-operator-full: Secondary Scheduler Operator for Red Hat OpenShift
 :secondary-scheduler-operator: Secondary Scheduler Operator
+:descheduler-operator: Kube Descheduler Operator
 // Backup and restore
 :velero-domain: velero.io
 :velero-version: 1.12
diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml
@@ -2375,8 +2375,18 @@ Topics:
 #   File: nodes-scheduler-node-projects
 # - Name: Keeping your cluster balanced using the descheduler
 #   File: nodes-scheduler-descheduler
-  - Name: Evicting pods using the descheduler
-    File: nodes-descheduler
+  - Name: Descheduler
+    Dir: descheduler
+    Distros: openshift-enterprise
+    Topics:
+    - Name: Descheduler overview
+      File: index
+    - Name: Descheduler release notes
+      File: nodes-descheduler-release-notes
+    - Name: Evicting pods using the descheduler
+      File: nodes-descheduler-configuring
+    - Name: Uninstalling the descheduler
+      File: nodes-descheduler-uninstalling
   - Name: Secondary scheduler
     Dir: secondary_scheduler
     Distros: openshift-enterprise
diff --git a/_topic_maps/_topic_map_osd.yml b/_topic_maps/_topic_map_osd.yml
@@ -888,8 +888,17 @@ Topics:
 #   File: nodes-scheduler-node-projects
 # - Name: Keeping your cluster balanced using the descheduler
 #   File: nodes-scheduler-descheduler
-  - Name: Evicting pods using the descheduler
-    File: nodes-descheduler
+  - Name: Descheduler
+    Dir: descheduler
+    Topics:
+    - Name: Descheduler overview
+      File: index
+    - Name: Descheduler release notes
+      File: nodes-descheduler-release-notes
+    - Name: Evicting pods using the descheduler
+      File: nodes-descheduler-configuring
+    - Name: Uninstalling the descheduler
+      File: nodes-descheduler-uninstalling
   - Name: Secondary scheduler
     Dir: secondary_scheduler
     Distros: openshift-enterprise
diff --git a/modules/nodes-descheduler-about.adoc b/modules/nodes-descheduler-about.adoc
@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * nodes/scheduling/nodes-descheduler.adoc
+// * nodes/scheduling/descheduler/index.adoc
 
 :_mod-docs-content-type: CONCEPT
 [id="nodes-descheduler-about_{context}"]
diff --git a/modules/nodes-descheduler-configuring-interval.adoc b/modules/nodes-descheduler-configuring-interval.adoc
@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * nodes/scheduling/nodes-descheduler.adoc
+// * nodes/scheduling/descheduler/nodes-descheduler-configuring.adoc
 
 :_mod-docs-content-type: PROCEDURE
 [id="nodes-descheduler-configuring-interval_{context}"]
diff --git a/modules/nodes-descheduler-configuring-profiles.adoc b/modules/nodes-descheduler-configuring-profiles.adoc
@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * nodes/scheduling/nodes-descheduler.adoc
+// * nodes/scheduling/descheduler/nodes-descheduler-configuring.adoc
 
 :_mod-docs-content-type: PROCEDURE
 [id="nodes-descheduler-configuring-profiles_{context}"]
diff --git a/modules/nodes-descheduler-installing.adoc b/modules/nodes-descheduler-installing.adoc
@@ -1,8 +1,8 @@
 // Module included in the following assemblies:
 //
-// * nodes/scheduling/nodes-descheduler.adoc
+// * nodes/scheduling/descheduler/nodes-descheduler-configuring.adoc
 
-ifeval::["{context}" == "nodes-descheduler"]
+ifeval::["{context}" == "nodes-descheduler-about"]
 :nodes:
 endif::[]
 
@@ -14,7 +14,7 @@ endif::[]
 [id="nodes-descheduler-installing_{context}"]
 = Installing the descheduler
 
-The descheduler is not available by default. To enable the descheduler, you must install the Kube Descheduler Operator from OperatorHub and enable one or more descheduler profiles.
+The descheduler is not available by default. To enable the descheduler, you must install the {descheduler-operator} from OperatorHub and enable one or more descheduler profiles.
 
 By default, the descheduler runs in predictive mode, which means that it only simulates pod evictions. You must change the mode to automatic for the descheduler to perform the pod evictions.
 
@@ -41,18 +41,18 @@ endif::[]
 .Procedure
 
 . Log in to the {product-title} web console.
-. Create the required namespace for the Kube Descheduler Operator.
+. Create the required namespace for the {descheduler-operator}.
 .. Navigate to *Administration* -> *Namespaces* and click *Create Namespace*.
 .. Enter `openshift-kube-descheduler-operator` in the *Name* field, enter `openshift.io/cluster-monitoring=true` in the *Labels* field to enable descheduler metrics, and click *Create*.
-. Install the Kube Descheduler Operator.
+. Install the {descheduler-operator}.
 .. Navigate to *Operators* -> *OperatorHub*.
-.. Type *Kube Descheduler Operator* into the filter box.
-.. Select the *Kube Descheduler Operator* and click *Install*.
+.. Type *{descheduler-operator}* into the filter box.
+.. Select the *{descheduler-operator}* and click *Install*.
 .. On the *Install Operator* page, select *A specific namespace on the cluster*. Select *openshift-kube-descheduler-operator* from the drop-down menu.
 .. Adjust the values for the *Update Channel* and *Approval Strategy* to the desired values.
 .. Click *Install*.
 . Create a descheduler instance.
-.. From the *Operators* -> *Installed Operators* page, click the *Kube Descheduler Operator*.
+.. From the *Operators* -> *Installed Operators* page, click the *{descheduler-operator}*.
 .. Select the *Kube Descheduler* tab and click *Create KubeDescheduler*.
 .. Edit the settings as necessary.
 ... To evict pods instead of simulating the evictions, change the *Mode* field to *Automatic*.
@@ -105,7 +105,7 @@ This setting is experimental and should not be used in a production environment.
 You can also configure the profiles and settings for the descheduler later using the OpenShift CLI (`oc`). If you did not adjust the profiles when creating the descheduler instance from the web console, the `AffinityAndTaints` profile is enabled by default.
 endif::nodes[]
 
-ifeval::["{context}" == "nodes-descheduler"]
+ifeval::["{context}" == "nodes-descheduler-about"]
 :!nodes:
 endif::[]
 
diff --git a/modules/nodes-descheduler-profiles.adoc b/modules/nodes-descheduler-profiles.adoc
@@ -1,8 +1,8 @@
 // Module included in the following assemblies:
 //
-// * nodes/scheduling/nodes-descheduler.adoc
+// * nodes/scheduling/descheduler/index.adoc
 
-ifeval::["{context}" == "nodes-descheduler"]
+ifeval::["{context}" == "nodes-descheduler-about"]
 :nodes:
 endif::[]
 
@@ -73,7 +73,7 @@ Use the Technology Preview `DevPreviewLongLifecycle` profile to enable the desch
 ** A node is considered overutilized if its usage is above 50% for any of the thresholds (CPU, memory, and number of pods).
 endif::virt[]
 
-ifeval::["{context}" == "nodes-descheduler"]
+ifeval::["{context}" == "nodes-descheduler-about"]
 :!nodes:
 endif::[]
 
diff --git a/modules/nodes-descheduler-uninstalling.adoc b/modules/nodes-descheduler-uninstalling.adoc
@@ -1,12 +1,12 @@
 // Module included in the following assemblies:
 //
-// * nodes/scheduling/nodes-descheduler.adoc
+// * nodes/scheduling/descheduler/nodes-descheduler-uninstalling.adoc
 
 :_mod-docs-content-type: PROCEDURE
 [id="nodes-descheduler-uninstalling_{context}"]
 = Uninstalling the descheduler
 
-You can remove the descheduler from your cluster by removing the descheduler instance and uninstalling the Kube Descheduler Operator. This procedure also cleans up the `KubeDescheduler` CRD and `openshift-kube-descheduler-operator` namespace.
+You can remove the descheduler from your cluster by removing the descheduler instance and uninstalling the {descheduler-operator}. This procedure also cleans up the `KubeDescheduler` CRD and `openshift-kube-descheduler-operator` namespace.
 
 .Prerequisites
 
@@ -22,13 +22,13 @@ endif::openshift-rosa,openshift-dedicated[]
 
 . Log in to the {product-title} web console.
 . Delete the descheduler instance.
-.. From the *Operators* -> *Installed Operators* page, click *Kube Descheduler Operator*.
+.. From the *Operators* -> *Installed Operators* page, click *{descheduler-operator}*.
 .. Select the *Kube Descheduler* tab.
 .. Click the Options menu {kebab} next to the *cluster* entry and select *Delete KubeDescheduler*.
 .. In the confirmation dialog, click *Delete*.
-. Uninstall the Kube Descheduler Operator.
+. Uninstall the {descheduler-operator}.
 .. Navigate to *Operators* -> *Installed Operators*.
-.. Click the Options menu {kebab} next to the *Kube Descheduler Operator* entry and select *Uninstall Operator*.
+.. Click the Options menu {kebab} next to the *{descheduler-operator}* entry and select *Uninstall Operator*.
 .. In the confirmation dialog, click *Uninstall*.
 . Delete the `openshift-kube-descheduler-operator` namespace.
 .. Navigate to *Administration* -> *Namespaces*.
diff --git a/nodes/index.adoc b/nodes/index.adoc
@@ -96,7 +96,7 @@ The following list of tasks provides an overview of how an administrator can man
 // Cannot create namespace to install Operator
 ifndef::openshift-rosa,openshift-dedicated[]
 ** xref:../nodes/scheduling/secondary_scheduler/index.adoc#nodes-secondary-scheduler-about[Secondary scheduling].
-* xref:../nodes/scheduling/nodes-descheduler.adoc#nodes-descheduler[Configure the descheduler to evict pods] based on specific strategies so that the scheduler reschedules the pods to more appropriate nodes.
+* xref:../nodes/scheduling/descheduler/index.adoc#nodes-descheduler-about[Configure the descheduler to evict pods] based on specific strategies so that the scheduler reschedules the pods to more appropriate nodes.
 endif::openshift-rosa,openshift-dedicated[]
 * xref:../nodes/pods/nodes-pods-configuring.adoc#nodes-pods-configuring-restart_nodes-pods-configuring[Configure how pods behave after a restart using pod controllers and restart policies].
 * xref:../nodes/pods/nodes-pods-configuring.adoc#nodes-pods-configuring-bandwidth_nodes-pods-configuring[Limit both egress and ingress traffic on a pod].
diff --git a/nodes/scheduling/descheduler/_attributes b/nodes/scheduling/descheduler/_attributes
@@ -0,0 +1 @@
+../../../_attributes/
diff --git a/nodes/scheduling/descheduler/images b/nodes/scheduling/descheduler/images
@@ -0,0 +1 @@
+../../../images/
diff --git a/nodes/scheduling/descheduler/index.adoc b/nodes/scheduling/descheduler/index.adoc
@@ -0,0 +1,18 @@
+:_mod-docs-content-type: ASSEMBLY
+[id="nodes-descheduler-about"]
+= Descheduler overview
+include::_attributes/common-attributes.adoc[]
+:context: nodes-descheduler-about
+
+toc::[]
+
+While the xref:../../../nodes/scheduling/nodes-scheduler-about.adoc#nodes-scheduler-about[scheduler] is used to determine the most suitable node to host a new pod, the descheduler can be used to evict a running pod so that the pod can be rescheduled onto a more suitable node.
+
+:operator-name: The {descheduler-operator}
+include::snippets/operator-not-available.adoc[]
+
+// About the descheduler
+include::modules/nodes-descheduler-about.adoc[leveloffset=+1]
+
+// Descheduler profiles
+include::modules/nodes-descheduler-profiles.adoc[leveloffset=+1]
diff --git a/nodes/scheduling/descheduler/modules b/nodes/scheduling/descheduler/modules
@@ -0,0 +1 @@
+../../../modules/
diff --git a/nodes/scheduling/descheduler/nodes-descheduler-configuring.adoc b/nodes/scheduling/descheduler/nodes-descheduler-configuring.adoc
@@ -0,0 +1,21 @@
+:_mod-docs-content-type: ASSEMBLY
+[id="nodes-descheduler-configuring"]
+= Evicting pods using the descheduler
+include::_attributes/common-attributes.adoc[]
+:context: nodes-descheduler-configuring
+
+toc::[]
+
+You can run the descheduler in {product-title} by installing the {descheduler-operator} and setting the desired profiles and other customizations.
+
+:operator-name: The {descheduler-operator}
+include::snippets/operator-not-available.adoc[]
+
+// Installing the descheduler
+include::modules/nodes-descheduler-installing.adoc[leveloffset=+1]
+
+// Configuring the descheduler profiles
+include::modules/nodes-descheduler-configuring-profiles.adoc[leveloffset=+1]
+
+// Configuring the descheduler interval
+include::modules/nodes-descheduler-configuring-interval.adoc[leveloffset=+1]
diff --git a/nodes/scheduling/descheduler/nodes-descheduler-release-notes.adoc b/nodes/scheduling/descheduler/nodes-descheduler-release-notes.adoc
@@ -0,0 +1,16 @@
+:_mod-docs-content-type: ASSEMBLY
+[id="nodes-descheduler-release-notes"]
+= {descheduler-operator} release notes
+include::_attributes/common-attributes.adoc[]
+:context: nodes-descheduler-release-notes
+
+toc::[]
+
+The {descheduler-operator} allows you to evict pods so that they can be rescheduled on more appropriate nodes.
+
+These release notes track the development of the {descheduler-operator}.
+
+:operator-name: The {descheduler-operator}
+include::snippets/operator-not-available.adoc[]
+
+For more information, see xref:../../../nodes/scheduling/descheduler/index.adoc#nodes-descheduler-about_nodes-descheduler-about[About the descheduler].
diff --git a/nodes/scheduling/descheduler/nodes-descheduler-uninstalling.adoc b/nodes/scheduling/descheduler/nodes-descheduler-uninstalling.adoc
@@ -0,0 +1,17 @@
+:_mod-docs-content-type: ASSEMBLY
+[id="nodes-descheduler-uninstalling"]
+= Uninstalling the {descheduler-operator}
+include::_attributes/common-attributes.adoc[]
+:context: nodes-descheduler-uninstalling
+
+toc::[]
+
+You can remove the {descheduler-operator} from {product-title} by uninstalling the Operator and removing its related resources.
+
+// TODO: Update all other places to use the new operator attribute
+
+:operator-name: The {descheduler-operator}
+include::snippets/operator-not-available.adoc[]
+
+// Uninstalling the descheduler
+include::modules/nodes-descheduler-uninstalling.adoc[leveloffset=+1]
diff --git a/nodes/scheduling/descheduler/snippets b/nodes/scheduling/descheduler/snippets
@@ -0,0 +1 @@
+../../../snippets/
diff --git a/nodes/scheduling/nodes-descheduler.adoc b/nodes/scheduling/nodes-descheduler.adoc
diff --git a/virt/virtual_machines/advanced_vm_management/virt-enabling-descheduler-evictions.adoc b/virt/virtual_machines/advanced_vm_management/virt-enabling-descheduler-evictions.adoc
@@ -21,4 +21,4 @@ include::modules/virt-enabling-descheduler-evictions.adoc[leveloffset=+1]
 [role="_additional-resources"]
 [id="additional-resources_enabling-descheduler-evictions"]
 == Additional resources
-* xref:../../../nodes/scheduling/nodes-descheduler.adoc#nodes-descheduler[Evicting pods using the descheduler]
+* xref:../../../nodes/scheduling/descheduler/index.adoc#nodes-descheduler-about[Descheduler overview]
diff --git a/welcome/oke_about.adoc b/welcome/oke_about.adoc
@@ -254,7 +254,7 @@ The following table is a summary of the feature availability in {oke} and {produ
 | File Integrity Operator | Included | Included | File Integrity Operator
 | Gatekeeper Operator | Not Included - Requires separate subscription | Not Included - Requires separate subscription | Gatekeeper Operator
 | Klusterlet | Not Included - Requires separate subscription | Not Included - Requires separate subscription | N/A
-| Kube Descheduler Operator provided by Red Hat | Included | Included | Kube Descheduler Operator
+| {descheduler-operator} provided by Red Hat | Included | Included | {descheduler-operator}
 | Local Storage provided by Red Hat | Included | Included | Local Storage Operator
 | Node Feature Discovery provided by Red Hat | Included | Included | Node Feature Discovery Operator
 | Performance Profile controller | Included | Included | N/A
