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
Zuul fac939b6e6 Merge "Update docs building" 2019-08-27 23:39:18 +00:00
adjutant Fix old py2 default value for action model 2019-06-26 13:03:19 +12:00
api-ref Update docs building 2019-08-11 12:06:13 +02:00
conf Fix sample config quota_services definition 2019-04-02 15:42:06 -04:00
doc Update docs building 2019-08-11 12:06:13 +02:00
releasenotes/source Update docs building 2019-08-11 12:06:13 +02:00
.coveragerc Additional Tests for Notification, Token and Email 2017-09-01 15:26:29 +12:00
.gitignore Added support for reno release notes 2019-07-02 15:04:04 +12:00
.gitreview OpenDev Migration Patch 2019-04-19 19:27:57 +00:00
.zuul.yaml Merge "Update docs building" 2019-08-27 23:39:18 +00:00
LICENSE adding license file 2017-05-12 16:02:04 +12:00
README.rst Update docs building 2019-08-11 12:06:13 +02:00
bindep.txt Add bindep.txt file 2019-06-26 10:56:37 +12:00
package_readme.rst Update docs building 2019-08-11 12:06:13 +02:00
requirements.txt Update requirements files 2019-05-17 10:48:32 +12:00
setup.cfg Merge "Update docs building" 2019-08-27 23:39:18 +00:00
setup.py Convert setup to use pbr 2019-05-17 11:56:30 +12:00
test-requirements.txt Update docs building 2019-08-11 12:06:13 +02:00
tox.ini Update docs building 2019-08-11 12:06:13 +02:00

README.rst

Team and repository tags

image

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://docs.openstack.org/adjutant/latest

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.