From 4c006e8a9ddf91e6686ee0580349ad31f275ea3f Mon Sep 17 00:00:00 2001
From: Joe Talerico aka rook <joe.talerico@gmail.com>
Date: Mon, 9 Sep 2024 15:42:24 -0400
Subject: [PATCH] Update README.md

Signed-off-by: Joe Talerico aka rook <joe.talerico@gmail.com>
---
 README.md | 13 ++++++++++++-
 1 file changed, 12 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index f13bab65..fa6fe2d0 100644
--- a/README.md
+++ b/README.md
@@ -35,7 +35,7 @@ $ cd k8s-netperf
 $ make docker-build
 ```
 
-## Running
+## Running with Pods
 Ensure your `kubeconfig` is properly set to the cluster you would like to run `k8s-netperf` against.
 
 also be sure to create a `netperf` namespace. (Not over-writable yet)
@@ -95,6 +95,17 @@ Flags:
 
 > *Note: With OpenShift, we attempt to discover the OpenShift route. If that route is not reachable, it might be required to `port-forward` the service and pass that via the `--prom` option.*
 
+## Running with VMs
+Running k8s-netperf against Virtual Machines (OpenShift CNV) requires
+
+- OpenShift CNV must be deployed and users should be able to define VMIs
+- SSH keys to be present in the home directory `(~/.ssh/id_rsa.pub)`
+- OpenShift Routes - k8s-netperf uses this to reach the VMs (k8s-netperf will create the route for the user, but we need Routes)
+
+If the two above are in place, users can orhestrate k8s-netperf to launch VMs by running
+
+`k8s-netperf --vm`
+
 ### Config file
 #### Config File v2
 The v2 config file will be executed in the order the tests are presented in the config file.