From edaa1be4bcb53db87ea61a3bfd26e94a012cb5bc Mon Sep 17 00:00:00 2001 From: Rafael Folco Date: Fri, 26 Jul 2019 09:16:18 -0300 Subject: [PATCH] Generate fs matrix from source yaml files Use featureset yaml files as the unique source of truth. When updating fs yaml files, one should run 'tox -e docs' to update the featureset matrix. Tox calls a python code to parse featureset yaml files and generate the matrix in doc/source/featureset-configuration-generated.rst, which in turn, is imported into the featureset configuration page. Change includes: - Normalized matrix headers w/ 5 chars - Legend w/ acronyms and symbols automatically generated - Features marked as enabled, disabled, not found, or enabled by release. - Removed default settings enabled after release XYZ that are not controlled by the featureset file: e.g. cnf-dl. - Removed settings not present in any fs: ssl uc (SSL Undercloud), NI Bond (Network Isolation Bond), nonha (non-HA), PM (Pacemaker), IPSec (IPSec tunnels). - Merged SSL overcloud INT and EXT into a single SSL OC. Change-Id: Iee4eaaad37d1ac1d595e2430c1cbea09349522b8 Task: https://tree.taiga.io/project/tripleo-ci-board/task/1202 Co-Authored-By: Sorin Sbarnea --- .pre-commit-config.yaml | 12 + .../feature-configuration-generated.rst | 234 ++++++++++++++++++ doc/source/feature-configuration.rst | 203 +-------------- fs-matrix.py | 162 ++++++++++++ test-requirements.txt | 2 + tox.ini | 4 +- 6 files changed, 414 insertions(+), 203 deletions(-) create mode 100644 doc/source/feature-configuration-generated.rst create mode 100644 fs-matrix.py diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 159f39efa..c56dd8db9 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,5 +1,17 @@ --- repos: + - repo: local + hooks: + - id: build-fs-matrix + name: build-fs-matrix + entry: python fs-matrix.py > doc/source/feature-configuration-generated.rst + files: config/general_config + language: python + language_version: python3 + always_run: true + additional_dependencies: + - texttable + - pyyaml - repo: https://github.com/pre-commit/pre-commit-hooks rev: v2.1.0 hooks: diff --git a/doc/source/feature-configuration-generated.rst b/doc/source/feature-configuration-generated.rst new file mode 100644 index 000000000..53a084221 --- /dev/null +++ b/doc/source/feature-configuration-generated.rst @@ -0,0 +1,234 @@ ++-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+ +| Fset# | BrowB | Cephd | ConOC | ConUC | HAval | HConv | IPv6 | Idemp | Intro | NIsol | NItyp | PingT | SSLoc | Scen# | Stdln | Temps | UPDoc | UPGff | UPGoc | UPGuc | Valid | ++=======+=======+=======+=======+=======+=======+=======+=======+=======+=======+=======+=======+=======+=======+=======+=======+=======+=======+=======+=======+=======+=======+ +| 001_ | | ◍ | ◍ | ◍ | | | | | ◉ | ◉ | ☰ | ◍ | ◉ | | | ◍ | | | | | | ++-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+ +| 002_ | | ◍ | ◍ | ◍ | | | | ❍ | ◉ | ◉ | ☰ | ◍ | ◉ | | | ❍ | | | | | | ++-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+ +| 003_ | | | | ❍ | | | | ◉ | | | | ❍ | ❍ | | | ◉ | | | | | | ++-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+ +| 004_ | | | | | | | | | | | | ◉ | ❍ | | | | | | | | ◉ | ++-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+ +| 005_ | | | | | | | | | | | | ◍ | | 001 | | ◍ | | | | | ◉ | ++-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+ +| 006_ | | | | | | | | | | | | ◍ | | 002 | | ◍ | | | | | ◉ | ++-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+ +| 007_ | | | | | | | | | | | | ◍ | | 003 | | ◍ | | | | | ◉ | ++-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+ +| 008_ | | | | | | | | | | | | ◍ | | 004 | | ◍ | | | | | ◉ | ++-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+ +| 009_ | | | | | | | | | | | | ◉ | | 005 | | | | | | | | ++-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+ +| 010_ | | | ◉ | ◍ | | | ❍ | | | ❍ | | ❍ | ❍ | | | ◍ | | | | | ◉ | ++-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+ +| 011_ | | | ❍ | | | | ❍ | | ❍ | ❍ | | ◉ | ❍ | | | ❍ | | | ◉ | ❍ | | ++-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+ +| 012_ | | | ❍ | | | | ❍ | | ❍ | ❍ | | ◉ | ❍ | 001 | | ❍ | | | ◉ | | | ++-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+ +| 013_ | | | ❍ | | | | ❍ | | ❍ | ❍ | | ◉ | ❍ | 002 | | ❍ | | | ◉ | | | ++-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+ +| 014_ | | | ❍ | | | | ❍ | | ❍ | ❍ | | ◉ | ❍ | 003 | | ❍ | | | ◉ | | | ++-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+ +| 015_ | | | ❍ | | | | ❍ | | ❍ | ❍ | | ◉ | ❍ | 004 | | ❍ | | | ◉ | | | ++-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+ +| 016_ | | | ◉ | ◍ | | | ❍ | | ❍ | ❍ | | ◍ | ❍ | 001 | | ◍ | | | | | | ++-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+ +| 017_ | | | ◉ | ◍ | | | ❍ | | ❍ | ❍ | | ◍ | | 002 | | ◍ | | | | | | ++-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+ +| 018_ | | | ◉ | ◍ | | | ❍ | | ❍ | ❍ | | ◍ | ❍ | 003 | | ◍ | | | | | | ++-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+ +| 019_ | | | ◉ | ◍ | | | ❍ | | ❍ | ❍ | | ◍ | ❍ | 004 | | ◍ | | | | | | ++-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+ +| 020_ | | ❍ | ◍ | ◍ | | | | ◍ | ◉ | ◉ | ☰ | ❍ | ❍ | | | ◉ | | | | | | ++-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+ +| 021_ | | ❍ | ◍ | ◍ | | | | | ◉ | ◉ | ☰ | ❍ | ❍ | | | ◉ | | | | | | ++-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+ +| 022_ | | ❍ | ◉ | | | | ❍ | | ◉ | ❍ | | ◉ | ❍ | | | ❍ | | | | | | ++-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+ +| 023_ | | | | | | | | | | | | ❍ | ❍ | | | ❍ | | | | | | ++-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+ +| 024_ | | ◉ | | | | | ◉ | | ◉ | ◉ | ☰ | ◉ | ❍ | | | ❍ | | | | | | ++-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+ +| 025_ | | ❍ | | | | ◉ | | | ◉ | ◉ | ☰ | ◉ | ◉ | | | ❍ | | | | | | ++-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+ +| 026_ | | ❍ | ◉ | | | | ❍ | | | ❍ | | ❍ | ❍ | 006 | | ❍ | | | | | | ++-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+ +| 027_ | | ❍ | ❍ | ◉ | | | ❍ | | ❍ | ❍ | | ❍ | ❍ | | | ◉ | | | | | | ++-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+ +| 028_ | | ❍ | ❍ | | | | ❍ | | | ❍ | | ❍ | ❍ | 007 | | ◉ | | | | | | ++-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+ +| 030_ | | ◍ | ◉ | ◍ | | | ❍ | | | ❍ | | ❍ | ❍ | 007 | | ◉ | | | | | | ++-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+ +| 031_ | | ❍ | ◉ | | | | ❍ | | | ❍ | | ❍ | ❍ | 008 | | ◉ | | | | | | ++-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+ +| 032_ | | | ◉ | ◍ | | | ❍ | | | ❍ | | ❍ | ❍ | | | ◉ | | | | | | ++-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+ +| 033_ | | ❍ | ◉ | ◉ | | | ❍ | | | ❍ | | ❍ | ❍ | 009 | | ❍ | | | | | | ++-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+ +| 035_ | | ❍ | ◉ | ◍ | | | ◉ | | ◉ | ◉ | ☰ | ❍ | ◉ | | | ◉ | | | | | | ++-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+ +| 036_ | | | | | | | | | | | | ❍ | | 002 | | ❍ | | ◉ | ◉ | | ❍ | ++-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+ +| 037_ | | | ◉ | ◍ | | | ❍ | | | ❍ | | ❍ | ❍ | 000 | | ❍ | ◉ | | | | ❍ | ++-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+ +| 038_ | | | ◉ | ◍ | | | ❍ | | | ❍ | | ❍ | ❍ | 010 | | ❍ | | | | | | ++-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+ +| 039_ | | ◍ | ◍ | ◍ | | | | | ◉ | ◉ | ☰ | ◍ | ◉ | | | ◍ | | | | | | ++-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+ +| 040_ | | | ◉ | ◍ | | | ❍ | | ❍ | | | ❍ | ❍ | 003 | | ◉ | | | ◉ | | | ++-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+ +| 041_ | | ◍ | ◍ | ◍ | ◉ | | | | ◉ | ◉ | ☰ | ◍ | ◉ | | | ◍ | | | | | | ++-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+ +| 042_ | | ❍ | ◉ | | | | | | ◉ | ◉ | ☰ | ❍ | ◉ | | | ◉ | | | | | | ++-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+ +| 045_ | | | ◉ | | | | ❍ | | ❍ | | | ◉ | ❍ | 000 | | ❍ | | | | | | ++-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+ +| 047_ | | | ❍ | | | | | ◉ | | | | ❍ | ❍ | | | ❍ | | | ❍ | ◉ | | ++-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+ +| 048_ | | ❍ | ◍ | | | | | | ◉ | ❍ | | ❍ | ❍ | | | ◉ | | | | | | ++-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+ +| 049_ | | ◉ | ◉ | | | | | | ❍ | ◉ | ─ | ❍ | ❍ | | | ❍ | | | | | | ++-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+ +| 050_ | | | ❍ | ❍ | | | | | | | | ❍ | ❍ | | | ❍ | | | ❍ | ◉ | | ++-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+ +| 051_ | | | ◉ | ◍ | | | ❍ | | ❍ | ❍ | | ❍ | ❍ | 000 | | ❍ | | | ◉ | | ❍ | ++-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+ +| 052_ | | | | | | | | | | | | ❍ | | | ◉ | ◉ | | | | | | ++-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+ +| 053_ | ◉ | ◍ | ◍ | ◍ | | | | | ◉ | ◉ | ☰ | ◍ | ❍ | | | ◍ | | | | | | ++-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+ +| 054_ | | | ◉ | | | | ❍ | | | ❍ | | ❍ | ❍ | 012 | | ◉ | | | | | | ++-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+ +| 055_ | | | ◉ | | | | ❍ | | ❍ | ❍ | | ◍ | ❍ | 002 | | ◍ | | | | | | ++-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+ +| 056_ | | | | | | | | | | | | ❍ | | | ◉ | ◉ | | | | | | ++-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+ +| 058_ | | | | | | | | | | | | ❍ | | | ◉ | ◉ | | | | | | ++-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+ +| 060_ | | | | | | | | | | | | ❍ | | | ◉ | ◉ | | | | | | ++-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+ +| 061_ | | ❍ | ❍ | ◉ | | | ❍ | | ❍ | ❍ | | ❍ | | | | ◉ | | | | | | ++-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+ +| 099_ | | | | | | | | | | | | ❍ | | | ◉ | ◉ | | | | | | ++-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+ + + ++---------+----------------------------------+ +| Acronym | Definition | ++=========+==================================+ +| BrowB | Browbeat performance testing | ++---------+----------------------------------+ +| Cephd | Ceph deploy | ++---------+----------------------------------+ +| ConOC | Containerized overcloud | ++---------+----------------------------------+ +| ConUC | Containerized undecloud | ++---------+----------------------------------+ +| HAval | HA Validation | ++---------+----------------------------------+ +| HConv | Undercloud Heat Convergence | ++---------+----------------------------------+ +| IPv6 | Overcloud IPv6 | ++---------+----------------------------------+ +| Idemp | Undercloud Idempotency Check | ++---------+----------------------------------+ +| Intro | Introspection | ++---------+----------------------------------+ +| NIsol | Network Isolation | ++---------+----------------------------------+ +| NItyp | Network Isolation Type | ++---------+----------------------------------+ +| PingT | Ping and ssh tests | ++---------+----------------------------------+ +| SSLoc | Overcloud SSL | ++---------+----------------------------------+ +| Scen# | Scenario ### | ++---------+----------------------------------+ +| Stdln | Standalone Deploy | ++---------+----------------------------------+ +| Temps | run Tempest | ++---------+----------------------------------+ +| UPDoc | Overcloud Update (Minor Upgrade) | ++---------+----------------------------------+ +| UPGff | Fast-forward Overcloud Upgrade | ++---------+----------------------------------+ +| UPGoc | Overcloud Major Upgrade | ++---------+----------------------------------+ +| UPGuc | Undercloud Upgrade | ++---------+----------------------------------+ +| Valid | Validations | ++---------+----------------------------------+ + + ++--------+---------------------------------------------------+ +| Symbol | Description | ++========+===================================================+ +| ◉ | Feature enabled in all releases | ++--------+---------------------------------------------------+ +| ◍ | Feature enabled in certain releases only | ++--------+---------------------------------------------------+ +| ❍ | Feature explicitly disabled in all releases | ++--------+---------------------------------------------------+ +| | Feature not found | ++--------+---------------------------------------------------+ +| ☰ | Network isolation multiple network interfacecards | ++--------+---------------------------------------------------+ +| ─ | Network isolation single network interface card | ++--------+---------------------------------------------------+ + + +.. _001: https://opendev.org/openstack/tripleo-quickstart/config/general_config/src/branch/master/featureset001.yml +.. _002: https://opendev.org/openstack/tripleo-quickstart/config/general_config/src/branch/master/featureset002.yml +.. _003: https://opendev.org/openstack/tripleo-quickstart/config/general_config/src/branch/master/featureset003.yml +.. _004: https://opendev.org/openstack/tripleo-quickstart/config/general_config/src/branch/master/featureset004.yml +.. _005: https://opendev.org/openstack/tripleo-quickstart/config/general_config/src/branch/master/featureset005.yml +.. _006: https://opendev.org/openstack/tripleo-quickstart/config/general_config/src/branch/master/featureset006.yml +.. _007: https://opendev.org/openstack/tripleo-quickstart/config/general_config/src/branch/master/featureset007.yml +.. _008: https://opendev.org/openstack/tripleo-quickstart/config/general_config/src/branch/master/featureset008.yml +.. _009: https://opendev.org/openstack/tripleo-quickstart/config/general_config/src/branch/master/featureset009.yml +.. _010: https://opendev.org/openstack/tripleo-quickstart/config/general_config/src/branch/master/featureset010.yml +.. _011: https://opendev.org/openstack/tripleo-quickstart/config/general_config/src/branch/master/featureset011.yml +.. _012: https://opendev.org/openstack/tripleo-quickstart/config/general_config/src/branch/master/featureset012.yml +.. _013: https://opendev.org/openstack/tripleo-quickstart/config/general_config/src/branch/master/featureset013.yml +.. _014: https://opendev.org/openstack/tripleo-quickstart/config/general_config/src/branch/master/featureset014.yml +.. _015: https://opendev.org/openstack/tripleo-quickstart/config/general_config/src/branch/master/featureset015.yml +.. _016: https://opendev.org/openstack/tripleo-quickstart/config/general_config/src/branch/master/featureset016.yml +.. _017: https://opendev.org/openstack/tripleo-quickstart/config/general_config/src/branch/master/featureset017.yml +.. _018: https://opendev.org/openstack/tripleo-quickstart/config/general_config/src/branch/master/featureset018.yml +.. _019: https://opendev.org/openstack/tripleo-quickstart/config/general_config/src/branch/master/featureset019.yml +.. _020: https://opendev.org/openstack/tripleo-quickstart/config/general_config/src/branch/master/featureset020.yml +.. _021: https://opendev.org/openstack/tripleo-quickstart/config/general_config/src/branch/master/featureset021.yml +.. _022: https://opendev.org/openstack/tripleo-quickstart/config/general_config/src/branch/master/featureset022.yml +.. _023: https://opendev.org/openstack/tripleo-quickstart/config/general_config/src/branch/master/featureset023.yml +.. _024: https://opendev.org/openstack/tripleo-quickstart/config/general_config/src/branch/master/featureset024.yml +.. _025: https://opendev.org/openstack/tripleo-quickstart/config/general_config/src/branch/master/featureset025.yml +.. _026: https://opendev.org/openstack/tripleo-quickstart/config/general_config/src/branch/master/featureset026.yml +.. _027: https://opendev.org/openstack/tripleo-quickstart/config/general_config/src/branch/master/featureset027.yml +.. _028: https://opendev.org/openstack/tripleo-quickstart/config/general_config/src/branch/master/featureset028.yml +.. _030: https://opendev.org/openstack/tripleo-quickstart/config/general_config/src/branch/master/featureset030.yml +.. _031: https://opendev.org/openstack/tripleo-quickstart/config/general_config/src/branch/master/featureset031.yml +.. _032: https://opendev.org/openstack/tripleo-quickstart/config/general_config/src/branch/master/featureset032.yml +.. _033: https://opendev.org/openstack/tripleo-quickstart/config/general_config/src/branch/master/featureset033.yml +.. _035: https://opendev.org/openstack/tripleo-quickstart/config/general_config/src/branch/master/featureset035.yml +.. _036: https://opendev.org/openstack/tripleo-quickstart/config/general_config/src/branch/master/featureset036.yml +.. _037: https://opendev.org/openstack/tripleo-quickstart/config/general_config/src/branch/master/featureset037.yml +.. _038: https://opendev.org/openstack/tripleo-quickstart/config/general_config/src/branch/master/featureset038.yml +.. _039: https://opendev.org/openstack/tripleo-quickstart/config/general_config/src/branch/master/featureset039.yml +.. _040: https://opendev.org/openstack/tripleo-quickstart/config/general_config/src/branch/master/featureset040.yml +.. _041: https://opendev.org/openstack/tripleo-quickstart/config/general_config/src/branch/master/featureset041.yml +.. _042: https://opendev.org/openstack/tripleo-quickstart/config/general_config/src/branch/master/featureset042.yml +.. _045: https://opendev.org/openstack/tripleo-quickstart/config/general_config/src/branch/master/featureset045.yml +.. _047: https://opendev.org/openstack/tripleo-quickstart/config/general_config/src/branch/master/featureset047.yml +.. _048: https://opendev.org/openstack/tripleo-quickstart/config/general_config/src/branch/master/featureset048.yml +.. _049: https://opendev.org/openstack/tripleo-quickstart/config/general_config/src/branch/master/featureset049.yml +.. _050: https://opendev.org/openstack/tripleo-quickstart/config/general_config/src/branch/master/featureset050.yml +.. _051: https://opendev.org/openstack/tripleo-quickstart/config/general_config/src/branch/master/featureset051.yml +.. _052: https://opendev.org/openstack/tripleo-quickstart/config/general_config/src/branch/master/featureset052.yml +.. _053: https://opendev.org/openstack/tripleo-quickstart/config/general_config/src/branch/master/featureset053.yml +.. _054: https://opendev.org/openstack/tripleo-quickstart/config/general_config/src/branch/master/featureset054.yml +.. _055: https://opendev.org/openstack/tripleo-quickstart/config/general_config/src/branch/master/featureset055.yml +.. _056: https://opendev.org/openstack/tripleo-quickstart/config/general_config/src/branch/master/featureset056.yml +.. _058: https://opendev.org/openstack/tripleo-quickstart/config/general_config/src/branch/master/featureset058.yml +.. _060: https://opendev.org/openstack/tripleo-quickstart/config/general_config/src/branch/master/featureset060.yml +.. _061: https://opendev.org/openstack/tripleo-quickstart/config/general_config/src/branch/master/featureset061.yml +.. _099: https://opendev.org/openstack/tripleo-quickstart/config/general_config/src/branch/master/featureset099.yml diff --git a/doc/source/feature-configuration.rst b/doc/source/feature-configuration.rst index 604f00ae3..ebe8afe31 100644 --- a/doc/source/feature-configuration.rst +++ b/doc/source/feature-configuration.rst @@ -18,210 +18,9 @@ Below is a table with various features listed in each row and the features enabl in each feature set configuration file in each column. When adding new configurations please consult the following `etherpad `_ -+------+--------+------+---------+---------+---------+-------+-------+---------+---------+---------+---------+---------+----------+---------+---------+-----------+-------+-------------+------+---------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+--------+------+----+----+-------+----------+---------------+ -| FS | cnf-dl | ipv6 | SSL UC | SSL Int | SSL Ext | NI SN | NI MN | NI BOND | introsp | UC idem | cont UC | cont OC | OC upg | UC upg | OC upd | FF OC upg | SA | validations | ping | tempest | sc000 | sc001 | sc002 | sc003 | sc004 | sc005 | sc006 | sc007 | sc008 | sc010 |nonha | ceph | PM | HC | IPSec | Browbeat | HA validation | -+======+========+======+=========+=========+=========+=======+=======+=========+=========+=========+=========+=========+==========+=========+=========+===========+=======+=============+======+=========+=======+=======+=======+=======+=======+=======+=======+=======+=======+=======+========+======+====+====+=======+==========+===============+ -| 001_ | X | | | X | X | | X | | X | | | | | | | | | | | X | | | | | | | | | | | | | | | | | | -+------+--------+------+---------+---------+---------+-------+-------+---------+---------+---------+---------+---------+----------+---------+---------+-----------+-------+-------------+------+---------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+--------+------+----+----+-------+----------+---------------+ -| 002_ | X | | | X | X | | X | | X | | | | | | | | | | X | | | | | | | | | | | | | | | | | | | -+------+--------+------+---------+---------+---------+-------+-------+---------+---------+---------+---------+---------+----------+---------+---------+-----------+-------+-------------+------+---------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+--------+------+----+----+-------+----------+---------------+ -| 003_ | | | | | | | | | | X | | | | | | | | | | | | | | | | | | | | | | | | | | | | -+------+--------+------+---------+---------+---------+-------+-------+---------+---------+---------+---------+---------+----------+---------+---------+-----------+-------+-------------+------+---------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+--------+------+----+----+-------+----------+---------------+ -| 004_ | | | | | | | | | | | | | | | | | | X | | | | | | | | | | | | | X | | | | | | | -+------+--------+------+---------+---------+---------+-------+-------+---------+---------+---------+---------+---------+----------+---------+---------+-----------+-------+-------------+------+---------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+--------+------+----+----+-------+----------+---------------+ -| 005_ | | | | | | | | | | | | | | | | | | X | X | | | X | | | | | | | | | | | X | | | | | -+------+--------+------+---------+---------+---------+-------+-------+---------+---------+---------+---------+---------+----------+---------+---------+-----------+-------+-------------+------+---------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+--------+------+----+----+-------+----------+---------------+ -| 006_ | | | | | | | | | | | | | | | | | | X | | X | | | X | | | | | | | | | | X | | | | | -+------+--------+------+---------+---------+---------+-------+-------+---------+---------+---------+---------+---------+----------+---------+---------+-----------+-------+-------------+------+---------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+--------+------+----+----+-------+----------+---------------+ -| 007_ | | | | | | | | | | | | | | | | | | X | | X | | | | X | | | | | | | | | X | | | | | -+------+--------+------+---------+---------+---------+-------+-------+---------+---------+---------+---------+---------+----------+---------+---------+-----------+-------+-------------+------+---------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+--------+------+----+----+-------+----------+---------------+ -| 008_ | | | | | | | | | | | | | | | | | | X | | X | | | | | X | | | | | | | | X | | | | | -+------+--------+------+---------+---------+---------+-------+-------+---------+---------+---------+---------+---------+----------+---------+---------+-----------+-------+-------------+------+---------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+--------+------+----+----+-------+----------+---------------+ -| 009_ | | | | | | | | | | | | | | | | | | | X | | | | | | | X | | | | | | | X | | | | | -+------+--------+------+---------+---------+---------+-------+-------+---------+---------+---------+---------+---------+----------+---------+---------+-----------+-------+-------------+------+---------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+--------+------+----+----+-------+----------+---------------+ -| 010_ | X | | | | | | | | | | | X | | | | | | | | X | | | | | | | | | | | X | | | | | | | -+------+--------+------+---------+---------+---------+-------+-------+---------+---------+---------+---------+---------+----------+---------+---------+-----------+-------+-------------+------+---------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+--------+------+----+----+-------+----------+---------------+ -| 011_ | | | | | | | | | | | | | X | | | | | | X | | | | | | | | | | | | X | | | | | | | -+------+--------+------+---------+---------+---------+-------+-------+---------+---------+---------+---------+---------+----------+---------+---------+-----------+-------+-------------+------+---------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+--------+------+----+----+-------+----------+---------------+ -| 012_ | | | | | | | | | | | | | X | | | | | | X | | | X | | | | | | | | | X | | X | | | | | -+------+--------+------+---------+---------+---------+-------+-------+---------+---------+---------+---------+---------+----------+---------+---------+-----------+-------+-------------+------+---------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+--------+------+----+----+-------+----------+---------------+ -| 013_ | | | | | | | | | | | | | X | | | | | | X | | | | X | | | | | | | | X | | X | | | | | -+------+--------+------+---------+---------+---------+-------+-------+---------+---------+---------+---------+---------+----------+---------+---------+-----------+-------+-------------+------+---------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+--------+------+----+----+-------+----------+---------------+ -| 014_ | | | | | | | | | | | | | X | | | | | | X | | | | | X | | | | | | | X | | X | | | | | -+------+--------+------+---------+---------+---------+-------+-------+---------+---------+---------+---------+---------+----------+---------+---------+-----------+-------+-------------+------+---------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+--------+------+----+----+-------+----------+---------------+ -| 015_ | | | | | | | | | | | | | X | | | | | | X | | | | | | X | | | | | | X | | X | | | | | -+------+--------+------+---------+---------+---------+-------+-------+---------+---------+---------+---------+---------+----------+---------+---------+-----------+-------+-------------+------+---------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+--------+------+----+----+-------+----------+---------------+ -| 016_ | | | | | | | | | | | | X | | | | | | | | X | | X | | | | | | | | | X | | X | | | | | -+------+--------+------+---------+---------+---------+-------+-------+---------+---------+---------+---------+---------+----------+---------+---------+-----------+-------+-------------+------+---------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+--------+------+----+----+-------+----------+---------------+ -| 017_ | X | | | | | | | | | | | X | | | | | | | | X | | | X | | | | | | | | X | | X | | | | | -+------+--------+------+---------+---------+---------+-------+-------+---------+---------+---------+---------+---------+----------+---------+---------+-----------+-------+-------------+------+---------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+--------+------+----+----+-------+----------+---------------+ -| 018_ | X | | | | | | | | | | | X | | | | | | | | X | | | | X | | | | | | | X | | X | | | | | -+------+--------+------+---------+---------+---------+-------+-------+---------+---------+---------+---------+---------+----------+---------+---------+-----------+-------+-------------+------+---------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+--------+------+----+----+-------+----------+---------------+ -| 019_ | | | | | | | | | | | | X | | | | | | | | X | | | | | X | | | | | | X | | X | | | | | -+------+--------+------+---------+---------+---------+-------+-------+---------+---------+---------+---------+---------+----------+---------+---------+-----------+-------+-------------+------+---------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+--------+------+----+----+-------+----------+---------------+ -| 020_ | X | | | | | | | | | | | | | | | | | | | X | | | | | | | | | | | X | | | | | | | -+------+--------+------+---------+---------+---------+-------+-------+---------+---------+---------+---------+---------+----------+---------+---------+-----------+-------+-------------+------+---------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+--------+------+----+----+-------+----------+---------------+ -| 021_ | | | | X | X | | X | | X | | | | | | | | | | | X | | | | | | | | | | | | | | | | | | -+------+--------+------+---------+---------+---------+-------+-------+---------+---------+---------+---------+---------+----------+---------+---------+-----------+-------+-------------+------+---------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+--------+------+----+----+-------+----------+---------------+ -| 022_ | | | | X | | | | | X | | | X | | | | | | | X | | | | | | | | | | | | X | | | | | | | -+------+--------+------+---------+---------+---------+-------+-------+---------+---------+---------+---------+---------+----------+---------+---------+-----------+-------+-------------+------+---------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+--------+------+----+----+-------+----------+---------------+ -| 024_ | | X | | X | | | X | | X | | | | | | | | | | X | | | | | | | | | | | | | X | | | | | | -+------+--------+------+---------+---------+---------+-------+-------+---------+---------+---------+---------+---------+----------+---------+---------+-----------+-------+-------------+------+---------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+--------+------+----+----+-------+----------+---------------+ -| 025_ | | | | X | X | | X | | X | | | | | | | | | | X | | | | | | | | | | | | | | | X | | | | -+------+--------+------+---------+---------+---------+-------+-------+---------+---------+---------+---------+---------+----------+---------+---------+-----------+-------+-------------+------+---------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+--------+------+----+----+-------+----------+---------------+ -| 026_ | | | | | | | | | | | | X | | | | | | | | | | | | | | | X | | | | | | | | | | | -+------+--------+------+---------+---------+---------+-------+-------+---------+---------+---------+---------+---------+----------+---------+---------+-----------+-------+-------------+------+---------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+--------+------+----+----+-------+----------+---------------+ -| 027_ | | | X | | | | | | | | X | | | | | | | | | X | | | | | | | | | | | | | | | | | | -+------+--------+------+---------+---------+---------+-------+-------+---------+---------+---------+---------+---------+----------+---------+---------+-----------+-------+-------------+------+---------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+--------+------+----+----+-------+----------+---------------+ -| 028_ | | | | | | | | | | | | | | | | | | | X | X | | | | | | | | X | | | | | | | | | | -+------+--------+------+---------+---------+---------+-------+-------+---------+---------+---------+---------+---------+----------+---------+---------+-----------+-------+-------------+------+---------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+--------+------+----+----+-------+----------+---------------+ -| 030_ | X | | | | | | | | | | | X | | | | | | | X | X | | | | | | | | X | | | | | X | | | | | -+------+--------+------+---------+---------+---------+-------+-------+---------+---------+---------+---------+---------+----------+---------+---------+-----------+-------+-------------+------+---------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+--------+------+----+----+-------+----------+---------------+ -| 031_ | | | | | | | | | | | | | | | | | | | X | | | | | | | | | | X | | | | | | | | | -+------+--------+------+---------+---------+---------+-------+-------+---------+---------+---------+---------+---------+----------+---------+---------+-----------+-------+-------------+------+---------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+--------+------+----+----+-------+----------+---------------+ -| 032_ | | | | | | | | | | | | X | | | | | | | | | | | | | | | | | | | | | X | | | | | -+------+--------+------+---------+---------+---------+-------+-------+---------+---------+---------+---------+---------+----------+---------+---------+-----------+-------+-------------+------+---------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+--------+------+----+----+-------+----------+---------------+ -| 033_ | | | | | | | | | | | | X | | | | | | | | | | | | | | | X | | | | | | | | | | | -+------+--------+------+---------+---------+---------+-------+-------+---------+---------+---------+---------+---------+----------+---------+---------+-----------+-------+-------------+------+---------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+--------+------+----+----+-------+----------+---------------+ -| 035_ | X | X | | X | X | | X | | X | | | | | | | | | | | X | | | | | | | | | | | | | | | | | | -+------+--------+------+---------+---------+---------+-------+-------+---------+---------+---------+---------+---------+----------+---------+---------+-----------+-------+-------------+------+---------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+--------+------+----+----+-------+----------+---------------+ -| 036_ | | | | X | | | | | | | | | | | | X | | | | | | X | | | | | | | | | | | | | X | | | -+------+--------+------+---------+---------+---------+-------+-------+---------+---------+---------+---------+---------+----------+---------+---------+-----------+-------+-------------+------+---------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+--------+------+----+----+-------+----------+---------------+ -| 037_ | | | | X | | | | | | | | | | | X | | | | | | X | X | | | | | | | | | | | | | X | | | -+------+--------+------+---------+---------+---------+-------+-------+---------+---------+---------+---------+---------+----------+---------+---------+-----------+-------+-------------+------+---------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+--------+------+----+----+-------+----------+---------------+ -| 038_ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | X | | | | | | | | -+------+--------+------+---------+---------+---------+-------+-------+---------+---------+---------+---------+---------+----------+---------+---------+-----------+-------+-------------+------+---------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+--------+------+----+----+-------+----------+---------------+ -| 039_ | | | | X | X | | X | | | | | | | | | | | | X | | | | | | | | | | | | | | X | | | | | -+------+--------+------+---------+---------+---------+-------+-------+---------+---------+---------+---------+---------+----------+---------+---------+-----------+-------+-------------+------+---------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+--------+------+----+----+-------+----------+---------------+ -| 041_ | X | | | X | X | | X | | X | | | | | | | | | | | X | | | | | | | | | | | | | | | | | X | -+------+--------+------+---------+---------+---------+-------+-------+---------+---------+---------+---------+---------+----------+---------+---------+-----------+-------+-------------+------+---------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+--------+------+----+----+-------+----------+---------------+ -| 042_ | X | | | X | X | | X | | X | | | | | | | | | | | X | | | | | | | | | | | | | | | X | | | -+------+--------+------+---------+---------+---------+-------+-------+---------+---------+---------+---------+---------+----------+---------+---------+-----------+-------+-------------+------+---------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+--------+------+----+----+-------+----------+---------------+ -| 047_ | | | | | | | | | | | | | | X | | | | | | | | | | | | | | | | | | | | | | | | -+------+--------+------+---------+---------+---------+-------+-------+---------+---------+---------+---------+---------+----------+---------+---------+-----------+-------+-------------+------+---------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+--------+------+----+----+-------+----------+---------------+ -| 048_ | | | | X | | | | | X | | | X | | | | | | | X | | | | | | | | | | | | X | | | | | | | -+------+--------+------+---------+---------+---------+-------+-------+---------+---------+---------+---------+---------+----------+---------+---------+-----------+-------+-------------+------+---------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+--------+------+----+----+-------+----------+---------------+ -| 049_ | | | | | | X | | | | | | X | | | | | | | | | | | | | | | | | | | | X | X | | | | | -+------+--------+------+---------+---------+---------+-------+-------+---------+---------+---------+---------+---------+----------+---------+---------+-----------+-------+-------------+------+---------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+--------+------+----+----+-------+----------+---------------+ -| 050_ | | | | | | | | | | | X | | | X | | | | | | | | | | | | | | | | | | | | | | | | -+------+--------+------+---------+---------+---------+-------+-------+---------+---------+---------+---------+---------+----------+---------+---------+-----------+-------+-------------+------+---------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+--------+------+----+----+-------+----------+---------------+ -| 051_ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | -+------+--------+------+---------+---------+---------+-------+-------+---------+---------+---------+---------+---------+----------+---------+---------+-----------+-------+-------------+------+---------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+--------+------+----+----+-------+----------+---------------+ -| 052_ | | | | | | | | | | | | | | | | | X | | | | X | | | | | | | | | | | | | | | | | -+------+--------+------+---------+---------+---------+-------+-------+---------+---------+---------+---------+---------+----------+---------+---------+-----------+-------+-------------+------+---------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+--------+------+----+----+-------+----------+---------------+ -| 053_ | X | | | X | X | | X | | X | | | | | | | | | | | X | | | | | | | | | | | | | | | | X | | -+------+--------+------+---------+---------+---------+-------+-------+---------+---------+---------+---------+---------+----------+---------+---------+-----------+-------+-------------+------+---------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+--------+------+----+----+-------+----------+---------------+ -| 055_ | X | | | | | | | | | | | X | | | | | | | | X | | | | | | | | | | | X | | | | | | | -+------+--------+------+---------+---------+---------+-------+-------+---------+---------+---------+---------+---------+----------+---------+---------+-----------+-------+-------------+------+---------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+--------+------+----+----+-------+----------+---------------+ -| 058_ | | | | X | | | | | | | | | | | X | | X | | | | X | | | | | | | | | | | | | | X | | | -+------+--------+------+---------+---------+---------+-------+-------+---------+---------+---------+---------+---------+----------+---------+---------+-----------+-------+-------------+------+---------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+--------+------+----+----+-------+----------+---------------+ - -Definition of Terms: - -+--------------+-------------------------------------------------------------------+ -| Acroynm | Definition | -+==============+===================================================================+ -| FS | Featureset | -+--------------+-------------------------------------------------------------------+ -| UC | TripleO Undercloud | -+--------------+-------------------------------------------------------------------+ -| OC | TripleO Overcloud | -+--------------+-------------------------------------------------------------------+ -| NI SN | network isolation single network interface card | -+--------------+-------------------------------------------------------------------+ -| NI MN | network isolation multiple network interface card | -+--------------+-------------------------------------------------------------------+ -| NI BOND | network isolation bonded network interfaces | -+--------------+-------------------------------------------------------------------+ -| ping | deploy test heat stack, ping and ssh tests launched test instance | -+--------------+-------------------------------------------------------------------+ -| idem | idempotency test | -+--------------+-------------------------------------------------------------------+ -| cont | containerized | -+--------------+-------------------------------------------------------------------+ -| cnf-dl | config-download is enabled | -+--------------+-------------------------------------------------------------------+ -| upg | major upgrade | -+--------------+-------------------------------------------------------------------+ -| upd | minor upgrade | -+--------------+-------------------------------------------------------------------+ -| FF | Fast Forward | -+--------------+-------------------------------------------------------------------+ -| sc | scenario | -+--------------+-------------------------------------------------------------------+ -| ceph | ceph enabled | -+--------------+-------------------------------------------------------------------+ -| PM | pacemaker enabled, topology determines the number of controllers | -+--------------+-------------------------------------------------------------------+ -| HC | Heat Convergence is enabled | -+--------------+-------------------------------------------------------------------+ -| IPSec | IPSec tunnels for the overcloud are enabled | -+--------------+-------------------------------------------------------------------+ -| Int | Internal traffic (undercloud) | -+--------------+-------------------------------------------------------------------+ -| Ext | External traffic (overcloud) | -+--------------+-------------------------------------------------------------------+ -| Browbeat | Performance testing | -+--------------+-------------------------------------------------------------------+ +.. include:: feature-configuration-generated.rst Note and Known limitation: - Featureset037, Overcloud Update: - this doesn't change the container image file. - -.. _001: https://opendev.org/openstack/tripleo-quickstart/src/branch/master/config/general_config/featureset001.yml -.. _002: https://opendev.org/openstack/tripleo-quickstart/src/branch/master/config/general_config/featureset002.yml -.. _003: https://opendev.org/openstack/tripleo-quickstart/src/branch/master/config/general_config/featureset003.yml -.. _004: https://opendev.org/openstack/tripleo-quickstart/src/branch/master/config/general_config/featureset004.yml -.. _005: https://opendev.org/openstack/tripleo-quickstart/src/branch/master/config/general_config/featureset005.yml -.. _006: https://opendev.org/openstack/tripleo-quickstart/src/branch/master/config/general_config/featureset006.yml -.. _007: https://opendev.org/openstack/tripleo-quickstart/src/branch/master/config/general_config/featureset007.yml -.. _008: https://opendev.org/openstack/tripleo-quickstart/src/branch/master/config/general_config/featureset008.yml -.. _009: https://opendev.org/openstack/tripleo-quickstart/src/branch/master/config/general_config/featureset009.yml -.. _010: https://opendev.org/openstack/tripleo-quickstart/src/branch/master/config/general_config/featureset010.yml -.. _011: https://opendev.org/openstack/tripleo-quickstart/src/branch/master/config/general_config/featureset011.yml -.. _012: https://opendev.org/openstack/tripleo-quickstart/src/branch/master/config/general_config/featureset012.yml -.. _013: https://opendev.org/openstack/tripleo-quickstart/src/branch/master/config/general_config/featureset013.yml -.. _014: https://opendev.org/openstack/tripleo-quickstart/src/branch/master/config/general_config/featureset014.yml -.. _015: https://opendev.org/openstack/tripleo-quickstart/src/branch/master/config/general_config/featureset015.yml -.. _016: https://opendev.org/openstack/tripleo-quickstart/src/branch/master/config/general_config/featureset016.yml -.. _017: https://opendev.org/openstack/tripleo-quickstart/src/branch/master/config/general_config/featureset017.yml -.. _018: https://opendev.org/openstack/tripleo-quickstart/src/branch/master/config/general_config/featureset018.yml -.. _019: https://opendev.org/openstack/tripleo-quickstart/src/branch/master/config/general_config/featureset019.yml -.. _020: https://opendev.org/openstack/tripleo-quickstart/src/branch/master/config/general_config/featureset020.yml -.. _021: https://opendev.org/openstack/tripleo-quickstart/src/branch/master/config/general_config/featureset021.yml -.. _022: https://opendev.org/openstack/tripleo-quickstart/src/branch/master/config/general_config/featureset022.yml -.. _023: https://opendev.org/openstack/tripleo-quickstart/src/branch/master/config/general_config/featureset023.yml -.. _024: https://opendev.org/openstack/tripleo-quickstart/src/branch/master/config/general_config/featureset024.yml -.. _025: https://opendev.org/openstack/tripleo-quickstart/src/branch/master/config/general_config/featureset025.yml -.. _026: https://opendev.org/openstack/tripleo-quickstart/src/branch/master/config/general_config/featureset026.yml -.. _027: https://opendev.org/openstack/tripleo-quickstart/src/branch/master/config/general_config/featureset027.yml -.. _028: https://opendev.org/openstack/tripleo-quickstart/src/branch/master/config/general_config/featureset028.yml -.. _029: https://opendev.org/openstack/tripleo-quickstart/src/branch/master/config/general_config/featureset029.yml -.. _030: https://opendev.org/openstack/tripleo-quickstart/src/branch/master/config/general_config/featureset030.yml -.. _031: https://opendev.org/openstack/tripleo-quickstart/src/branch/master/config/general_config/featureset031.yml -.. _032: https://opendev.org/openstack/tripleo-quickstart/src/branch/master/config/general_config/featureset032.yml -.. _033: https://opendev.org/openstack/tripleo-quickstart/src/branch/master/config/general_config/featureset033.yml -.. _034: https://opendev.org/openstack/tripleo-quickstart/src/branch/master/config/general_config/featureset034.yml -.. _035: https://opendev.org/openstack/tripleo-quickstart/src/branch/master/config/general_config/featureset035.yml -.. _036: https://opendev.org/openstack/tripleo-quickstart/src/branch/master/config/general_config/featureset036.yml -.. _037: https://opendev.org/openstack/tripleo-quickstart/src/branch/master/config/general_config/featureset037.yml -.. _038: https://opendev.org/openstack/tripleo-quickstart/src/branch/master/config/general_config/featureset038.yml -.. _039: https://opendev.org/openstack/tripleo-quickstart/src/branch/master/config/general_config/featureset039.yml -.. _040: https://opendev.org/openstack/tripleo-quickstart/src/branch/master/config/general_config/featureset040.yml -.. _041: https://opendev.org/openstack/tripleo-quickstart/src/branch/master/config/general_config/featureset041.yml -.. _042: https://opendev.org/openstack/tripleo-quickstart/src/branch/master/config/general_config/featureset042.yml -.. _043: https://opendev.org/openstack/tripleo-quickstart/src/branch/master/config/general_config/featureset043.yml -.. _044: https://opendev.org/openstack/tripleo-quickstart/src/branch/master/config/general_config/featureset044.yml -.. _045: https://opendev.org/openstack/tripleo-quickstart/src/branch/master/config/general_config/featureset045.yml -.. _046: https://opendev.org/openstack/tripleo-quickstart/src/branch/master/config/general_config/featureset046.yml -.. _047: https://opendev.org/openstack/tripleo-quickstart/src/branch/master/config/general_config/featureset047.yml -.. _048: https://opendev.org/openstack/tripleo-quickstart/src/branch/master/config/general_config/featureset048.yml -.. _049: https://opendev.org/openstack/tripleo-quickstart/src/branch/master/config/general_config/featureset049.yml -.. _050: https://opendev.org/openstack/tripleo-quickstart/src/branch/master/config/general_config/featureset050.yml -.. _051: https://opendev.org/openstack/tripleo-quickstart/src/branch/master/config/general_config/featureset051.yml -.. _052: https://opendev.org/openstack/tripleo-quickstart/src/branch/master/config/general_config/featureset052.yml -.. _053: https://opendev.org/openstack/tripleo-quickstart/src/branch/master/config/general_config/featureset053.yml -.. _054: https://opendev.org/openstack/tripleo-quickstart/src/branch/master/config/general_config/featureset054.yml -.. _055: https://opendev.org/openstack/tripleo-quickstart/src/branch/master/config/general_config/featureset055.yml -.. _058: https://opendev.org/openstack/tripleo-quickstart/src/branch/master/config/general_config/featureset058.yml diff --git a/fs-matrix.py b/fs-matrix.py new file mode 100644 index 000000000..9c447706c --- /dev/null +++ b/fs-matrix.py @@ -0,0 +1,162 @@ +#!/bin/python3 +# +# Copyright Red Hat, Inc. All Rights Reserved. +# +# Licensed under the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. You may obtain +# a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. +# +# -*- coding: utf-8 -*- + +import os +from texttable import Texttable +import yaml + +# featureset mapping to match fs configuration files +# : [, , ] +features_map = { + 'overcloud_ipv6': ['true', 'IPv6', 'Overcloud IPv6'], + 'ssl_overcloud': ['true', 'SSLoc', 'Overcloud SSL'], + 'network_isolation': ['true', 'NIsol', 'Network Isolation'], + 'network_isolation_type': ['single-nic-vlans|multiple-nics|bond', + 'NItyp', 'Network Isolation Type'], + 'step_introspect': ['true', 'Intro', 'Introspection'], + 'undercloud_check_idempotency': ['true', 'Idemp', + 'Undercloud Idempotency Check'], + 'containerized_undercloud': ['true', 'ConUC', 'Containerized undecloud'], + 'containerized_overcloud': ['true', 'ConOC', 'Containerized overcloud'], + 'undercloud_upgrade': ['true', 'UPGuc', 'Undercloud Upgrade'], + 'containerized_overcloud_upgrade': ['true', 'UPGoc', + 'Overcloud Major Upgrade'], + 'overcloud_update': ['true', 'UPDoc', 'Overcloud Update (Minor Upgrade)'], + 'ffu_overcloud_upgrade': ['true', 'UPGff', + 'Fast-forward Overcloud Upgrade'], + 'standalone_role': ['Standalone.yaml', 'Stdln', 'Standalone Deploy'], + 'run_tripleo_validations': ['true', 'Valid', 'Validations'], + 'test_ping': ['true', 'PingT', 'Ping and ssh tests'], + 'run_tempest': ['true', 'Temps', 'run Tempest'], + 'composable_scenario': ['', 'Scen#', 'Scenario ###'], + 'extra_args': ['ceph', 'Cephd', 'Ceph deploy'], + 'undercloud_heat_convergence': ['true', 'HConv', + 'Undercloud Heat Convergence'], + 'enable_minimal_browbeat': ['true', 'BrowB', + 'Browbeat performance testing'], + 'validate_ha_overcloud': ['true', 'HAval', 'HA Validation'], +} + +symbol_map = { + 'single-nic-vlans': [u'─', 'Network isolation single network interface' + ' card'], + 'multiple-nics': [u'☰', 'Network isolation multiple network interface' + 'cards'], + 'release': [u'◍', 'Feature enabled in certain releases only'], + 'enabled': [u'◉', 'Feature enabled in all releases'], + 'disabled': [u'❍', 'Feature explicitly disabled in all releases'], + 'not-found': [u' ', 'Feature not found'], +} + + +def load_fs(): + t = Texttable() + # headers/columns + columns = ['Fset#'] + for k, h in sorted(features_map.items(), key=lambda kv: kv[1][1]): + columns.append(h[1]) + + matrix_length = len(columns) + t.set_cols_width([5] * matrix_length) + t.set_cols_align(['c'] * matrix_length) + t.set_cols_valign(['m'] * matrix_length) + t.set_cols_dtype(['t'] * matrix_length) + + root_path = os.path.dirname(os.path.realpath(__file__)) + fs_dir = os.path.join(root_path, 'config/general_config/') + + for fs_filename in sorted(os.listdir(fs_dir)): + fs_dict = {} + if fs_filename.startswith('featureset0') and \ + fs_filename.endswith('.yml'): + with open(os.path.join(fs_dir, fs_filename)) as fs_file: + fs_dict = yaml.load(fs_file, yaml.SafeLoader) + datarow = get_data_from_yaml(fs_dict, fs_filename) + t.add_rows([columns, datarow]) + fs_list.append(fs_filename[10:13]) + print(t.draw()) + print('\n') + + +def get_data_from_yaml(fs_dict, fs_filename): + """Get data from fs yaml file + + :param ds_dict: featureset dictonary read from yaml file + :param fs_filename: featureset yaml config file + :returns list -- list of features read from yaml file + """ + # Add XXX_ link to first column e.g. 001_ + datarow = [fs_filename[10:13] + '_'] + for k, v in sorted(features_map.items(), key=lambda kv: kv[1][1]): + if k in fs_dict: + # value = what the fs file has + value = str.lower(str(fs_dict[k])) + # enabled = what it should have to be active + enabled = str.lower(str(v[0])) + + # get digits only from scenarioXXX in composable_scenario setting + if k == 'composable_scenario': + datarow.append(''.join([n for n in value if n.isdigit()])) + # expects substr in extra_args e.g. 'ceph' + elif k == 'extra_args' and enabled in value: + datarow.append(symbol_map['enabled'][0]) + # fields that expects exact value e.g. 'true' + elif value == enabled: + datarow.append(symbol_map['enabled'][0]) + # expects a substr, transform it into a symbol + elif value in enabled and value in symbol_map: + datarow.append(symbol_map[value][0]) + # enabled in certain releases + elif value.startswith('{%') and 'release' in value: + datarow.append(symbol_map['release'][0]) + else: + # feature is present but disabled e.g. 'false' + datarow.append(symbol_map['disabled'][0]) + # feature not found in fs file + else: + datarow.append(symbol_map['not-found'][0]) + return datarow + + +def acronyms_and_symbols(): + at = Texttable() + columns = ['Acronym', 'Definition'] + for k, acr in sorted(features_map.items(), key=lambda kv: kv[1][1]): + at.add_rows([columns, [acr[1], acr[2]]]) + print(at.draw()) + print('\n') + + st = Texttable() + columns = ['Symbol', 'Description'] + for k, symdef in sorted(symbol_map.items(), key=lambda kv: kv[1][1]): + st.add_rows([columns, [symdef[0], symdef[1]]]) + print(st.draw()) + print('\n') + + baseurl = 'https://opendev.org/openstack/tripleo-quickstart' + path = 'config/general_config/src/branch/master' + for f in fs_list: + print(".. _{0}: {1}/{2}/featureset{0}.yml".format(f, baseurl, path)) + + +### + +if __name__ == '__main__': + fs_list = [] + load_fs() + acronyms_and_symbols() diff --git a/test-requirements.txt b/test-requirements.txt index cca8b7756..973e90a10 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -4,3 +4,5 @@ docutils>=0.11 sphinx>=1.6.2 # BSD reno>=1.8.0 # Apache-2.0 pre-commit # MIT +texttable +pyyaml diff --git a/tox.ini b/tox.ini index 29922a3cd..613dcb4e5 100644 --- a/tox.ini +++ b/tox.ini @@ -43,7 +43,9 @@ commands = bindep test [testenv:docs] basepython = python3 -commands = python setup.py build_sphinx +commands = + bash -c 'python fs-matrix.py > doc/source/feature-configuration-generated.rst' + python setup.py build_sphinx [testenv:bashate] envdir = {toxworkdir}/linters