From 930e2ca49d9515fcf0cc91614be2e3595a6e898b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Harald=20Jens=C3=A5s?= <hjensas@redhat.com>
Date: Tue, 26 Jun 2018 20:55:32 +0200
Subject: [PATCH] Drop example in config file comments

There have been some reports of users misinterpreting
where to place configuration for the provisining subnets
in undercloud.conf. The example text for the subnets leads
to users adding the subnets section directly after the
subnets option. I.e in the middle of the DEFAULT section
of the ini file.

This change drops the example. The ctlplane-subnet section
is there as an example already.

Related-Bug: rhbz1585497
Related-Bug: #1778779
Change-Id: I417623db410330058d30fe7435112f01a0f72c83
---
 instack_undercloud/undercloud.py | 21 ++++-----------------
 undercloud.conf.sample           | 23 ++++-------------------
 2 files changed, 8 insertions(+), 36 deletions(-)

diff --git a/instack_undercloud/undercloud.py b/instack_undercloud/undercloud.py
index 6e88df9e3..5e3e95f1f 100644
--- a/instack_undercloud/undercloud.py
+++ b/instack_undercloud/undercloud.py
@@ -180,23 +180,10 @@ _opts = [
                       'For each network a section/group needs to be added to '
                       'the configuration file with these parameters set: '
                       'cidr, dhcp_start, dhcp_end, inspection_iprange, '
-                      'gateway and masquerade.'
-                      '\n\n'
-                      'Example:\n\n'
-                      'subnets = subnet1,subnet2\n'
-                      '\n'
-                      'An example section/group in config file:\n'
-                      '\n'
-                      '[subnet1]\n'
-                      'cidr = 192.168.10.0/24\n'
-                      'dhcp_start = 192.168.10.100\n'
-                      'dhcp_end = 192.168.10.200\n'
-                      'inspection_iprange = 192.168.10.20,192.168.10.90\n'
-                      'gateway = 192.168.10.254\n'
-                      'masquerade = True'
-                      '\n'
-                      '[subnet2]\n'
-                      '. . .\n')),
+                      'gateway and masquerade. Note: The section/group must '
+                      'be placed before or after any other section. (See '
+                      'the example section [ctlplane-subnet] in the sample '
+                      'configuration file.)')),
     cfg.StrOpt('local_subnet',
                default=SUBNETS_DEFAULT[0],
                help=('Name of the local subnet, where the PXE boot and DHCP '
diff --git a/undercloud.conf.sample b/undercloud.conf.sample
index 6cba3310a..73bdd5794 100644
--- a/undercloud.conf.sample
+++ b/undercloud.conf.sample
@@ -43,24 +43,9 @@
 # Comma separated list of names/tags. For each network a section/group
 # needs to be added to the configuration file with these parameters
 # set: cidr, dhcp_start, dhcp_end, inspection_iprange, gateway and
-# masquerade.
-#
-# Example:
-#
-# subnets = subnet1,subnet2
-#
-# An example section/group in config file:
-#
-# [subnet1]
-# cidr = 192.168.10.0/24
-# dhcp_start = 192.168.10.100
-# dhcp_end = 192.168.10.200
-# inspection_iprange = 192.168.10.20,192.168.10.90
-# gateway = 192.168.10.254
-# masquerade = True
-# [subnet2]
-# . . .
-#  (list value)
+# masquerade. Note: The section/group must be placed before or after
+# any other section. (See the example section [ctlplane-subnet] in the
+# sample configuration file.) (list value)
 #subnets = ctlplane-subnet
 
 # Name of the local subnet, where the PXE boot and DHCP interfaces for
@@ -188,7 +173,7 @@
 #enable_container_images_build = true
 
 # Array of host/port combiniations of docker insecure registries.
-# (string value)
+# (list value)
 #docker_insecure_registries =
 
 # One Time Password to register Undercloud node with an IPA server.