summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRajesh Tailor <ratailor@redhat.com>2022-11-11 16:03:53 +0530
committerRajesh Tailor <ratailor@redhat.com>2023-01-23 12:35:36 +0000
commitea789a62220633d1b5d985d8eb2ec7189bc92a02 (patch)
treeeafd4e1ccb058cef7636d2d027d19a67d85f3ef2
parentc9de185ea1ac1e8d4435c5863b2ad7cefdb28c76 (diff)
downloadnova-ea789a62220633d1b5d985d8eb2ec7189bc92a02.tar.gz
Correct config help message related options
The options list in 'Related Options:' section doesn't rendered as bulleted list for some params because of missing blank line. This changes adds missing blank line wherever needed in [1]. [1] https://docs.openstack.org/nova/latest/configuration/config.html Change-Id: I7077aea2abcf3cab67592879ebd1fde066bfcac5 (cherry picked from commit ac42c43e431b2bd1089910cd52aec8552a8e9755)
-rw-r--r--nova/conf/ironic.py1
-rw-r--r--nova/conf/libvirt.py1
-rw-r--r--nova/conf/mks.py2
-rw-r--r--nova/conf/vmware.py5
4 files changed, 9 insertions, 0 deletions
diff --git a/nova/conf/ironic.py b/nova/conf/ironic.py
index dc5d2412c4..2734f2b78a 100644
--- a/nova/conf/ironic.py
+++ b/nova/conf/ironic.py
@@ -27,6 +27,7 @@ ironic_group = cfg.OptGroup(
help="""
Configuration options for Ironic driver (Bare Metal).
If using the Ironic driver following options must be set:
+
* auth_type
* auth_url
* project_name
diff --git a/nova/conf/libvirt.py b/nova/conf/libvirt.py
index 4ea37b8fe9..16a3f63090 100644
--- a/nova/conf/libvirt.py
+++ b/nova/conf/libvirt.py
@@ -987,6 +987,7 @@ slowly to be useful. Actual errors will be reported by Glance and noticed
according to the poll interval.
Related options:
+
* images_type - must be set to ``rbd``
* images_rbd_glance_store_name - must be set to a store name
* images_rbd_glance_copy_poll_interval - controls the failure time-to-notice
diff --git a/nova/conf/mks.py b/nova/conf/mks.py
index 1703f5f240..ec403a1a4f 100644
--- a/nova/conf/mks.py
+++ b/nova/conf/mks.py
@@ -23,7 +23,9 @@ Nova compute node uses WebMKS, a desktop sharing protocol to provide
instance console access to VM's created by VMware hypervisors.
Related options:
+
Following options must be set to provide console access.
+
* mksproxy_base_url
* enabled
""")
diff --git a/nova/conf/vmware.py b/nova/conf/vmware.py
index 63a5f04ea4..17a2676b64 100644
--- a/nova/conf/vmware.py
+++ b/nova/conf/vmware.py
@@ -76,7 +76,9 @@ Possible values:
* Any valid URI (The scheme is 'telnet' or 'telnets'.)
Related options:
+
This option is ignored if serial_port_service_uri is not specified.
+
* serial_port_service_uri
"""),
cfg.StrOpt('serial_log_dir',
@@ -112,6 +114,7 @@ If true, the vCenter server certificate is not verified. If false,
then the default CA truststore is used for verification.
Related options:
+
* ca_file: This option is ignored if "ca_file" is set.
"""),
cfg.StrOpt('cluster_name',
@@ -158,7 +161,9 @@ Possible values:
* Any valid port number within 5900 -(5900 + vnc_port_total)
Related options:
+
Below options should be set to enable VNC client.
+
* vnc.enabled = True
* vnc_port_total
"""),