edits

Author: mburke5678

modules/nodes-scheduler-default-about.adoc

@@ -49,7 +49,7 @@ policy. If any of the default predicates and priorities are required,
 you must explicitly specify the functions in the policy configuration.
 ====
 
-.Default scheduler configuration file
+.Sample scheduler configuration file
 [source,json]
 ----
 {

modules/nodes-scheduler-default-modifying.adoc

@@ -10,6 +10,23 @@
 You change scheduling behavior by creating or editing your scheduler policy ConfigMap in the `openshift-config` project.
 Add and remove predicates and priorities to the ConfigMap to create a _scheduler policy_.
 
+.Typical predicate string
+----
+\n\t{\"name\" : \"<PredicateName>\", \"label\" : \"<label>\",  \"<condition>\" : \"<state>\"},
+----
+* `name` is the name of the predicate, such as `labelsPresence`. 
+* `label` and `<label>` is the node label:value pair to match to apply the predicate, such `label:rack`.
+* `<condition>` and `<state>` is when the predicate should be applied, such as `presence:true`.
+
+.Typical priority string
+----
+\n\t{\"name\" : \"<PredicateName>\", \"label\" : \"<label>\",  \"<condition>\" : \"<state>\", \"weight\" : <weight>},
+----
+* `name` is the name of the priority, such as `labelsPresence`. 
+* `label` and `<label>` is the node `label:value` pair to match to apply the priority, such `label:rack`.
+* `<condition>` and `<state>` is when the priority should be applied, such as `presence:true`.
+* `weight` and `<weight> is the numerical weight to apply to the priority.
+
 .Procedure
 
 To modify the scheduler policy:
@@ -18,7 +35,7 @@ Edit the scheduler configuration file to configure the desired
 predicates and priorities. 
 +
 .Sample modified scheduler configuration map
-[source,json]
+[source,yaml]
 ----
 kind: ConfigMap
 apiVersion: v1
@@ -33,15 +50,18 @@ data:
   policy.cfg: "{\n\"kind\" : \"Policy\",\n\"apiVersion\" : \"v1\",\n\"predicates\" : [\n\t{\"name\" : \"PodFitsHostPorts\"},\n\t{\"name\" : \"PodFitsResources\"},\n\t{\"name\" : \"NoDiskConflict\"},\n\t{\"name\" : \"NoVolumeZoneConflict\"},\n\t{\"name\" : \"MatchNodeSelector\"},\n\t{\"name\" : \"HostName\"}\n\t],\n\"priorities\" : [\n\t{\"name\" : \"LeastRequestedPriority\", \"weight\" : 10},\n\t{\"name\" : \"BalancedResourceAllocation\", \"weight\" : 1},\n\t{\"name\" : \"ServiceSpreadingPriority\", \"weight\" : 1},\n\t{\"name\" : \"EqualPriority\", \"weight\" : 1}\n\t]\n}\n"
 ----
 +
-For example, the following adds the `labelPreference` priority giving a weight of 2 to the `rack` label on a node:
+For example, the following strings add the `labelpresence` predicate requiring the `rack` label on the nodes and the `labelPreference` priority giving a weight of 2 to the `rack` label:
 +
+[source,yaml]
 ----
+\n\t{\"name\" : \"labelPresence\", \"label\" : \"rack\",  \"presence\" : \"true\"},
 \n\t{\"name\" : \"labelPreference\", \"label\" : \"rack\", \"presence\" : \"true\", \"weight\" : 2},\n\t
 -----
 
 The ConfigMap appears as following with the new priority:
 +
+[source,yaml]
 ----
-policy.cfg: "{\n\"kind\" : \"Policy\",\n\"apiVersion\" : \"v1\",\n\"predicates\" : [\n\t{\"name\" : \"PodFitsHostPorts\"},\n\t{\"name\" : \"PodFitsResources\"},\n\t{\"name\" : \"NoDiskConflict\"},\n\t{\"name\" : \"NoVolumeZoneConflict\"},\n\t{\"name\" : \"MatchNodeSelector\"},\n\t{\"name\" : \"HostName\"}\n\t],\n\"priorities\" : [\n\t{\"name\" : \"LeastRequestedPriority\", \"weight\" : 10},\n\t{\"name\" : \"BalancedResourceAllocation\", \"weight\" : 1},\n\t{\"name\" : \"ServiceSpreadingPriority\", \"weight\" : 1},\n\t{\"name\" : \"EqualPriority\", \"weight\" : 1},\n\t{\"name\" : \"labelPreference\", \"label\" : \"rack\", \"presence\" : \"true\", \"weight\" : 2},\n\t]\n}\n "
+policy.cfg: "{\n\"kind\" : \"Policy\",\n\"apiVersion\" : \"v1\",\n\"predicates\" : [\n\t{\"name\" : \"PodFitsHostPorts\"},\n\t{\"name\" : \"PodFitsResources\"},\n\t{\"name\" : \"NoDiskConflict\"},\n\t{\"name\" : \"NoVolumeZoneConflict\"},\n\t{\"name\" : \"MatchNodeSelector\"},\n\t{\"name\" : \"HostName\"},\n\t{\"name\" : \"labelPresence\", \"label\" : \"rack\",  \"presence\" : \"true\"}\n\t],\n\"priorities\" : [\n\t{\"name\" : \"LeastRequestedPriority\", \"weight\" : 10},\n\t{\"name\" : \"BalancedResourceAllocation\", \"weight\" : 1},\n\t{\"name\" : \"ServiceSpreadingPriority\", \"weight\" : 1},\n\t{\"name\" : \"EqualPriority\", \"weight\" : 1},\n\t{\"name\" : \"labelPreference\", \"label\" : \"rack\", \"presence\" : \"true\", \"weight\" : 2},\n\t]\n}\n "
 ----
 

modules/nodes-scheduler-default-sample.adoc

@@ -6,35 +6,23 @@
 = Sample Policy Configurations
 
 The configuration below specifies the default scheduler configuration, if it
-were to be specified via the scheduler policy file.
+were to be specified using the scheduler policy file.
 
 [source,yaml]
 ----
-kind: "Policy"
-version: "v1"
-predicates:
-...
-  - name: "RegionZoneAffinity" <1>
-    argument:
-      serviceAffinity: <2>
-        labels: <3>
-          - "region"
-          - "zone"
-priorities:
-...
-  - name: "RackSpread" <4>
-    weight: 1
-    argument:
-      serviceAntiAffinity: <5>
-        label: "rack" <6>
+kind: ConfigMap
+apiVersion: v1
+metadata:
+  name: mypolicy
+  namespace: openshift-config
+  selfLink: /api/v1/namespaces/openshift-config/configmaps/mypolicy
+  uid: 83917dfb-4422-11e9-b2c9-0a5e37b2b12e
+  resourceVersion: '1100851'
+  creationTimestamp: '2019-03-11T17:24:23Z'
+data:
+  policy.cfg: "{\n\"kind\" : \"Policy\",\n\"apiVersion\" : \"v1\",\n\"predicates\" : [\n\t{\"name\" : \"PodFitsHostPorts\"},\n\t{\"name\" : \"PodFitsResources\"},\n\t{\"name\" : \"NoDiskConflict\"},\n\t{\"name\" : \"NoVolumeZoneConflict\"},\n\t{\"name\" : \"MatchNodeSelector\"},\n\t{\"name\" : \"HostName\"}\n\t],\n\"priorities\" : [\n\t{\"name\" : \"LeastRequestedPriority\", \"weight\" : 10},\n\t{\"name\" : \"BalancedResourceAllocation\", \"weight\" : 1},\n\t{\"name\" : \"ServiceSpreadingPriority\", \"weight\" : 1},\n\t{\"name\" : \"EqualPriority\", \"weight\" : 1},\n\t{\"name\" : \"labelPreference\", \"label\" : \"rack\", \"presence\" : \"true\", \"weight\" : 2},\n\t]\n}\n "
 ----
 
-<1> The name for the predicate.
-<2> The type of predicate.
-<3> The labels for the predicate.
-<4> The name for the priority.
-<5> The type of priority.
-<6> The labels for the priority.
 
 In all of the sample configurations below, the list of predicates and priority
 functions is truncated to include only the ones that pertain to the use case
@@ -45,120 +33,30 @@ The following example defines three topological levels, region (affinity) -> zon
 
 [source,yaml]
 ----
-kind: "Policy"
-version: "v1"
-predicates:
-...
-  - name: "RegionZoneAffinity"
-    argument:
-      serviceAffinity:
-        labels:
-          - "region"
-          - "zone"
-priorities:
-...
-  - name: "RackSpread"
-    weight: 1
-    argument:
-      serviceAntiAffinity:
-        label: "rack"
+"{\n\"kind\" : \"Policy\",\n\"apiVersion\" : \"v1\",\n\"predicates\" : [\n\t{\"name\" : \"RegionZoneAffinity\", \"label\" : \"region\", \"label\" : \"zone\"}\n\t],\n\"priorities\" : [\n\t{\"name\" : \"serviceAntiAffinity\", \"label\" : \"rack\", \"weight\" : 1},\n\t]\n}\n"
 ----
 
 The following example defines three topological levels, city (affinity) -> building
 (anti-affinity) -> room (anti-affinity):
 
 [source,yaml]
 ----
-kind: "Policy"
-version: "v1"
-predicates:
-...
-  - name: "CityAffinity"
-    argument:
-      serviceAffinity:
-        labels:
-          - "city"
-priorities:
-...
-  - name: "BuildingSpread"
-    weight: 1
-    argument:
-      serviceAntiAffinity:
-        label: "building"
-  - name: "RoomSpread"
-    weight: 1
-    argument:
-      serviceAntiAffinity:
-        label: "room"
+"{\n\"kind\" : \"Policy\",\n\"apiVersion\" : \"v1\",\n\"predicates\" : [\n\t{\"name\" : \"serviceAffinityy\", \"label\" : \"city\"},\n\t],\n\"priorities\" : [\n\t{\"name\" : \"serviceAntiAffinity\", \"label\" : \"building\" \"weight\" : 1}, \n\t{\"name\" : \"serviceAntiAffinity\", \"label\" : \"room\" \"weight\" : 1},\n\t]\n}\n"
 ----
 
 The following example defines a policy to only use nodes with the 'region' label defined and prefer nodes with the 'zone'
 label defined:
 
 [source,yaml]
 ----
-kind: "Policy"
-version: "v1"
-predicates:
-...
-  - name: "RequireRegion"
-    argument:
-      labelsPresence:
-        labels:
-          - "region"
-        presence: true
-priorities:
-...
-  - name: "ZonePreferred"
-    weight: 1
-    argument:
-      labelPreference:
-        label: "zone"
-        presence: true
+"{\n\"kind\" : \"Policy\",\n\"apiVersion\" : \"v1\",\n\"predicates\" : [\n\t{\"name\" : \"labelsPresence\", \"label\" : \"region\", \"presence\" : \"true\"},\n\t],\n\"priorities\" : [\n\t{\"name\" : \"ZonePreferred\", \"label\" : \"zone\", \"presence\" : \"true\", \"weight\" : 1},\n\t]\n}\n"
 ----
 
 The following example combines both static and configurable predicates and
 also priorities:
 
 [source,yaml]
 ----
-kind: "Policy"
-version: "v1"
-predicates:
-...
-  - name: "RegionAffinity"
-    argument:
-      serviceAffinity:
-        labels:
-          - "region"
-  - name: "RequireRegion"
-    argument:
-      labelsPresence:
-        labels:
-          - "region"
-        presence: true
-  - name: "BuildingNodesAvoid"
-    argument:
-      labelsPresence:
-        labels:
-          - "building"
-        presence: false
-  - name: "PodFitsPorts"
-  - name: "MatchNodeSelector"
-priorities:
-...
-  - name: "ZoneSpread"
-    weight: 2
-    argument:
-      serviceAntiAffinity:
-        label: "zone"
-  - name: "ZonePreferred"
-    weight: 1
-    argument:
-      labelPreference:
-        label: "zone"
-        presence: true
-  - name: "ServiceSpreadingPriority"
-    weight: 1
+"{\n\"kind\" : \"Policy\",\n\"apiVersion\" : \"v1\",\n\"predicates\" : [\n\t{\"name\" : \"labelsPresence\", \"label\" : \"building\", \"presence\" : \"true\"}, \n\t{\"name\" : \"PodFitsHostPorts\"},\n\t{\"name\" : \"MatchNodeSelector\"},\n\t],\n\"priorities\" : [\n\t{\"name\" : \"ZonePreferred\", \"label\" : \"zone\", \"presence\" : \"true\", \"weight\" : 1},\n\t]\n}\n \"
 ----