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
Dr. Jens Harbott acc4a44e87 Fix deprecated zuul queue syntax
Zuul deprecated (and now removed) declaring shared queues at a pipeline
level [1]. This patch fixes the syntax to make the gate work for
adjutant.

[1] https://lists.openstack.org/pipermail/openstack-discuss/2022-May/028603.html

Change-Id: I1420f59cc5a315a47f7a4bfe0ac2a9761d06e11d
2023-06-06 18:52:15 +00:00
adjutant Allow authenticated token requirement for tasks 2020-09-17 13:01:12 +12:00
api-ref Fix pygments style 2020-06-23 15:39:49 +08:00
doc Allow authenticated token requirement for tasks 2020-09-17 13:01:12 +12:00
etc Update CONFspirator with example and toml support 2020-08-07 20:28:24 +12:00
releasenotes Allow authenticated token requirement for tasks 2020-09-17 13:01:12 +12:00
.coveragerc Additional Tests for Notification, Token and Email 2017-09-01 15:26:29 +12:00
.git-blame-ignore-revs Ignore blame for Black formatting update 2020-09-17 12:57:06 +12:00
.gitignore Added support for reno release notes 2019-07-02 15:04:04 +12:00
.gitreview Update .gitreview for stable/victoria 2020-09-25 08:37:54 +00:00
.zuul.yaml Fix deprecated zuul queue syntax 2023-06-06 18:52:15 +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 CONFspirator with example and toml support 2020-08-07 20:28:24 +12:00
setup.cfg Add py38 package metadata 2020-05-06 00:02:23 +00:00
setup.py Reformat with updated version of black formatter 2020-09-17 12:56:00 +12:00
test-requirements.txt Use unittest.mock instead of third party mock 2020-03-24 07:47:24 -05:00
tox.ini Update TOX_CONSTRAINTS_FILE for stable/victoria 2020-09-25 08:37:58 +00: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.