aqua_reports

A custom use case reporting framework as a cli.
Auth defaults to external config file. Other auth plugins can be added if needed.

Current Supported Reports

• Image Findings [formats: xlsx]

Project Status: Experimental.
Note: Requires Python 3.6.8 or higher.

Installation

pip install .

Flags

'--registry', '-r' TEXT This is the friendly name of the registry in Aqua CSP
'--image', '-i' TEXT Optional container image found within specified registry
'--tag', '-t' TEXT Optional image tag
'--path', '-p' TEXT Optional. Path to store reports. Must exist. Defaults to current dir.
'--config', '-c' TEXT Optional. Path to config file. Defaults to config.yaml in current dir.

Examples

1. Generate reports for all images in the Docker Hub registry:
   aqua_reports -r 'Docker Hub'

2. Generate reports for all images in the nginx repo:
   aqua_reports -r "Docker Hub" -i nginx

3. Generate a report for a specific image:
   aqua_reports -r "Docker Hub" -i nginx -t latest

4. Store generated report/s in reports subdirectory:
   aqua_reports -r "AWS-ECR" -i concourse-pr -p ./reports

5. Custom config.yaml file location:
   aqua_reports -r "AWS-ECR" -i concourse-pr -p ./reports -c ~/config.yaml