f81cf9a905
Follow PTI [1] for doc building: * Create doc/requirements.txt file with all docs requirements. * Switch to openstackdocstheme and update conf.py for this. * Move doc8 to pep8 section since it's a linter. Additionally: * Fix all build errors with doc building. * Update requirements list with license info. * Use hacking instead of flake directly. * Remove unused _static files, those are not needed. * Update git URLs, fix contributor guide URL * Move README.md to RST, everything else in this repo is RST * Publish documents to docs.o.o - note that https://adjutant.readthedocs.io/en/latest/ was last updated in March 2018 This adds jobs for building of release notes - only building since there's no content yet - and publishing of documentation. Publishing of api-ref can be done via: https://review.opendev.org/675766 [1] https://governance.openstack.org/tc/reference/project-testing-interface.html#documentation Change-Id: I82f56ef5ea800899b2a8db795b6cf2b21d03ac7a
33 lines
1.1 KiB
ReStructuredText
33 lines
1.1 KiB
ReStructuredText
Adjutant is a service that sits along Keystone and allows the
|
|
automation and approval of tasks normally requiring a user with an
|
|
admin role. Adjutant allows defining of such tasks as part of a
|
|
workflow which can either be entirely automatic, or require admin
|
|
approval. The goal is to automate business logic, and augment the
|
|
functionality of Keystone and other OpenStack services without getting
|
|
in the way of future OpenStack features or duplicating development
|
|
effort.
|
|
|
|
Quick Dev Deployment
|
|
====================
|
|
|
|
To quickly deploy the service for testing you can install via pip,
|
|
setup a default config file, and then run the test Django server.
|
|
|
|
::
|
|
|
|
pip install adjutant
|
|
|
|
Then running the service will look for a config in either
|
|
**/etc/adjutant/conf.yaml** or it will default to **conf/conf.yaml**
|
|
from the directory you run the command in.
|
|
|
|
::
|
|
|
|
adjutant migrate
|
|
adjutant runserver <port>
|
|
|
|
For now you will have to source the default conf from the github repo
|
|
or the library install location itself, but we hope to add an
|
|
additional commandline function which will copy and setup a basic
|
|
default config in **/etc/adjutant/conf.yaml**.
|