Merge pull request #22663 from vpickard/topology-manager-4.5

Update Topology Manager doc for 4.5

Author: mburke5678

modules/setting-up-topology-manager.adoc

@@ -16,26 +16,45 @@
 # oc edit featuregate/cluster
 ----
 
-. Add Feature Set: LatencySensitive to the spec:
+. Add featureSet: LatencySensitive to the spec:
 +
 ----
-# oc describe featuregate/cluster
+# oc get featuregate/cluster -o yaml
+apiVersion: config.openshift.io/v1
+kind: FeatureGate
+metadata:
+  annotations:
+    release.openshift.io/create-only: "true"
+  creationTimestamp: 2020-06-05T14:41:09Z
+  generation: 2
+  managedFields:
+  - apiVersion: config.openshift.io/v1
+    fieldsType: FieldsV1
+    fieldsV1:
+      f:metadata:
+        f:annotations:
+          .: {}
+          f:release.openshift.io/create-only: {}
+      f:spec: {}
+    manager: cluster-version-operator
+    operation: Update
+    time: 2020-06-05T14:41:09Z
+  - apiVersion: config.openshift.io/v1
+    fieldsType: FieldsV1
+    fieldsV1:
+      f:spec:
+        f:featureSet: {}
+    manager: oc
+    operation: Update
+    time: 2020-06-05T15:21:44Z
+  name: cluster
+  resourceVersion: "28457"
+  selfLink: /apis/config.openshift.io/v1/featuregates/cluster
+  uid: e802e840-89ee-4137-a7e5-ca15fd2806f8
+spec:
+  featureSet: LatencySensitive
+
 
-Name:         cluster
-Namespace:
-Labels:       <none>
-Annotations:  release.openshift.io/create-only: true
-API Version:  config.openshift.io/v1
-Kind:         FeatureGate
-Metadata:
-  Creation Timestamp:  2019-10-30T15:06:41Z
-  Generation:          2
-  Resource Version:    7773803
-  Self Link:           /apis/config.openshift.io/v1/featuregates/cluster
-  UID:                 b00204ab-cc5e-4ca5-ad93-b9bdd738c1de
-Spec:
-  Feature Set:  LatencySensitive
-Events:         <none>
 ----
 
 . Configure the Topology Manager policy with KubeletConfig.
@@ -57,7 +76,8 @@ spec:
      cpuManagerReconcilePeriod: 5s
      topologyManagerPolicy: single-numa-node <1>
 ----
-<1> Specify your selected Topology Manager policy.
+<1> Specify your selected Topology Manager policy. Here, the policy is single-numa-node.
+Acceptable values are: default, best-effort, restricted, single-numa-node
 +
 ----
 # oc create -f topologymanager-kubeletconfig.yaml

modules/topology-manager-policies.adoc

@@ -5,13 +5,14 @@
 [id="topology_manager_policies_{context}"]
 = Topology Manager policies
 
-Topology Manager works on Nodes and Pods that meet the following conditions:
+Topology Manager currently aligns Pod resources of all QoS classes. Topology Manager
+collects topology hints from Hint Providers (CPU Manager, Device Manager, etc) and uses
+these collected hints to align the Pod resources.
 
-* The Node's CPU Manager Policy is configured as `static`.
-* The Pods are in the `Guaranteed` QoS class.
-
-When the above conditions are met, Topology Manager will align CPU
-and device requests for the Pod.
+====
+Note: To align CPU resources with other requested resources in a Pod Spec, the CPU
+Manager should be enabled and the CPU Manager policy should be configured as `static`.
+====
 
 Topology Manager supports 4 allocation policies. These policies are set via a Kubelet
 flag, `--topology-manager-policy`. The policies are:
@@ -30,17 +31,17 @@ This is the default policy and does not perform any topology alignment.
 [id="topology-manager-best-effort-policy_{context}"]
 == best-effort policy
 
-For each container in a Guaranteed Pod with the best-effort topology
-management policy, kublet calls each Hint Provider to discover their resource
+For each container in a Pod with the best-effort topology
+management policy, kubelet calls each Hint Provider to discover their resource
 availability. Using this information, the Topology Manager stores the
 preferred NUMA Node affinity for that container. If the affinity is not
 preferred, Topology Manager will store this and admit the pod to the node anyway.
 
 [id="topology-manager-restricted-policy_{context}"]
 == restricted policy
 
-For each container in a Guaranteed Pod with the restricted topology
-management policy, kublet calls each Hint Provider to discover their resource
+For each container in a Pod with the restricted topology
+management policy, kubelet calls each Hint Provider to discover their resource
 availability. Using this information, the Topology Manager stores the
 preferred NUMA Node affinity for that container. If the affinity is not
 preferred, Topology Manager will reject this pod from the node. This will
@@ -49,8 +50,8 @@ result in a pod in a Terminated state with a pod admission failure.
 [id="topology-manager-single-numa-node_{context}"]
 == single-numa-node
 
-For each container in a Guaranteed Pod with the single-numa-node topology
-management policy, kublet calls each Hint Provider to discover their resource availability.
+For each container in a Pod with the single-numa-node topology
+management policy, kubelet calls each Hint Provider to discover their resource availability.
 Using this information, the Topology Manager determines if a single NUMA Node
 affinity is possible. If it is, the pod will be admitted to the node.
 If this is not possible then the Topology Manager will reject the pod

scalability_and_performance/using-topology-manager.adoc

@@ -5,19 +5,18 @@ include::modules/common-attributes.adoc[]
 
 toc::[]
 
-Topology Manager is a Kubelet component that collects hints from CPU Manager
-and Device Manager to align pod CPU and device resources on the same non-uniform memory access (NUMA) node.
+Topology Manager is a Kubelet component that collects hints from CPU Manager,
+Device Manager, and other Hint Providers to align pod resources (such as CPU, SR-IOV VFs,
+and other device resources) for all QoS classes on the same non-uniform memory access
+(NUMA) node.
 
 Topology Manager uses topology information from collected hints to decide if
-the pod can be accepted or rejected from the node, based on the configured Topology
+the pod can be accepted or rejected on the node, based on the configured Topology
 Manager policy and Pod resources requested.
 
 Topology Manager is useful for workloads that desire to use hardware accelerators
 to support latency-critical execution and high throughput parallel computation.
 
-[NOTE]
-====
-Topology Manager is an alpha feature in {product-title}.
 ====
 
 include::modules/setting-up-topology-manager.adoc[leveloffset=+1]