Improve help text for availability zones options

The previous commit moved the availability zones options to a
central location. This commit adds additional help text to those options.

Blueprint centralize-config-options-newton

Change-Id: I44c902e4e8b47ad14d19a2ba0bd289dc844fa66c
This commit is contained in:
Sujitha 2016-05-13 21:43:37 +00:00
parent 768e2ced48
commit 732fdf8b19
1 changed files with 40 additions and 2 deletions

View File

@ -19,10 +19,48 @@ from oslo_config import cfg
availability_zone_opts = [
cfg.StrOpt('internal_service_availability_zone',
default='internal',
help='The availability_zone to show internal services under'),
help="""
This option specifies the name of the availability zone for the
internal services. Services like nova-scheduler, nova-network,
nova-conductor are internal services. These services will appear in
their own internal availability_zone.
Possible values:
* Any string representing an availability zone name
* 'internal' is the default value
Services that use this:
* ``nova-api``
Related options:
* None
"""),
cfg.StrOpt('default_availability_zone',
default='nova',
help='Default compute node availability_zone'),
help="""
Default compute node availability_zone.
This option determines the availability zone to be used when it is not
specified in the VM creation request. If this option is not set,
the default availability zone 'nova' is used.
Possible values:
* Any string representing an availability zone name
* 'nova' is the default value
Services that use this:
* ``nova-api``
* ``nova-scheduler``
Related options:
* None
""")
]