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
88 lines
2.7 KiB
ReStructuredText
88 lines
2.7 KiB
ReStructuredText
####################################
|
|
Welcome to Adjutant's documentation!
|
|
####################################
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
development
|
|
release-notes
|
|
devstack-guide
|
|
configuration
|
|
plugins
|
|
quota
|
|
guide-lines
|
|
features
|
|
history
|
|
|
|
A basic workflow framework built using Django and Django-Rest-Framework to
|
|
help automate Admin tasks within an OpenStack cluster.
|
|
|
|
The goal of Adjutant is to provide a place and standard actions to fill in
|
|
functionality missing from Keystone, and allow for the easy addition of
|
|
business logic into more complex tasks, and connections with outside systems.
|
|
|
|
Tasks are built around three states of initial submission, admin approval and
|
|
token submission. All of the states are not always used in every task, but this
|
|
format allows the easy implementation of systems requiring approval and checks
|
|
final user data entry.
|
|
|
|
While this is a Django application, it does not follow the standard Django
|
|
folder structure because of certain packaging requirements. As such the project
|
|
does not have a manage.py file and must be installed via setup.py or pip.
|
|
|
|
Once installed, all the normal manage.py functions can be called directly on
|
|
the 'adjutant-api' commandline function.
|
|
|
|
The command ``tox -e venv {your commands}`` can be used and will setup a
|
|
virtual environment with all the required dependencies for you.
|
|
|
|
For example, running the server on port 5050 can be done with::
|
|
|
|
tox -e venv adjutant-api runserver 0.0.0.0:5050
|
|
|
|
|
|
***********************
|
|
Client and UI Libraries
|
|
***********************
|
|
|
|
Both a commandline/python and a horizon plugin exist for adjutant:
|
|
|
|
* `python-adjutantclient <https://opendev.org/openstack/python-adjutantclient>`_
|
|
* `adjutant-ui <https://opendev.org/openstack/adjutant-ui>`_
|
|
|
|
|
|
***********************
|
|
Tests and Documentation
|
|
***********************
|
|
|
|
Tests and documentation are managed by tox, they can be run simply with the
|
|
command ``tox``.
|
|
|
|
To run just action unit tests::
|
|
|
|
tox adjutant.actions
|
|
|
|
To run a single api test::
|
|
|
|
tox adjutant.api.v1.tests.test_api_taskview.TaskViewTests.test_duplicate_tasks_new_user
|
|
|
|
Tox will run the tests in Python 2.7, Python 3.5 and produce a coverage report.
|
|
|
|
Api reference can be generated with the command ``tox -e api-ref`` . This will
|
|
be placed in the ``api-ref/build`` directory, these docs can be generated with
|
|
the command ``tox -e docs``, these will be placed inside the ``doc/build``
|
|
directory.
|
|
|
|
|
|
************
|
|
Contributing
|
|
************
|
|
|
|
Bugs and blueprints for Adjutant, its ui and client are managed `here on
|
|
launchpad. <https://launchpad.net/adjutant>`_
|
|
|
|
Changes should be submitted through the OpenStack gerrit, the guide for
|
|
contributing to OpenStack projects is
|
|
`here <https://docs.openstack.org/contributor/>`_ .
|