NFV Orchestration (Tacker) Specifications
Go to file
Yasufumi Ogawa f9af3dcfa0 OpenTelemetry for monitoring VNF and CNF
Proposal for implementing OpenTelemetry plugin for introducing
observability feature in Tacker. OpenTelemetry is the one of the most
popular framework for providing observability and covering comperensive
usecases not only for VNF/CNF but also infra features [1].

[1] https://opentelemetry.io/

Implements: blueprint otel-monitoring
Change-Id: If35a064a966bdd5e59dab66367ca3218e7c12637
Signed-off-by: Yasufumi Ogawa <yasufum.o@gmail.com>
2023-12-20 09:55:41 +09:00
doc Fix the display problem of 2023.2 Specs 2023-09-29 15:51:28 +09:00
specs OpenTelemetry for monitoring VNF and CNF 2023-12-20 09:55:41 +09:00
.gitignore Remove testr 2021-06-30 23:53:16 +05:30
.gitreview OpenDev Migration Patch 2019-04-19 19:35:23 +00:00
.zuul.yaml Fix the display problem of 2023.2 Specs 2023-09-29 15:51:28 +09:00
LICENSE Add base tacker-specs framework 2014-06-03 17:55:27 +09:00
README.rst Fix the display problem of 2023.2 Specs 2023-09-29 15:51:28 +09:00
setup.cfg Merge "Update metadata in setup.cfg" 2023-07-20 15:08:50 +00:00
setup.py Add base tacker-specs framework 2014-06-03 17:55:27 +09:00
test-requirements.txt Refactor and clean up specs dir 2018-04-05 15:21:56 +09:00
tox.ini Update min version of tox 2021-05-10 16:51:07 +05:30

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 Zuul 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.

Note that even if a syntax error occurs in mermaid, it will not be an error in tox. When using mermaid to create diagrams, you need to carefully check the built html file.