Feature Configuration

One can configure the Openstack features installed on either the undercloud or overcloud by placing variable definitions in a YAML file and passing that to quickstart using the -c command line option, like this:

quickstart.sh -c config/general_config/featureset001.yml

Each feature set can also deploy a customized list of Openstack services. These services are defined by the tripleo-heat-templates used for the overcloud deployment. A definition of the services can be found here

Below is a table with various features listed in each row and the features enabled in each feature set configuration file in each column. When adding new configurations please consult the following etherpad

This matrix is automatically generated by fs-matrix.py script. Follow Updating Feature Configuration to update the featureset configuration matrix.

Fset#	BrowB	Cephd	ConOC	ConUC	HAval	HConv	IPv6	Idemp	Intro	NIsol	NItyp	PingT	SSLoc	Scen#	Stdln	Temps	UPDoc	UPGff	UPGff	UPGff	UPGoc	UPGuc
001		◍							◉	◉	☰	❍	◉
002		❍						❍	◉	◉	☰	❍	◉
003				❍				◉				❍	❍
005												◍		001
006												◍		002
007												◍		003
008												◍		004
009												◉		005
010		◍	◉	◍			❍			❍		❍	❍
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		❍	◉						◉	◉	☰	❍	◉
043		◍	◍	◍					◉	◉	─	◍	◉
045			◉				❍		❍			◉	❍	000
047			❍	❍				◉				❍	❍								❍	◉
048		❍	◍						◉	❍		❍	❍
049		◉	◉						❍	◉	─	❍	❍
050			◉	◉								❍	❍								❍	◉
051			◉	◍			❍		❍	❍		❍	❍	000							◉
052												❍			◉
053															◉
054			◉				❍			❍		❍	❍	012
055			◉				❍		❍	❍		◍	❍	002
056												❍			◉
058												❍			◉
060												❍			◉
061		❍	❍	◉			❍		❍	❍		❍
062												❍			◉
063		◍	◍	◍					◉	◉	☰		◉
064		❍	◉	◉					◉	◉	☰	❍	◉
065			◉	◉								❍	❍						◉		❍
066		◍	◉	◉			❍			❍		❍	❍
067												❍			◉					❍
068		◍	◉	◉			❍			❍		❍	❍	000			◉
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
UPGff	Fast-forward Undercloud Upgrade
UPGff	Fast-forward Standalone Upgrade
UPGoc	Overcloud Major Upgrade
UPGuc	Undercloud Upgrade

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

Notes and known limitations:

• Featureset011, Featureset004:

  • deprecated in favor of standalone jobs

  • will most likely fail if used with recent release

• Featureset037, Overcloud Update:

  • this doesn’t change the container image file.

Updating Feature Configuration

The feature configuration matrix is automatically generated by the script fs-matrix.py. The script reads all yml files from config/general_config/featureset*.yml and creates an rst formatted output. Whenever an existing featureset file is modified or a new one is created, the feature configuration matrix must be refreshed.

In order to update the featureset matrix, run:

tox -e docs

By running this, tox calls fs-matrix.py and redirects output to doc/source/feature-configuration-generated.rst, which in turn, is included by doc/source/feature-configuration.rst.

Warning

DO NOT MODIFY doc/source/feature-configuration-generated.rst manually.