Config Reference: document common options¶

Problem description¶

In the configuration reference, configuration options such as database, AMQP, keystone middleware are poorly documented, or worse, documented differently in multiple places.

This might be confusing for the reader, and adds maintenance burden.

Proposed change¶

Common libraries define several configuration options, used by all the OpenStack projects. Instead of documenting these options for each project, we could have a specific chapter documenting the configuration options for common libraries, and refer to this chapter in the projects chapters.

At the moment these options are poorly documented, so this change would also be a chance to add missing information, or at least provide a better structure to do so in the future.

This spec only impacts the configuration reference.

Implementation¶

Dependencies¶

None

Testing¶

• Validate the existence of documented options using the tables generated with autohelp.

References¶

None