Merge pull request #102156 from erpeters157/CNV-70798

CNV-70798: Doc updates for wasp-agent

Author: ousleyp

modules/virt-removing-wasp-agent.adoc

@@ -16,27 +16,6 @@ If you no longer need memory overcommitment, you can remove the `wasp-agent` com
 
 .Procedure
 
-. Remove the `wasp-agent` DaemonSet:
-+
-[source,terminal]
-----
-$ oc delete daemonset wasp-agent -n wasp
-----
-
-. If deployed, remove the alerting rules:
-+
-[source,terminal]
-----
-$ oc delete prometheusrule wasp-rules -n wasp
-----
-
-. Optionally, delete the `wasp` namespace if no other resources depend on it:
-+
-[source,terminal]
-----
-$ oc delete namespace wasp
-----
-
 . Revert the memory overcommitment configuration:
 +
 [source,terminal]
@@ -67,16 +46,8 @@ $ oc delete kubeletconfig custom-config
 $ oc wait mcp worker --for condition=Updated=True --timeout=-1s
 ----
 
-.Verification
 
-* Confirm that the `wasp-agent` DaemonSet is removed:
-+
-[source,terminal]
-----
-$ oc get daemonset -n wasp
-----
-+
-No `wasp-agent` should be listed.
+.Verification
 
 * Confirm that swap is no longer enabled on a node:
 +

modules/virt-using-wasp-agent-to-configure-higher-vm-workload-density.adoc

@@ -9,6 +9,8 @@
 [role="_abstract"]
 The `wasp-agent` component facilitates memory overcommitment by assigning swap resources to worker nodes. It also manages pod evictions when nodes are at risk due to high swap I/O traffic or high utilization.
 
+The `wasp-agent` component is deployed automatically if `memoryOvercommitPercentage` is set to more than `100` when you first create the `HyperConverged` custom resource (CR).
+
 [IMPORTANT]
 ====
 Swap resources can be only assigned to virtual machine workloads (VM pods) of the `Burstable` Quality of Service (QoS) class. VM pods of the `Guaranteed` QoS class and pods of any QoS class that do not belong to VMs cannot swap resources.
@@ -58,7 +60,9 @@ spec:
 $ oc wait mcp worker --for condition=Updated=True --timeout=-1s
 ----
 
-. Provision swap by creating a `MachineConfig` object. For example:
+. Provision swap by creating a `MachineConfig` object:
+
+.. Create a `MachineConfig` file with the paramaters shown in the following example:
 +
 [source,yaml]
 ----
@@ -125,159 +129,13 @@ NODE_SWAP_SPACE = 16 GB * (150% / 100% - 1)
                =  8 GB
 ----
 
-. Create a privileged service account by running the following commands:
-+
-[source,terminal]
-----
-$ oc adm new-project wasp
-----
-+
-[source,terminal]
-----
-$ oc create sa -n wasp wasp
-----
-+
-[source,terminal]
-----
-$ oc create clusterrolebinding wasp --clusterrole=cluster-admin --serviceaccount=wasp:wasp
-----
-+
-[source,terminal]
-----
-$ oc adm policy add-scc-to-user -n wasp privileged -z wasp
-----
-
-. Wait for the worker nodes to sync with the new configuration by running the following command:
+.. Wait for the worker nodes to sync with the new configuration by running the following command:
 +
 [source,yaml]
 ----
 $ oc wait mcp worker --for condition=Updated=True --timeout=-1s
 ----
 
-. Determine the pull URL for the wasp agent image by running the following command:
-+
-[source,terminal]
-----
-$ oc get csv -n openshift-cnv -l=operators.coreos.com/kubevirt-hyperconverged.openshift-cnv -ojson | jq '.items[0].spec.relatedImages[] | select(.name|test(".*wasp-agent.*")) | .image'
-----
-
-. Deploy `wasp-agent` by creating a `DaemonSet` object as shown in the following example:
-+
-[source,yaml]
-----
-kind: DaemonSet
-apiVersion: apps/v1
-metadata:
-  name: wasp-agent
-  namespace: wasp
-  labels:
-    app: wasp
-    tier: node
-spec:
-  selector:
-    matchLabels:
-      name: wasp
-  template:
-    metadata:
-      annotations:
-        description: >-
-          Configures swap for workloads
-      labels:
-        name: wasp
-    spec:
-      containers:
-        - env:
-            - name: SWAP_UTILIZATION_THRESHOLD_FACTOR
-              value: "0.8"
-            - name: MAX_AVERAGE_SWAP_IN_PAGES_PER_SECOND
-              value: "1000000000"
-            - name: MAX_AVERAGE_SWAP_OUT_PAGES_PER_SECOND
-              value: "1000000000"
-            - name: AVERAGE_WINDOW_SIZE_SECONDS
-              value: "30"
-            - name: VERBOSITY
-              value: "1"
-            - name: FSROOT
-              value: /host
-            - name: NODE_NAME
-              valueFrom:
-                fieldRef:
-                  fieldPath: spec.nodeName
-          image: >-
-            quay.io/openshift-virtualization/wasp-agent:v4.20 <1>
-          imagePullPolicy: Always
-          name: wasp-agent
-          resources:
-            requests:
-              cpu: 100m
-              memory: 50M
-          securityContext:
-            privileged: true
-          volumeMounts:
-            - mountPath: /host
-              name: host
-            - mountPath: /rootfs
-              name: rootfs
-      hostPID: true
-      hostUsers: true
-      priorityClassName: system-node-critical
-      serviceAccountName: wasp
-      terminationGracePeriodSeconds: 5
-      volumes:
-        - hostPath:
-            path: /
-          name: host
-        - hostPath:
-            path: /
-          name: rootfs
-  updateStrategy:
-    type: RollingUpdate
-    rollingUpdate:
-      maxUnavailable: 10%
-      maxSurge: 0
-----
-<1> Replace the `image` value with the image URL from the previous step.
-
-. Deploy alerting rules by creating a `PrometheusRule` object. For example:
-+
-[source,yaml]
-----
-apiVersion: monitoring.coreos.com/v1
-kind: PrometheusRule
-metadata:
-  labels:
-    tier: node
-    wasp.io: ""
-  name: wasp-rules
-  namespace: wasp
-spec:
-  groups:
-    - name: alerts.rules
-      rules:
-        - alert: NodeHighSwapActivity
-          annotations:
-            description: High swap activity detected at {{ $labels.instance }}. The rate
-              of swap out and swap in exceeds 200 in both operations in the last minute.
-              This could indicate memory pressure and may affect system performance.
-            runbook_url: https://github.com/openshift-virtualization/wasp-agent/tree/main/docs/runbooks/NodeHighSwapActivity.md
-            summary: High swap activity detected at {{ $labels.instance }}.
-          expr: rate(node_vmstat_pswpout[1m]) > 200 and rate(node_vmstat_pswpin[1m]) >
-            200
-          for: 1m
-          labels:
-            kubernetes_operator_component: kubevirt
-            kubernetes_operator_part_of: kubevirt
-            operator_health_impact: warning
-            severity: warning
-----
-
-. Add the `cluster-monitoring` label to the `wasp` namespace by running the following command:
-+
-[source,terminal]
-----
-$ oc label namespace wasp openshift.io/cluster-monitoring="true"
-----
-
 . Enable memory overcommitment in {VirtProductName} by using the web console or the CLI.
 +
 --
@@ -312,9 +170,9 @@ hyperconverged.hco.kubevirt.io/kubevirt-hyperconverged patched
 
 . To verify the deployment of `wasp-agent`, run the following command:
 +
-[source, terminal]
+[source,terminal,subs="attributes+"]
 ----
-$ oc rollout status ds wasp-agent -n wasp
+$ oc rollout status ds wasp-agent -n {CNVNamespace}
 ----
 +
 If the deployment is successful, the following message is displayed: