Merge pull request #33 from openshift-virtualization/user-docs-update

User docs update

README.md

@@ -1,23 +1,12 @@
-```console
-# Build
-$ bash to.sh build
-$ bash to.sh push  # only to my account right now
+# Out-of-tree SWAP with WASP
 
-# Deploy to OCP 4.15 or higher
-$ oc login --token= …
-$ bash to.sh deploy
+WASP can be used in order to grant SWAP to certain containers using
+an out-of-(kubernetes)-tree mechanism based on an OCI hook.
 
-# Demo
-$ oc apply -f manifests/static.yaml
-$ oc apply -f manifests/stress.yaml
-# Now increase the stress deployment replicacount in order to push out
-# memory of static pods
+The design can be found in https://github.com/openshift/enhancements/pull/1630
 
-# Destroy
-$ bash to.sh destroy
-```
+# Scope
 
-The POC does the following
 - Node
   - Enable swap on the node
   - Disable swap in the system.slice
@@ -28,3 +17,25 @@ The POC does the following
 - Workloads
   - Enable swap=max for every burstable pod using an OCI hook
   - Set limited swap for workloads (TODO)
+
+# Build
+
+    $ bash to.sh build
+    $ bash to.sh push  # only to my account right now
+
+# Deploy
+
+    # Deploy to OCP 4.15 or higher
+    $ oc login --token= …
+    $ bash to.sh deploy
+
+# Demo
+
+    $ oc apply -f manifests/static.yaml
+    $ oc apply -f manifests/stress.yaml
+    # Now increase the stress deployment replicacount in order to push out
+    # memory of static pods
+
+# Destroy
+
+    $ bash to.sh destroy

docs/configuration.md

@@ -110,7 +110,7 @@ $ oc patch --type=merge \
 
 1. Validate the deployment
 
-       $ oc rollout status ds wasp-agent -n wasp
+       $ oc rollout status ds wasp-agent -n wasp --timeout 2m
        daemon set "wasp-agent" successfully rolled out
 
 2. Validate correctly provisioned swap by running:
@@ -137,7 +137,9 @@ $ oc patch --type=merge \
     have configured earlier on.
 
 4. Validate Virtual Machine memory overcommitment
-   TBD
+   Create a VM with as much memory as the node has. Without memory
+   overcommit the VM will not be scheduled. Only with memory
+   overcommit the VM will be scheduled and can run.
 
 ### Additional Resources