summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHarald Jensås <hjensas@redhat.com>2018-06-26 20:55:32 +0200
committerHarald Jensås <hjensas@redhat.com>2018-06-29 12:05:36 +0200
commit930e2ca49d9515fcf0cc91614be2e3595a6e898b (patch)
tree92b7a1462d5329a92a5cf502cb0a124b5c2b1c8d
parentaab11800fefc42ebae37109cf30076aa88c4d88b (diff)
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
Notes
Notes (review): Verified+1: RDO Third Party CI <dmsimard+rdothirdparty@redhat.com> Code-Review+2: Alex Schultz <aschultz@redhat.com> Code-Review+1: Bob Fournier <bfournie@redhat.com> Code-Review+2: James Slagle <jslagle@redhat.com> Workflow+1: James Slagle <jslagle@redhat.com> Verified+2: Zuul Submitted-by: Zuul Submitted-at: Tue, 03 Jul 2018 09:54:23 +0000 Reviewed-on: https://review.openstack.org/578173 Project: openstack/instack-undercloud Branch: refs/heads/master
-rw-r--r--instack_undercloud/undercloud.py21
-rw-r--r--undercloud.conf.sample23
2 files changed, 8 insertions, 36 deletions
diff --git a/instack_undercloud/undercloud.py b/instack_undercloud/undercloud.py
index 6e88df9..5e3e95f 100644
--- a/instack_undercloud/undercloud.py
+++ b/instack_undercloud/undercloud.py
@@ -180,23 +180,10 @@ _opts = [
180 'For each network a section/group needs to be added to ' 180 'For each network a section/group needs to be added to '
181 'the configuration file with these parameters set: ' 181 'the configuration file with these parameters set: '
182 'cidr, dhcp_start, dhcp_end, inspection_iprange, ' 182 'cidr, dhcp_start, dhcp_end, inspection_iprange, '
183 'gateway and masquerade.' 183 'gateway and masquerade. Note: The section/group must '
184 '\n\n' 184 'be placed before or after any other section. (See '
185 'Example:\n\n' 185 'the example section [ctlplane-subnet] in the sample '
186 'subnets = subnet1,subnet2\n' 186 'configuration file.)')),
187 '\n'
188 'An example section/group in config file:\n'
189 '\n'
190 '[subnet1]\n'
191 'cidr = 192.168.10.0/24\n'
192 'dhcp_start = 192.168.10.100\n'
193 'dhcp_end = 192.168.10.200\n'
194 'inspection_iprange = 192.168.10.20,192.168.10.90\n'
195 'gateway = 192.168.10.254\n'
196 'masquerade = True'
197 '\n'
198 '[subnet2]\n'
199 '. . .\n')),
200 cfg.StrOpt('local_subnet', 187 cfg.StrOpt('local_subnet',
201 default=SUBNETS_DEFAULT[0], 188 default=SUBNETS_DEFAULT[0],
202 help=('Name of the local subnet, where the PXE boot and DHCP ' 189 help=('Name of the local subnet, where the PXE boot and DHCP '
diff --git a/undercloud.conf.sample b/undercloud.conf.sample
index 6cba331..73bdd57 100644
--- a/undercloud.conf.sample
+++ b/undercloud.conf.sample
@@ -43,24 +43,9 @@
43# Comma separated list of names/tags. For each network a section/group 43# Comma separated list of names/tags. For each network a section/group
44# needs to be added to the configuration file with these parameters 44# needs to be added to the configuration file with these parameters
45# set: cidr, dhcp_start, dhcp_end, inspection_iprange, gateway and 45# set: cidr, dhcp_start, dhcp_end, inspection_iprange, gateway and
46# masquerade. 46# masquerade. Note: The section/group must be placed before or after
47# 47# any other section. (See the example section [ctlplane-subnet] in the
48# Example: 48# sample configuration file.) (list value)
49#
50# subnets = subnet1,subnet2
51#
52# An example section/group in config file:
53#
54# [subnet1]
55# cidr = 192.168.10.0/24
56# dhcp_start = 192.168.10.100
57# dhcp_end = 192.168.10.200
58# inspection_iprange = 192.168.10.20,192.168.10.90
59# gateway = 192.168.10.254
60# masquerade = True
61# [subnet2]
62# . . .
63# (list value)
64#subnets = ctlplane-subnet 49#subnets = ctlplane-subnet
65 50
66# Name of the local subnet, where the PXE boot and DHCP interfaces for 51# Name of the local subnet, where the PXE boot and DHCP interfaces for
@@ -188,7 +173,7 @@
188#enable_container_images_build = true 173#enable_container_images_build = true
189 174
190# Array of host/port combiniations of docker insecure registries. 175# Array of host/port combiniations of docker insecure registries.
191# (string value) 176# (list value)
192#docker_insecure_registries = 177#docker_insecure_registries =
193 178
194# One Time Password to register Undercloud node with an IPA server. 179# One Time Password to register Undercloud node with an IPA server.