From 2bd320348976179ccde46f4258851b5cf8d2ad78 Mon Sep 17 00:00:00 2001 From: "Ahmed Messaoud (from Dev Box)" Date: Wed, 29 Jan 2025 21:21:50 +0000 Subject: [PATCH] updated usage --- src/tests/universal-nrp-e2e/README.md | 6 +++--- src/tests/universal-nrp-e2e/StartVMTest.sh | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/src/tests/universal-nrp-e2e/README.md b/src/tests/universal-nrp-e2e/README.md index 467771694..8bf0a5e8f 100644 --- a/src/tests/universal-nrp-e2e/README.md +++ b/src/tests/universal-nrp-e2e/README.md @@ -89,8 +89,8 @@ Usage: ./StartLocalTest.sh [-s stage-name] [-p policy-package.zip [-r]] ## Testing on VMs ``` -Usage: ./StartVMTest.sh [-i /path/to/image.img -p /path/to/policypackage.zip [-g]] [-m 512] [-r] [-d] - -i Image Path: Path to the image qcow2 format +Usage: ./StartVMTest.sh [-i image.img -p policypackage.zip [-r]] [-i image.img -g] [-m 512] [-d] + -i Image Path: Path to the image (raw or qcow2 format) -p Policy Package: Path to the policy package -m VM Memory (Megabytes): Size of VMs RAM (Default: 512) -r Remediation: Perform remediation flag (Default: false) @@ -99,7 +99,7 @@ Usage: ./StartVMTest.sh [-i /path/to/image.img -p /path/to/policypackage.zip [-g - Clean package management cache - Clean cloud-init flags to reset cloud-init to initial-state -l Log Directory: Directory used to place output logs - -d Debug Mode: VM stays up for debugging (Default: false) + -d Debug Mode Flag: VM stays up for debugging (Default: false) ``` ### VM Image Sources It's preferable for images to be "Cloud" images (contain cloud-init) as it makes tooling work out-of-box and does not require creating your own image of the distro and getting all the necessary packages/dependencies installed. diff --git a/src/tests/universal-nrp-e2e/StartVMTest.sh b/src/tests/universal-nrp-e2e/StartVMTest.sh index f92a3d54f..ddc74db75 100755 --- a/src/tests/universal-nrp-e2e/StartVMTest.sh +++ b/src/tests/universal-nrp-e2e/StartVMTest.sh @@ -9,7 +9,7 @@ # image and a debug mode that will leave the VM up for debugging. # # Usage: ./StartVMTest.sh [-i image.img -p policypackage.zip [-r]] [-i image.img -g] [-m 512] [-d] -# -i Image Path: Path to the image qcow2 format +# -i Image Path: Path to the image (raw or qcow2 format) # -p Policy Package: Path to the policy package # -m VM Memory (Megabytes): Size of VMs RAM (Default: 512) # -r Remediation: Perform remediation flag (Default: false) @@ -41,7 +41,7 @@ provisionedUser="user1" usage() { echo "Usage: $0 [-i image.img -p policypackage.zip [-r]] [-i image.img -g] [-m 512] [-d] - -i Image Path: Path to the image qcow2 format + -i Image Path: Path to the image (raw or qcow2 format) -p Policy Package: Path to the policy package -m VM Memory (Megabytes): Size of VMs RAM (Default: 512) -r Remediation: Perform remediation flag (Default: false)