From c4701f8b68447af3be8bb75a393cf753349b476c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Harald=20Jens=C3=A5s?= Date: Tue, 26 Jun 2018 20:49:22 +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: Ia34f6da6006b1fc9b8075865ec4a666e86a32095 --- tripleoclient/config/undercloud.py | 26 ++++++-------------------- 1 file changed, 6 insertions(+), 20 deletions(-) diff --git a/tripleoclient/config/undercloud.py b/tripleoclient/config/undercloud.py index b584c53cb..878ec64d6 100644 --- a/tripleoclient/config/undercloud.py +++ b/tripleoclient/config/undercloud.py @@ -114,26 +114,12 @@ class UndercloudConfig(StandaloneConfig): '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_network.' - '\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')), + 'cidr, dhcp_start, dhcp_end, inspection_iprange, ' + 'gateway and masquerade_network. 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=_(