Improve container_images_file comments

Downstream we see that folks repeatedly forget to set this variable even
though they may generate a containers yaml file. This ultimately leads
to an undercloud installation failure due to lack of credentials. This
change updates the configuration item to be required=False for upstream
(because it's not) but includes additional comments around what this
file does. We can flip the configuration to required in environments
where we know we need authentication.

Change-Id: I8c26aa68ec2668fb9c94d0191914bd676e082ebe
(cherry picked from commit 24b87f1997)
This commit is contained in:
Alex Schultz 2020-03-31 15:36:56 -06:00 committed by Emilien Macchi
parent 9a5892eb3e
commit fdce01fce2
1 changed files with 11 additions and 4 deletions

View File

@ -174,11 +174,18 @@ class StandaloneConfig(BaseConfig):
),
cfg.StrOpt('container_images_file',
default='',
required=False,
help=_(
'Heat environment file with parameters for all '
'required container images. Or alternatively, '
'parameter "ContainerImagePrepare" to drive the '
'required image preparation.')),
'REQUIRED if authentication is needed to fetch '
'containers. This file should contain values for '
'"ContainerImagePrepare" and '
'"ContainerImageRegistryCredentials" that will be '
'used to fetch the containers for the undercloud '
'installation. `openstack tripleo container image '
'prepare default` can be used to provide a sample '
'"ContainerImagePrepare" value. Alternatively this '
'file can contain all the required Heat parameters '
'for the containers for advanced configurations.')),
cfg.ListOpt('custom_env_files',
default=[],
help=_('List of any custom environment yaml files to '