Design Specifications for OpenStack-Ansible
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
OpenDev Sysadmins 4c4ae8fdb8 OpenDev Migration Patch 1 month ago
doc/source doc: source: index: Add Rocky specifications to index 1 year ago
specs [Trivial Fix] dumplicate words was deleted in developer-docs.rst 4 months ago
tests Cleaned up specs directory 3 years ago
tools Initial commit for OS-Ansible-Deployment specs 4 years ago
.gitignore Updated from OpenStack Ansible Tests 7 months ago
.gitreview OpenDev Migration Patch 1 month ago
.testr.conf Initial commit for OS-Ansible-Deployment specs 4 years ago
.zuul.yaml import zuul job settings from project-config 9 months ago
LICENSE Initial commit for OS-Ansible-Deployment specs 4 years ago
README.rst Update links in README 1 year ago
requirements.txt Updated from global requirements 1 year ago
setup.cfg Update mailinglist from dev to discuss 5 months ago
setup.py Updated from global requirements 2 years ago
tox.ini fix tox python3 overrides 7 months ago

README.rst

Team and repository tags

image

OS-Ansible-Deployment Specifications

This git repository is used to hold approved design specifications for additions to the OS-Ansible-Deployment project. Reviews of the specs are done in gerrit, using a similar workflow to how we review and merge changes to the code itself.

The layout of this repository is:

specs/<release>/

You can find an example spec in specs/template.rst.

Specifications are proposed for a given release by adding them to the specs/<release> directory and posting it for review. The implementation status of a blueprint for a given release can be found by looking at the blueprint in Launchpad. Not all approved blueprints will get fully implemented.

Specifications have to be re-proposed for every release. The review may be quick, but even if something was previously approved, it should be re-reviewed to make sure it still makes sense as written.

Prior to the Juno development cycle, this repository was not used for spec reviews. Reviews prior to Juno were completed entirely through Launchpad blueprints:

https://blueprints.launchpad.net/openstack-ansible

Please note, Launchpad blueprints are still used for tracking the current status of blueprints. For more information, see:

https://wiki.openstack.org/wiki/Blueprints

For more information about working with gerrit, see:

http://docs.openstack.org/infra/manual/developers.html#development-workflow

To validate that the specification is syntactically correct (i.e. get more confidence in the Jenkins result), please execute the following command:

$ tox

After running tox, the documentation will be available for viewing in HTML format in the doc/build/ directory.