Skip to content

Commit

Permalink
updated usage
Browse files Browse the repository at this point in the history
  • Loading branch information
AhmedBM committed Jan 29, 2025
1 parent 1696506 commit 2bd3203
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
6 changes: 3 additions & 3 deletions src/tests/universal-nrp-e2e/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions src/tests/universal-nrp-e2e/StartVMTest.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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)
Expand Down

0 comments on commit 2bd3203

Please sign in to comment.