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
melissaml 9ef78c436e Fix pygments style
New theme of docs respects pygments_style.

more info: http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html

Change-Id: I0247f2e6e76d9995f1720eac8be180e64c5bf243
2020-06-23 15:39:49 +08:00
adjutant Stop to use the __future__ module. 2020-06-02 19:31:59 +02:00
api-ref Fix pygments style 2020-06-23 15:39:49 +08:00
doc Fix pygments style 2020-06-23 15:39:49 +08:00
etc Use Django's SECURE_PROXY_SSL_HEADER and add config 2020-02-21 11:53:19 +13:00
releasenotes Fix pygments style 2020-06-23 15:39:49 +08:00
.coveragerc Additional Tests for Notification, Token and Email 2017-09-01 15:26:29 +12:00
.git-blame-ignore-revs Add tests for Black, and ignore reformat blame 2020-02-21 14:52:39 +13: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 Add Python3 victoria unit tests 2020-04-30 06:52:52 +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 Fix issue with lack of libssl in bindep 2019-12-04 13:12:05 +13:00
package_readme.rst Update docs building 2019-08-11 12:06:13 +02:00
requirements.txt Update to Django 2.2, drop py2 support 2020-02-14 10:42:27 +13:00
setup.cfg Add py38 package metadata 2020-05-06 00:02:23 +00:00
setup.py Reformat code using the Black style linter 2020-02-21 14:43:31 +13:00
test-requirements.txt Use unittest.mock instead of third party mock 2020-03-24 07:47:24 -05:00
tox.ini Add pyc cleanup and black check to tox 2020-05-06 11:34:51 +12: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.