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 c750fd6d6c Rework Adjutant's config system to use CONFspirator
CONFspirator was written to just specifically for Adjutant
and it allows us to do oslo.config style config management
and definition with nested groups and for yaml.

This is a major change that touches vast amounts of the
code simply because of how much the config touches.

Actions, Tasks, DelegateAPIs, and Notification Handlers
now can define config in their own class and this will
be added to the config.

All the other config is located in `adjutant.config`,
with everything now registed nicely on the config tree,
and grouped in much saner ways.

CONFspirator will also now allow Adjutant to be entirely
configured via environment variables.

We have removed `modify_dict_settings` because that is
now entirely handled by CONFspirator's test utils.

`NotificationEngine`s are now `NotificationHandler`s.

`test_settings.py` is gone! And we now have better ways
to define test settings and defaults.

Project line length bumped to 88, and bugbear added to enforce
that instead.

Story: 2004488

Change-Id: I1d97d72d06b3a3a5df90355d3a4b4fe414381424
2020-02-05 19:07:04 +13:00
adjutant Rework Adjutant's config system to use CONFspirator 2020-02-05 19:07:04 +13:00
api-ref Rework Adjutant's config system to use CONFspirator 2020-02-05 19:07:04 +13:00
doc Rework Adjutant's config system to use CONFspirator 2020-02-05 19:07:04 +13:00
etc Rework Adjutant's config system to use CONFspirator 2020-02-05 19:07:04 +13:00
releasenotes Rework Adjutant's config system to use CONFspirator 2020-02-05 19:07:04 +13: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
bindep.txt Fix issue with lack of libssl in bindep 2019-12-04 13:12:05 +13:00
LICENSE adding license file 2017-05-12 16:02:04 +12:00
package_readme.rst Update docs building 2019-08-11 12:06:13 +02:00
README.rst Update docs building 2019-08-11 12:06:13 +02:00
requirements.txt Rework Adjutant's config system to use CONFspirator 2020-02-05 19:07:04 +13: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 Rework Adjutant's config system to use CONFspirator 2020-02-05 19:07:04 +13:00
tox.ini Rework Adjutant's config system to use CONFspirator 2020-02-05 19:07:04 +13:00

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.