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
Adrian Turjak c5ba76c4eb Fix lack of package include in pbr patch
Change-Id: Ib72bdf96ce6c10be365fc8e26a8e5bfb57150a3f
2019-05-28 15:47:08 +12:00
adjutant Convert setup to use pbr 2019-05-17 11:56:30 +12:00
api-ref Add Quota Docs and API references 2018-02-12 14:33:35 +13:00
conf Fix sample config quota_services definition 2019-04-02 15:42:06 -04:00
doc Merge "Spelling mistake, refered -> referred" 2018-12-01 17:15:02 +00:00
.coveragerc Additional Tests for Notification, Token and Email 2017-09-01 15:26:29 +12:00
.gitignore Convert setup to use pbr 2019-05-17 11:56:30 +12:00
.gitreview OpenDev Migration Patch 2019-04-19 19:27:57 +00:00
.zuul.yaml Dropping the py35 testing 2019-05-17 13:14:40 +12:00
LICENSE adding license file 2017-05-12 16:02:04 +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 Update requirements files 2019-05-17 10:48:32 +12:00
setup.cfg Fix lack of package include in pbr patch 2019-05-28 15:47:08 +12:00
setup.py Convert setup to use pbr 2019-05-17 11:56:30 +12:00
test-requirements.txt Update requirements files 2019-05-17 10:48:32 +12:00
tox.ini Dropping the py35 testing 2019-05-17 13:14:40 +12: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'.