Bug 1585497 - Move routed networks example text to be closer to [ctlplane-subnet] in /usr/share/instack-undercloud/undercloud.conf.sample
Summary: Move routed networks example text to be closer to [ctlplane-subnet] in /usr/s...
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Red Hat OpenStack
Classification: Red Hat
Component: instack-undercloud
Version: 13.0 (Queens)
Hardware: Unspecified
OS: Unspecified
medium
high
Target Milestone: Upstream M3
: 14.0 (Rocky)
Assignee: Harald Jensås
QA Contact: mlammon
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2018-06-03 17:56 UTC by KOSAL RAJ I
Modified: 2022-08-09 10:34 UTC (History)
6 users (show)

Fixed In Version: instack-undercloud-9.3.1-0.20180831000258.e464799.el7ost python-tripleoclient-10.5.1-0.20180906012840.5b00837.el7ost
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2019-01-11 11:49:59 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
OpenStack gerrit 578172 0 None MERGED Drop example in config file comments 2020-11-03 16:49:33 UTC
OpenStack gerrit 578173 0 None MERGED Drop example in config file comments 2020-11-03 16:49:32 UTC
Red Hat Issue Tracker OSP-9119 0 None None None 2022-08-09 10:34:48 UTC
Red Hat Product Errata RHEA-2019:0045 0 None None None 2019-01-11 11:50:16 UTC

Description KOSAL RAJ I 2018-06-03 17:56:03 UTC
Description of problem:
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.

Version-Release number of selected component (if applicable):
RHOSP 13

How reproducible:


Steps to Reproduce:
1.
2.
3.

Actual results:


Expected results:
The example section to be brought under the [ctlplane-subnet] section to avoid confusion while using the sample file

Additional info:

Comment 3 Bob Fournier 2018-06-05 13:49:15 UTC
The way I understand it, this is a request to change undercloud.conf.sample to move the description on routed networks closer to the [ctlplane-subnet] section.  This change was added here - https://review.openstack.org/#/c/533365/10/undercloud.conf.sample, so the request would be to move lines 41-69 down to just above line 253.

Because of where the description is now the customer inadvertently added the [ctlplane-subnet] near the routed networks description which caused the local-interface setting to be included in [ctlplane-subnet] not [DEFAULT].

This is a reasonable request to avoid confusion and we'll make the change for OSP-13z release. It is too late to get this into OSP-13 GA.

Thanks for the feedback.

Comment 4 Bob Fournier 2018-06-05 18:19:25 UTC
Also, changing the priority/severity of this bug. Its hard to justify it being high severity since its really just moving around comments in an example file.

Comment 10 Alexander Chuzhoy 2018-09-20 20:12:55 UTC
FailedQA

Environment:
instack-undercloud-9.3.1-0.20180831000258.e464799.el7ost.noarch
python-tripleoclient-10.5.1-0.20180901082351.6d7aa74.el7ost.noarch

ctlplane-subnet comes last in bot sample files.

[root@undercloud-0 ~]# tail -n 35 /usr/share/instack-undercloud/undercloud.conf.sample
[ctlplane-subnet]

#
# From instack-undercloud
#

# Network CIDR for the Neutron-managed subnet for Overcloud instances.
# (string value)
# Deprecated group/name - [DEFAULT]/network_cidr
#cidr = 192.168.24.0/24

# Start of DHCP allocation range for PXE and DHCP of Overcloud
# instances on this network. (string value)
# Deprecated group/name - [DEFAULT]/dhcp_start
#dhcp_start = 192.168.24.5

# End of DHCP allocation range for PXE and DHCP of Overcloud instances
# on this network. (string value)
# Deprecated group/name - [DEFAULT]/dhcp_end
#dhcp_end = 192.168.24.24

# Temporary IP range that will be given to nodes on this network
# during the inspection process. Should not overlap with the range
# defined by dhcp_start and dhcp_end, but should be in the same ip
# subnet. (string value)
# Deprecated group/name - [DEFAULT]/inspection_iprange
#inspection_iprange = 192.168.24.100,192.168.24.120

# Network gateway for the Neutron-managed network for Overcloud
# instances on this network. (string value)
# Deprecated group/name - [DEFAULT]/network_gateway
#gateway = 192.168.24.1

# The network will be masqueraded for external access. (boolean value)
#masquerade = false




[root@undercloud-0 ~]# tail -n 35 /usr/share/python-tripleoclient/undercloud.conf.sample
[ctlplane-subnet]

#
# From undercloud_config
#

# Network CIDR for the Neutron-managed subnet for Overcloud instances.
# (string value)
# Deprecated group/name - [DEFAULT]/network_cidr
#cidr = 192.168.24.0/24

# End of DHCP allocation range for PXE and DHCP of Overcloud instances
# on this network. (string value)
# Deprecated group/name - [DEFAULT]/dhcp_end
#dhcp_end = 192.168.24.24

# Start of DHCP allocation range for PXE and DHCP of Overcloud
# instances on this network. (string value)
# Deprecated group/name - [DEFAULT]/dhcp_start
#dhcp_start = 192.168.24.5

# Network gateway for the Neutron-managed network for Overcloud
# instances on this network. (string value)
# Deprecated group/name - [DEFAULT]/network_gateway
#gateway = 192.168.24.1

# Temporary IP range that will be given to nodes on this network
# during the inspection process. Should not overlap with the range
# defined by dhcp_start and dhcp_end, but should be in the same ip
# subnet. (string value)
# Deprecated group/name - [DEFAULT]/inspection_iprange
#inspection_iprange = 192.168.24.100,192.168.24.120

# The network will be masqueraded for external access. (boolean value)
#masquerade = false

Comment 11 Alexander Chuzhoy 2018-09-20 20:18:03 UTC
Verified:
Environment:
Environment:
instack-undercloud-9.3.1-0.20180831000258.e464799.el7ost.noarch
python-tripleoclient-10.5.1-0.20180901082351.6d7aa74.el7ost.noarch


In both /usr/share/instack-undercloud/undercloud.conf.sample and /usr/share/python-tripleoclient/undercloud.conf.sample the following note was added:

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

Comment 13 errata-xmlrpc 2019-01-11 11:49:59 UTC
Since the problem described in this bug report should be
resolved in a recent advisory, it has been closed with a
resolution of ERRATA.

For information on the advisory, and where to find the updated
files, follow the link below.

If the solution does not work for you, open a new bug report.

https://access.redhat.com/errata/RHEA-2019:0045


Note You need to log in before you can comment on or make changes to this bug.