undercloud.conf subnets option - help cause confusion

[Harald Jensås]

The example of subnet section is explained in line 54.
~~~
 42 # List of routed network subnets for provisioning and introspection.
 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
 45 # set: cidr, dhcp_start, dhcp_end, inspection_iprange, gateway and
 46 # masquerade_network.
 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_network = True
 61 # [subnet2]
 62 # . . .
 63 # (list value)
 64 #subnets = ctlplane-subnet
~~~

The 'ctlplane-subnet' section defined at the end of the file at line no. 358
~~~
358 [ctlplane-subnet]
359
360 #
361 # From instack-undercloud
362 #
363
364 # Network CIDR for the Neutron-managed subnet for Overcloud instances.
365 # (string value)
366 # Deprecated group/name - [DEFAULT]/network_cidr
367 #cidr = 192.168.24.0/24
~~~

The deployment fails if we modify the value in example section.

I.e users place the section defining provisioning subnets right in the middle of the DEFAULT section.

[OpenStack Infra (hudson-openstack)]

Related fix proposed to branch: master
Review: https://review.openstack.org/578172

[OpenStack Infra (hudson-openstack)]

Related fix proposed to branch: master
Review: https://review.openstack.org/578173

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/578173
Committed: https://git.openstack.org/cgit/openstack/instack-undercloud/commit/?id=930e2ca49d9515fcf0cc91614be2e3595a6e898b
Submitter: Zuul
Branch: master

commit 930e2ca49d9515fcf0cc91614be2e3595a6e898b
Author: Harald Jensås <email address hidden>
Date: Tue Jun 26 20:55:32 2018 +0200

    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

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/578172
Committed: https://git.openstack.org/cgit/openstack/python-tripleoclient/commit/?id=c4701f8b68447af3be8bb75a393cf753349b476c
Submitter: Zuul
Branch: master

commit c4701f8b68447af3be8bb75a393cf753349b476c
Author: Harald Jensås <email address hidden>
Date: Tue Jun 26 20:49:22 2018 +0200

    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: Ia34f6da6006b1fc9b8075865ec4a666e86a32095

[OpenStack Infra (hudson-openstack)]

Related fix proposed to branch: stable/queens
Review: https://review.openstack.org/581390

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/581390
Committed: https://git.openstack.org/cgit/openstack/instack-undercloud/commit/?id=6cd5d841a7dbd8e7da7660d0a0305d74f51d91aa
Submitter: Zuul
Branch: stable/queens

commit 6cd5d841a7dbd8e7da7660d0a0305d74f51d91aa
Author: Harald Jensås <email address hidden>
Date: Tue Jun 26 20:55:32 2018 +0200

    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
    (cherry picked from commit 930e2ca49d9515fcf0cc91614be2e3595a6e898b)