A simple workflow framework to help automate admin and user tasks in and around OpenStack via a pluggable API exposing tasks made up of easily chainable actions.
Go to file
Andreas Jaeger e058342cb0 Use openstack-tox-cover template
Use openstack-tox-cover template, this runs the cover job
in the check queue only.

Remove jobs and use template instead.

Change-Id: Ife76352318046a248421053bfefa3bed5251e4a2
2018-09-07 12:51:54 +02:00
adjutant Merge "fix typos in documentation" 2018-08-18 01:59:56 +00:00
api-ref Add Quota Docs and API references 2018-02-12 14:33:35 +13:00
conf fix typos in documentation 2018-05-23 20:54:12 +08:00
doc fix typos in documentation 2018-05-23 20:54:12 +08:00
.coveragerc Additional Tests for Notification, Token and Email 2017-09-01 15:26:29 +12:00
.gitignore fix zuul cover issues 2017-10-30 14:13:05 +13:00
.gitreview fix the project setting in .gitreview 2018-08-07 13:30:53 -04:00
.zuul.yaml Use openstack-tox-cover template 2018-09-07 12:51:54 +02:00
LICENSE adding license file 2017-05-12 16:02:04 +12:00
MANIFEST.in Renaming StackTask to Adjutant 2017-05-17 12:25:45 +12:00
README.md Add link to Read the Docs for project doc 2017-11-04 18:59:45 +13:00
package_readme.rst Renaming StackTask to Adjutant 2017-05-17 12:25:45 +12:00
requirements.txt Add Octavia (LBaaS) into quota management 2018-02-12 18:48:02 +13:00
setup.py Update test files for openstack-infra 2017-06-21 16:18:37 +12:00
test-requirements.txt Documentation and Api Reference 2017-11-04 18:00:28 +13:00
tox.ini fix tox python3 overrides 2018-08-18 01:53:08 +00:00

README.md

Adjutant

A basic workflow framework built using Django and Django-Rest-Framework to help automate basic Admin tasks within an OpenStack cluster.

Primarily built as user registration service that fits into the OpenStack ecosystem alongside Keystone, its purpose to fill functionality missing from Keystone. Ultimately it is just a framework with actions that are tied to an endpoint and can require certain data fields and perform actions via the OpenStack clients as well as talk to external systems as needed.

Useful for automating generic admin tasks that users might request but otherwise can't do without the admin role. Also allows automating the signup and creation of new users, but also allows such requests to require approval first if wanted. Due to issuing of uri+tokens for final steps of some actions, allows for a password submit/reset system as well.

Documentation:

Documentation can be found at: https://adjutant.readthedocs.io/

Documentation is stored in doc/, a sphinx build of the documentation can be generated with the command 'tox -e docs'.

An API Reference is stored in api-ref. This is also a sphinx build and can be generated with 'tox -e api-ref'.