Browse Source

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
Harald Jensås 9 months ago
parent
commit
930e2ca49d
2 changed files with 8 additions and 36 deletions
  1. 4
    17
      instack_undercloud/undercloud.py
  2. 4
    19
      undercloud.conf.sample

+ 4
- 17
instack_undercloud/undercloud.py View File

@@ -180,23 +180,10 @@ _opts = [
180 180
                       'For each network a section/group needs to be added to '
181 181
                       'the configuration file with these parameters set: '
182 182
                       'cidr, dhcp_start, dhcp_end, inspection_iprange, '
183
-                      'gateway and masquerade.'
184
-                      '\n\n'
185
-                      'Example:\n\n'
186
-                      'subnets = subnet1,subnet2\n'
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')),
183
+                      'gateway and masquerade. Note: The section/group must '
184
+                      'be placed before or after any other section. (See '
185
+                      'the example section [ctlplane-subnet] in the sample '
186
+                      'configuration file.)')),
200 187
     cfg.StrOpt('local_subnet',
201 188
                default=SUBNETS_DEFAULT[0],
202 189
                help=('Name of the local subnet, where the PXE boot and DHCP '

+ 4
- 19
undercloud.conf.sample View File

@@ -43,24 +43,9 @@
43 43
 # Comma separated list of names/tags. For each network a section/group
44 44
 # needs to be added to the configuration file with these parameters
45 45
 # set: cidr, dhcp_start, dhcp_end, inspection_iprange, gateway and
46
-# masquerade.
47
-#
48
-# Example:
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)
46
+# masquerade. Note: The section/group must be placed before or after
47
+# any other section. (See the example section [ctlplane-subnet] in the
48
+# sample configuration file.) (list value)
64 49
 #subnets = ctlplane-subnet
65 50
 
66 51
 # Name of the local subnet, where the PXE boot and DHCP interfaces for
@@ -188,7 +173,7 @@
188 173
 #enable_container_images_build = true
189 174
 
190 175
 # Array of host/port combiniations of docker insecure registries.
191
-# (string value)
176
+# (list value)
192 177
 #docker_insecure_registries =
193 178
 
194 179
 # One Time Password to register Undercloud node with an IPA server.

Loading…
Cancel
Save