Adding sample scheduler object

jhou1 · May 21, 2019 · b6e56b9 · b6e56b9
1 parent 00c8d04
commit b6e56b9
Show file tree

Hide file tree

Showing 37 changed files with 79 additions and 63 deletions.
diff --git a/Gemfile b/Gemfile
@@ -1,3 +1,4 @@
 source "https://rubygems.org"
 
 gem 'ascii_binder', '~>0.1.5'
+
diff --git a/_topic_map.yml b/_topic_map.yml
@@ -467,9 +467,9 @@ Topics:
   Topics:
   - Name: About pod placement using the scheduler
     File: nodes-scheduler-about
-  - Name: Placing pods onto nodes with the default scheduler
+  - Name: Configuring the default scheduler to control pod placement
     File: nodes-scheduler-default
-  - Name: Placing pods relative to other pods using pod affinity/anti-affinity rules
+  - Name: Placing pods relative to other pods using pod affinity and anti-affinity rules
     File: nodes-scheduler-pod-affinity
   - Name: Controlling pod placement on nodes using node affinity rules
     File: nodes-scheduler-node-affinity

diff --git a/modules/nodes-pods-priority-disabling.adoc b/modules/nodes-pods-priority-disabling.adoc
@@ -22,6 +22,10 @@ To disable the preemption for the cluster:
 . Edit the Scheduler Operator Custom Resource to add the `disablePreemption: true` parameter:
 +
 ----
+oc edit scheduler cluster
+----
++
+----
 apiVersion: config.openshift.io/v1
 kind: Scheduler
 metadata:

diff --git a/modules/nodes-scheduler-default-creating.adoc b/modules/nodes-scheduler-default-creating.adoc
@@ -70,8 +70,11 @@ $ oc create configmap -n openshift-config --from-file=policy.cfg scheduler-polic
 
 configmap/scheduler-policy created
 ----
-
-. Edit the *_scheduler.yaml_* file, installed by default, to add the ConfigMap.
+. Edit the Scheduler Operator Custom Resource to add the ConfigMap:
++
+----
+$ oc edit scheduler cluster
+----
 +
 ----
 apiVersion: config.openshift.io/v1
@@ -82,9 +85,3 @@ spec: {}
   policy:
     name: scheduler-policy
 ----
-
-. Create the `scheduler` object:
-+
-----
-$ oc create -f scheduler.yaml
-----
diff --git a/nodes/clusters/nodes-cluster-overcommit.adoc b/nodes/clusters/nodes-cluster-overcommit.adoc
@@ -1,5 +1,5 @@
 :context: nodes-cluster-overcommit
-[id="nodes-cluster-overcommit_{context}"]
+[id="nodes-cluster-overcommit"]
 = Configuring your cluster to place pods on overcommited nodes in {product-title} 
 include::modules/common-attributes.adoc[]
 

diff --git a/nodes/clusters/nodes-cluster-resource-configure.adoc b/nodes/clusters/nodes-cluster-resource-configure.adoc
@@ -1,5 +1,5 @@
 :context: nodes-cluster-resource-configure
-[id="nodes-cluster-resource-configure_{context}"]
+[id="nodes-cluster-resource-configure"]
 = Configuring cluster memory to meet container memory and risk requirements in {product-title}
 include::modules/common-attributes.adoc[]
 

diff --git a/nodes/clusters/nodes-cluster-resource-levels.adoc b/nodes/clusters/nodes-cluster-resource-levels.adoc
@@ -1,5 +1,5 @@
 :context: nodes-cluster-resource-levels
-[id="nodes-cluster-resource-levels_{context}"]
+[id="nodes-cluster-resource-levels"]
 = Estimating the number of pods your {product-title} nodes can hold
 include::modules/common-attributes.adoc[]
 

diff --git a/nodes/clusters/nodes-containers-events.adoc b/nodes/clusters/nodes-containers-events.adoc
@@ -1,5 +1,5 @@
 :context: nodes-containers-events
-[id="nodes-containers-events_{context}"]
+[id="nodes-containers-events"]
 = Viewing system event information in an {product-title} cluster
 include::modules/common-attributes.adoc[]
 

diff --git a/nodes/containers/nodes-containers-copying-files.adoc b/nodes/containers/nodes-containers-copying-files.adoc
@@ -1,5 +1,5 @@
 :context: nodes-containers-copying-files
-[id="nodes-containers-copying-files_{context}"]
+[id="nodes-containers-copying-files"]
 = Copying files to or from an {product-title} container
 include::modules/common-attributes.adoc[]
 

diff --git a/nodes/containers/nodes-containers-downward-api.adoc b/nodes/containers/nodes-containers-downward-api.adoc
@@ -1,5 +1,5 @@
 :context: nodes-containers-downward-api
-[id="nodes-containers-downward-api_{context}"]
+[id="nodes-containers-downward-api"]
 = Allowing containers to consume API objects
 include::modules/common-attributes.adoc[]
 

diff --git a/nodes/containers/nodes-containers-health.adoc b/nodes/containers/nodes-containers-health.adoc
@@ -1,6 +1,6 @@
 
 :context: nodes-containers-health
-[id="nodes-nodes-health_{context}"]
+[id="nodes-nodes-health"]
 = Monitoring container health
 include::modules/common-attributes.adoc[]
 

diff --git a/nodes/containers/nodes-containers-init.adoc b/nodes/containers/nodes-containers-init.adoc
@@ -1,5 +1,5 @@
 :context: nodes-containers-init
-[id="nodes-containers-init_{context}"]
+[id="nodes-containers-init"]
 = Using Init Containers to perform tasks before a pod is deployed
 include::modules/common-attributes.adoc[]
 

diff --git a/nodes/containers/nodes-containers-port-forwarding.adoc b/nodes/containers/nodes-containers-port-forwarding.adoc
@@ -1,5 +1,5 @@
 :context: nodes-containers-port-forwarding
-[id="nodes-containers-port-forwarding_{context}"]
+[id="nodes-containers-port-forwarding"]
 = Using port forwarding to access applications in a container
 include::modules/common-attributes.adoc[]
 

diff --git a/nodes/containers/nodes-containers-projected-volumes.adoc b/nodes/containers/nodes-containers-projected-volumes.adoc
@@ -1,5 +1,5 @@
 :context: nodes-containers-projected-volumes
-[id="nodes-containers-projected-volumes_{context}"]
+[id="nodes-containers-projected-volumes"]
 = Mapping volumes using projected volumes
 include::modules/common-attributes.adoc[]
 

diff --git a/nodes/containers/nodes-containers-remote-commands.adoc b/nodes/containers/nodes-containers-remote-commands.adoc
@@ -1,5 +1,5 @@
 :context: nodes-containers-remote-commands
-[id="nodes-containers-remote-commands_{context}"]
+[id="nodes-containers-remote-commands"]
 = Executing remote commands in an {product-title} container
 include::modules/common-attributes.adoc[]
 

diff --git a/nodes/containers/nodes-containers-using.adoc b/nodes/containers/nodes-containers-using.adoc
@@ -1,5 +1,5 @@
 :context: nodes-containers-using
-[id="nodes-containers-using_{context}"]
+[id="nodes-containers-using"]
 = Understanding Containers in {product-title}
 include::modules/common-attributes.adoc[]
 

diff --git a/nodes/containers/nodes-containers-volumes.adoc b/nodes/containers/nodes-containers-volumes.adoc
@@ -1,5 +1,5 @@
 :context: nodes-containers-volumes
-[id="nodes-containers-volumes_{context}"]
+[id="nodes-containers-volumes"]
 = Using volumes to persist container data
 include::modules/common-attributes.adoc[]
 

diff --git a/nodes/jobs/nodes-nodes-jobs.adoc b/nodes/jobs/nodes-nodes-jobs.adoc
@@ -1,6 +1,6 @@
 
 :context: nodes-nodes-jobs
-[id="nodes-nodes-jobs_{context}"]
+[id="nodes-nodes-jobs"]
 = Running tasks in pods using jobs in {product-title}
 include::modules/common-attributes.adoc[]
 

diff --git a/nodes/nodes/nodes-nodes-audit-log.adoc b/nodes/nodes/nodes-nodes-audit-log.adoc
@@ -1,5 +1,5 @@
-:context: nodes-nodes-working
-[id="nodes-nodes-audit-log_{context}"]
+:context: nodes-nodes-audit-log
+[id="nodes-nodes-audit-log"]
 = Viewing node audit logs
 include::modules/common-attributes.adoc[]
 

diff --git a/nodes/nodes/nodes-nodes-managing-max-pods.adoc b/nodes/nodes/nodes-nodes-managing-max-pods.adoc
@@ -1,5 +1,5 @@
 :context: nodes-nodes-jobs
-[id="nodes-nodes-managing-max-pods_{context}"]
+[id="nodes-nodes-managing-max-pods"]
 = Managing the maximum number of Pods per Node
 include::modules/common-attributes.adoc[]
 

diff --git a/nodes/nodes/nodes-nodes-managing.adoc b/nodes/nodes/nodes-nodes-managing.adoc
@@ -1,6 +1,6 @@
 
 :context: nodes-nodes-jobs
-[id="nodes-nodes-managing_{context}"]
+[id="nodes-nodes-managing"]
 = Managing Nodes
 include::modules/common-attributes.adoc[]
 

diff --git a/nodes/nodes/nodes-nodes-modifying.adoc b/nodes/nodes/nodes-nodes-modifying.adoc
@@ -1,6 +1,6 @@
 
 :context: nodes-nodes-modifying
-[id="nodes-nodes-modifying_{context}"]
+[id="nodes-nodes-modifying"]
 = Modifying existing nodes in your {product-title} cluster
 include::modules/common-attributes.adoc[]
 

diff --git a/nodes/nodes/nodes-nodes-opaque-resources.adoc b/nodes/nodes/nodes-nodes-opaque-resources.adoc
@@ -1,6 +1,6 @@
 
 :context: nodes-nodes-opaque-resources
-[id="nodes-nodes-opaque-resources_{context}"]
+[id="nodes-nodes-opaque-resources"]
 = Advertising hidden resources for nodes in an {product-title} cluster
 include::modules/common-attributes.adoc[]
 

diff --git a/nodes/nodes/nodes-nodes-rebooting.adoc b/nodes/nodes/nodes-nodes-rebooting.adoc
@@ -1,6 +1,6 @@
 
 :context: nodes-nodes-rebooting
-[id="nodes-nodes-rebooting_{context}"]
+[id="nodes-nodes-rebooting"]
 = Understanding node rebooting in {product-title}
 include::modules/common-attributes.adoc[]
 

diff --git a/nodes/nodes/nodes-nodes-resources-configuring.adoc b/nodes/nodes/nodes-nodes-resources-configuring.adoc
@@ -1,6 +1,6 @@
 
 :context: nodes-nodes-resources-configuring
-[id="nodes-nodes-resources-configuring_{context}"]
+[id="nodes-nodes-resources-configuring"]
 = Allocating resources for nodes in an {product-title} cluster
 include::modules/common-attributes.adoc[]
 

diff --git a/nodes/nodes/nodes-nodes-viewing.adoc b/nodes/nodes/nodes-nodes-viewing.adoc
@@ -1,6 +1,6 @@
 
 :context: nodes-nodes-viewing
-[id="nodes-nodes-viewing_{context}"]
+[id="nodes-nodes-viewing"]
 = Viewing and listing the nodes in your {product-title} cluster
 include::modules/common-attributes.adoc[]
 

diff --git a/nodes/nodes/nodes-nodes-working.adoc b/nodes/nodes/nodes-nodes-working.adoc
@@ -1,7 +1,7 @@
 
 :context: nodes-nodes-working
-[id="nodes-nodes-working_{context}"]
-= Working with nodes in {product-title}
+[id="nodes-nodes-working"]
+= Working with nodes
 include::modules/common-attributes.adoc[]
 
 toc::[]

diff --git a/nodes/pods/nodes-pods-node-selectors.adoc b/nodes/pods/nodes-pods-node-selectors.adoc
@@ -1,5 +1,5 @@
 :context: nodes-pods-node-selectors
-[id="nodes-pods-node-selectors_{context}"]
+[id="nodes-pods-node-selectors"]
 = Placing pods on specific nodes using node selectors
 include::modules/common-attributes.adoc[]
 :relfileprefix: ../

diff --git a/nodes/scheduling/nodes-scheduler-about.adoc b/nodes/scheduling/nodes-scheduler-about.adoc
@@ -1,6 +1,6 @@
 :context: nodes-scheduler-about
-[id="nodes-scheduler-about_{context}"]
-= Controlling pod placement using the {product-title} scheduler
+[id="nodes-scheduler-about"]
+= Controlling pod placement using the scheduler
 include::modules/common-attributes.adoc[]
 
 
@@ -21,18 +21,15 @@ creates bindings (pod to node bindings) for the pods using the master API.
 // assemblies.
 
 Default pod scheduling::
-OpenShift Container Platform comes with a default scheduler that serves the needs of most users. The default scheduler uses both inherent and customization tools to determine the best fit for a pod. 
+OpenShift Container Platform comes with a xref:../../nodes/scheduling/nodes-scheduler-default.adoc[default scheduler] that serves the needs of most users. The default scheduler uses both inherent and customization tools to determine the best fit for a pod. 
 
 Advanced pod scheduling::
 In situations where you might want more control over where new pods are placed, the OpenShift Container Platform advanced scheduling features allow you to configure a pod so that the pod is required or has a preference to run on a particular node or alongside a specific pod by.
 
-* Using pod affinity and anti-affinity rules
-* Placing a pod on a node by name
-* Placing a pod in a specific project
-* Placing pods on overcomitted nodes
-* Controlling pod placement with node affinity
-* Controlling pod placement with taints and tolerations
-* Controlling pod placement with node selectors
+* Using xref:../../nodes/scheduling/nodes-scheduler-pod-affinity.adoc[pod affinity and anti-affinity rules]  #nodes-scheduler-pod-affinity_nodes-scheduler-pod-affinity.
+* Controlling pod placement with xref:../../nodes/scheduling/nodes-scheduler-pod-affinity.adoc[pod affinity]. #nodes-scheduler-pod-affinity_nodes-scheduler-pod-affinity
+* Controlling pod placement with xref:../../nodes/scheduling/nodes-scheduler-node-affinity.adoc[node affinity]. #nodes-scheduler-node-affinity_nodes-scheduler-node-affinity
+* Placing pods on xref:../../nodes/scheduling/nodes-scheduler-overcommit.adoc[overcomitted nodes]. #nodes-scheduler-overcommit_nodes-scheduler-overcommit
+* Controlling pod placement with xref:../../nodes/scheduling/nodes-scheduler-node-selectors.adoc[node selectors]. #nodes-scheduler-node-selectors_nodes-scheduler-node-selectors
+* Controlling pod placement with xref:../../nodes/scheduling/nodes-scheduler-taints-tolerations.adoc[taints and tolerations]. #nodes-scheduler-taints-tolerations_nodes-scheduler-taints-tolerations
 
-Removing pods from nodes based priority::
-You can configure the pod scheduler to evict, or preempt, lower-priority pods in order to schedule higher-priority pods.
diff --git a/nodes/scheduling/nodes-scheduler-default.adoc b/nodes/scheduling/nodes-scheduler-default.adoc
@@ -1,6 +1,6 @@
 :context: nodes-scheduler-default
-[id="nodes-scheduler-default_{context}"]
-= Configuring the default scheduler to control pod placement in {product-title}
+[id="nodes-scheduler-default"]
+= Configuring the default scheduler to control pod placement
 include::modules/common-attributes.adoc[]
 :relfileprefix: ../
 
@@ -16,6 +16,23 @@ independent and exists as a standalone/pluggable solution. It does not modify
 the pod and just creates a binding for the pod that ties the pod to the
 particular node.
 
+.Sample default scheduler object
+----
+apiVersion: config.openshift.io/v1
+kind: Scheduler
+metadata:
+  annotations:
+    release.openshift.io/create-only: "true"
+  creationTimestamp: 2019-05-20T15:39:01Z
+  generation: 1
+  name: cluster
+  resourceVersion: "1491"
+  selfLink: /apis/config.openshift.io/v1/schedulers/cluster
+  uid: 6435dd99-7b15-11e9-bd48-0aec821b8e34
+spec: {} <1>
+----
+<1> Edit the `spec` stanza to configure the default scheduler.
+
 // The following include statements pull in the module files that comprise
 // the assembly. Include any combination of concept, procedure, or reference
 // modules required to cover the user story. You can also include other

diff --git a/nodes/scheduling/nodes-scheduler-node-affinity.adoc b/nodes/scheduling/nodes-scheduler-node-affinity.adoc
@@ -1,6 +1,6 @@
 :context: nodes-scheduler-node-affinity
-[id="nodes-scheduler-node-affinity_{context}"]
-= Controlling pod placement on nodes using node affinity rules in {product-title}
+[id="nodes-scheduler-node-affinity"]
+= Controlling pod placement on nodes using node affinity rules
 include::modules/common-attributes.adoc[]
 :relfileprefix: ../
 

diff --git a/nodes/scheduling/nodes-scheduler-node-names.adoc b/nodes/scheduling/nodes-scheduler-node-names.adoc
@@ -1,6 +1,6 @@
 :context: nodes-scheduler-node-names
-[id="nodes-scheduler-node-names_{context}"]
-= Placing a pod on a specific node by name in {product-title}
+[id="nodes-scheduler-node-names"]
+= Placing a pod on a specific node by name
 include::modules/common-attributes.adoc[]
 :relfileprefix: ../
 
@@ -27,5 +27,5 @@ include::modules/nodes-scheduler-node-names-configuring.adoc[leveloffset=+1]
 [id="nodes-scheduler-node-names-addtl-resources_{context}"]
 == Additional resources
 
-For information about changing node labels, see xref:../../nodes/nodes/nodes-nodes-working.adoc#nodes-nodes-working-updating-nodes-nodes-working[Understanding how to update labels on nodes].
+For information about changing node labels, see xref:../../nodes/nodes/nodes-nodes-working.adoc#nodes-nodes-working-updating_nodes-nodes-working[Understanding how to update labels on nodes].
 
diff --git a/nodes/scheduling/nodes-scheduler-node-projects.adoc b/nodes/scheduling/nodes-scheduler-node-projects.adoc
@@ -1,5 +1,5 @@
 :context: nodes-scheduler-node-project
-[id="nodes-scheduler-node-project_{context}"]
+[id="nodes-scheduler-node-project"]
 = Placing a pod in a specific project in {product-title}
 include::modules/common-attributes.adoc[]
 :relfileprefix: ../

diff --git a/nodes/scheduling/nodes-scheduler-node-selectors.adoc b/nodes/scheduling/nodes-scheduler-node-selectors.adoc
@@ -1,5 +1,5 @@
 :context: nodes-scheduler-node-selectors
-[id="nodes-scheduler-node-selectors_{context}"]
+[id="nodes-scheduler-node-selectors"]
 = Placing pods on specific nodes using node selectors
 include::modules/common-attributes.adoc[]
 :relfileprefix: ../

diff --git a/nodes/scheduling/nodes-scheduler-overcommit.adoc b/nodes/scheduling/nodes-scheduler-overcommit.adoc
@@ -1,6 +1,6 @@
 :context: nodes-sceduler-overcommit
-[id="nodes-scheduler-overcommit_{context}"]
-= Placing pods onto overcommited nodes in {product-title} 
+[id="nodes-scheduler-overcommit"]
+= Placing pods onto overcommited nodes
 include::modules/common-attributes.adoc[]
 
 toc::[]

diff --git a/nodes/scheduling/nodes-scheduler-pod-affinity.adoc b/nodes/scheduling/nodes-scheduler-pod-affinity.adoc
@@ -1,6 +1,6 @@
 :context: nodes-scheduler-pod-affinity
-[id="nodes-scheduler-pod-affinity_{context}"]
-= Placing pods relative to other pods using affinity/anti-affinity rules in {product-title}
+[id="nodes-scheduler-pod-affinity"]
+= Placing pods relative to other pods using affinity and anti-affinity rules
 include::modules/common-attributes.adoc[]
 :relfileprefix: ../
 

diff --git a/nodes/scheduling/nodes-scheduler-taints-tolerations.adoc b/nodes/scheduling/nodes-scheduler-taints-tolerations.adoc
@@ -1,6 +1,6 @@
 :context: nodes-scheduler-taints-tolerations
-[id="nodes-scheduler-taints-tolerations_{context}"]
-= Controlling pod placement using node taints in {product-title}
+[id="nodes-scheduler-taints-tolerations"]
+= Controlling pod placement using node taints
 include::modules/common-attributes.adoc[]
 :relfileprefix: ../
Original file line number	Diff line number	Diff line change
		@@ -1,3 +1,4 @@
		source "https://rubygems.org"

		gem 'ascii_binder', '~>0.1.5'