Merge pull request #94636 from theashiot/OBSDOCS-1803

Obsdocs 1803

Author: kcarmichael08

_topic_maps/_topic_map.yml

@@ -38,6 +38,19 @@ Distros: openshift-logging
 Topics:
 - Name: Upgrading to Logging 6.0
   File: upgrading-to-logging-60
+---
+Name: Scheduling resources
+Dir: scheduling_resources
+Topics:
+- Name: Scheduling logging resources
+  File: scheduling-logging-resources
+#- Name: Using node selectors to move logging resources
+#  File: logging-node-selectors
+#- Name: Using tolerations to control logging pod placement
+#  File: logging-taints-tolerations
+#- Name: Using affinity and anti-afinity configuration to control logging pod placement
+#  File: logging-affinity-and-anti-afinity
+#---
 
 #---
 #Name: Configuring your Logging deployment

modules/log-collector-resources-scheduling.adoc

@@ -6,51 +6,84 @@
 [id="log-collector-resources-scheduling_{context}"]
 = Configuring resources and scheduling for logging collectors
 
-Administrators can modify the resources or scheduling of the collector by creating a `ClusterLogging` custom resource (CR) that is in the same namespace and has the same name as the `ClusterLogForwarder` CR that it supports.
-
-The applicable stanzas for the `ClusterLogging` CR when using multiple log forwarders in a deployment are `managementState` and `collection`. All other stanzas are ignored.
+Administrators can modify the resources and scheduling of the collector by configuring the `collector` field in a `ClusterLogForwarder` custom resource (CR).
 
 .Prerequisites
 
 * You have administrator permissions.
-* You have installed the {clo} version 5.8 or newer.
+* You have installed {clo}.
 * You have created a `ClusterLogForwarder` CR.
 
 .Procedure
 
-. Create a `ClusterLogging` CR that supports your existing `ClusterLogForwarder` CR:
+. Update the `ClusterLogForwarder` CR:
 +
-.Example `ClusterLogging` CR YAML
+.Example `ClusterLogForwarder` CR YAML
 [source,yaml]
 ----
-apiVersion: logging.openshift.io/v1
-kind: ClusterLogging
+apiVersion:  observability.openshift.io/v1
+kind: ClusterLogForwarder
 metadata:
-  name:  <name> # <1>
-  namespace: <namespace> # <2>
+  name: <name>
+  namespace: <namespace> 
 spec:
-  managementState: "Managed"
-  collection:
-    type: "vector"
-    tolerations:
-    - key: "logging"
-      operator: "Exists"
-      effect: "NoExecute"
-      tolerationSeconds: 6000
+  collector:
+    nodeSelector:
+      collector: needed
     resources:
       limits:
         memory: 1Gi
       requests:
         cpu: 100m
         memory: 1Gi
-    nodeSelector:
-      collector: needed
+    tolerations:
+    - key: "logging"
+      operator: "Exists"
+      effect: "NoExecute"
+      tolerationSeconds: 6000
+    affinity: 
+      nodeAffinity:
+        preferredDuringSchedulingIgnoredDuringExecution:
+        - preference:
+            matchExpressions:
+            - key: label-1
+              operator: Exists
+          weight: 1
+      podAffinity:
+        preferredDuringSchedulingIgnoredDuringExecution:
+        - podAffinityTerm:
+            labelSelector:
+              matchExpressions:
+              - key: test
+                operator: In
+                values:
+                 - value1
+            topologyKey: kubernetes.io/hostname 
+          weight: 50
+        requiredDuringSchedulingIgnoredDuringExecution:
+        - labelSelector:
+            matchExpressions:
+            - key: run
+              operator: In
+              values:
+              - test
+          namespaceSelector: {}
+          topologyKey: kubernetes.io/hostname
+      podAntiAffinity:
+        preferredDuringSchedulingIgnoredDuringExecution:
+        - podAffinityTerm:
+           labelSelector:
+             matchExpressions:
+             - key: security
+               operator: In
+               values:
+               - S2
+           topologyKey: topology.kubernetes.io/zone
+          weight: 100
 # ...
 ----
-<1> The name must be the same name as the `ClusterLogForwarder` CR.
-<2> The namespace must be the same namespace as the `ClusterLogForwarder` CR.
 
-. Apply the `ClusterLogging` CR by running the following command:
+. Apply the `ClusterLogForwarder` CR by running the following command:
 +
 [source,terminal]
 ----

modules/nodes-scheduler-node-selectors-about.adoc

@@ -224,4 +224,4 @@ spec:
   nodeSelector:
     region: west
 #...
-----
+----

scheduling_resources/scheduling-logging-resources.adoc

@@ -0,0 +1,33 @@
+:_mod-docs-content-type: ASSEMBLY
+[id="scheduling-logging-resources"]
+= Scheduling logging resources
+include::_attributes/common-attributes.adoc[]
+:context: scheduling-logging-resources
+
+toc::[]
+
+You can schedule logging resources by defining node selectors, taints and tolerations, and affinity and anti-affinity configurations. 
+
+Node selector:: A node selector specifies a map of key-value pairs that are defined using custom labels on nodes and selectors specified in pods. For the pod to be eligible to run on a node, the pod must have the same key-value pair as the label on the node.
+
+Taints and toleration:: Taints and tolerations control which pods should, or should not, be scheduled on nodes.
+
+Affinity and anti-affinity:: Pod affinity and pod anti-affinity allow you to constrain which nodes your pod is eligible to be scheduled on based on the key-value labels on other pods.
+
+[IMPORTANT]
+====
+If you configure both `nodeSelector` and `nodeAffinity`fields, the conditions of both fields must be met for the pod to be scheduled onto a candidate node.
+====
+
+
+include::modules/cluster-logging-collector-tolerations.adoc[leveloffset=+1]
+include::modules/log-collector-resources-scheduling.adoc[leveloffset=+1]
+include::modules/cluster-logging-collector-pod-location.adoc[leveloffset=+1]
+include::modules/logging-loki-pod-placement.adoc[leveloffset=+1]
+
+[role="_additional-resources"]
+== Additional resources
+
+* link:https://docs.openshift.com/container-platform/latest/nodes/scheduling/nodes-scheduler-node-selectors.adoc#nodes-scheduler-node-selectors[Placing pods on specific nodes using node selectors]
+* https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/nodes/controlling-pod-placement-onto-nodes-scheduling#nodes-scheduler-taints-tolerations[Controlling pod placement using node taints]
+* https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/nodes/controlling-pod-placement-onto-nodes-scheduling#nodes-scheduler-node-affinity[Controlling pod placement onto nodes (scheduling)]