Welcome to Aqua-py

A fantastic Python 3 client for Aqua’s Container Security Platform.

This project is an early stage effort and has a status of experimental.
Questions, Comments, Feedback, Missing Calls, etc. Drop me a line @ jthorne@u.washington.edu

Installation

pip install aqua

Note: Requires Python 3.6 or higher due to reliance on Python’s typing module and f strings.

Getting Started

Start by creating an Aqua object. This object represents the Aqua CSP API endpoint

from aqua import Aqua

aqua = Aqua(id='administrator', password='password', host='mylo.uw.edu')
Note: At this time there is no need to specify API version. The SDK does this on your behalf.


Example Usage

Please refer to the Endpoint api doc at Aqua API Endpoint Class for current sdk api endpoint capabilities.

  1. Authentication: GithHub.

  2. Image Assurance: GitHub.



Use Cases

Example use cases from the field.

  1. Image profiling build task: GitHub

  2. Create Enforcer Group: GitHub.

  3. k8s Admission controller: GitHub

  4. Custom Excel Report: GitHub

  5. Full image details: GitHub