aquasec-cli

Aqua Security CLI

Installation

>>> python -m pip install aquasec-cli

Usage

Help Menu of all Groups:

>>> aquasec-cli --help
Usage: aquasec-cli [OPTIONS] COMMAND [ARGS]...

  AquaSec CLI tool to manage AquaSec Tenant

Options:
  --help  Show this message and exit.

Commands:
  delete   Deletes created API Auth
  init     Initializes API Auth
  reports  Generate CIS Bench Reports

>>> aquasec-cli init --help   
Usage: aquasec-cli init [OPTIONS]

  Initializes API Authentication token used to run commands; required to
  generate before a command can be executed

Options:
  --csp_roles TEXT  Creates Aquasec auth token
  --endpoints TEXT  Endpoint Call Allowed
  --help            Show this message and exit.

>>> aquasec-cli reports --help
Usage: aquasec-cli reports [OPTIONS]

  Generate CIS Bench Reports

  Used to generate CIS Bench Reports in different formats

Options:
  -r, --report_type [cis|kube_bench|linux|openshift|disa_stig|all]
                                  Report type to genorate
  -c, --cluster_name TEXT         Supply Cluster name
  -l, --report_location TEXT      Directory to write out report to; please
                                  ensure proper formatting given the system
                                  you are on  [required]
  --report_format [list|flat_list|raw]
                                  Report Format
  --help                          Show this message and exit.

>>> aquasec-cli delete --help
Usage: aquasec-cli delete [OPTIONS]

  Deletes created API Auth

Options:
  --yes
  --help  Show this message and exit.

NOTE: Each subcommand has a help menu to assist with the calls being made. This project relies on the yaml or localized configurations being help as they are not passed in the commands as of this release.

Create API Auth Token:

>>> aquasec-cli init --csp_roles="Auditor" --csp_roles="Admin" --endpoints="Any"
Initializing API
INFO    : Created WorkloadAuth Token for URL https://1234abcff1.cloud.aquasec.com

Run Report:

aquasec-cli  reports --report_type kube_bench --report_location /var/tmp --report_format list
Report completed Saving
Report written out to /var/tmp/aquasec_report_type_kube_bench_20230424T153825.json

Delete API Auth:

>>> aquasec-cli delete                                              
Are you sure you want to delete the auth api token? [y/N]: y
Deleted Auth

Release Info

v0.0.6

• Added error handling
• Added ability to generate different reports
• Updated requirements to new aquasec-api

v0.0.5

• Updated Readme and changed type from RST to MD
• Reverted snyk workflow file

v0.0.4

• fixed issue with broken aquasec-api v0.0.3

v0.0.3

• Fixed installation and dependencies
• locked down dependencies
• added toml and setup.cfg to support furture installations

v0.0.2

• Bug fix with requirements

Version

Warnings

Use at your own risk!!!

Security Policy

Supported Versions

Use this section to tell people about which versions of your project are currently being supported with security updates.

Reporting a Vulnerability

Use this section to tell people how to report a vulnerability.

Tell them where to go, how often they can expect to get an update on a reported vulnerability, what to expect if the vulnerability is accepted or declined, etc.