diff --git a/vulnerability-management/export-workloads/README.md b/vulnerability-management/export-workloads/README.md index e3b53fe..e1f8f14 100644 --- a/vulnerability-management/export-workloads/README.md +++ b/vulnerability-management/export-workloads/README.md @@ -9,6 +9,40 @@ The following sections provide use case examples utilizing either the shell or P See `export-workloads.sh` for a shell script example based on `curl` and `jq`. +* Export all workloads. +```shell +export-workloads.sh +``` +* Export all workloads from the cluster `prod`. +```shell +export-workloads.sh "Cluster%3Aprod" +``` +* Export all workloads matching the query `Deployment:app Namespace:default`. +```shell +export-workloads.sh "Deployment%3Aapp%2BNamespace%3Adefault" +``` +* Export all workloads with a timeout of 60 seconds. +```shell +export-workloads.sh "" 60 +``` + ## Python script See `export-workloads.py` for a python script example. + +* Export all workloads. +```shell +export-workloads.py +``` +* Export all workloads from the cluster `prod`. +```shell +export-workloads.py --query="Cluster%3Aprod" +``` +* Export all workloads matching the query `Deployment:app Namespace:default`. +```shell +export-workloads.py --query="Deployment%3Aapp%2BNamespace%3Adefault" +``` +* Export all workloads with a timeout of 60 seconds. +```shell +export-workloads.py --timeout=60 +``` diff --git a/vulnerability-management/export-workloads/export-workloads.py b/vulnerability-management/export-workloads/export-workloads.py index f59fa3a..7592da3 100755 --- a/vulnerability-management/export-workloads/export-workloads.py +++ b/vulnerability-management/export-workloads/export-workloads.py @@ -12,7 +12,7 @@ # Further processing may be done on the parsed objects. # # Requires ROX_ENDPOINT and ROX_API_TOKEN environment variables. -# The API token requires at least analyst access in Central. +# The API token requires read access on images and deployments. import argparse import json diff --git a/vulnerability-management/export-workloads/export-workloads.sh b/vulnerability-management/export-workloads/export-workloads.sh index 41381d5..98b3b4e 100755 --- a/vulnerability-management/export-workloads/export-workloads.sh +++ b/vulnerability-management/export-workloads/export-workloads.sh @@ -12,7 +12,9 @@ # ] # # Requires ROX_ENDPOINT and ROX_API_TOKEN environment variables. -# The API token requires at least analyst access in Central. +# The API token requires read access on images and deployments. + +set -euo pipefail case $1 in *help)