NFV Orchestration (Tacker) Specifications
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.
Hiroyuki JO 4cf52b6bb7 Update Spec: Add support for VNF packages 1 month ago
doc Add Train specs directory 8 months ago
specs Update Spec: Add support for VNF packages 1 month ago
.gitignore Add base tacker-specs framework 5 years ago
.gitreview OpenDev Migration Patch 6 months ago
.testr.conf Add base tacker-specs framework 5 years ago
.zuul.yaml import zuul job settings from project-config 1 year ago
LICENSE Add base tacker-specs framework 5 years ago
README.rst Change tacker-specs webpage from oslosphinx to openstackdocstheme 1 year ago
setup.cfg Change openstack-dev to openstack-discuss 10 months ago
setup.py Add base tacker-specs framework 5 years ago
test-requirements.txt Refactor and clean up specs dir 1 year ago
tox.ini fix tox python3 overrides 1 year ago

README.rst

Team and repository tags

image

OpenStack Tacker Specifications

This git repository is used to hold approved design specifications for additions to the Tacker 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.

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

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

Launchpad blueprints for Tacker can be found at:

https://blueprints.launchpad.net/tacker

For more information about working with gerrit, see:

https://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. Please do not checkin the generated HTML files as a part of your commit.