unused parameter list during the deployment should exclude known acceptable params

Bug #1842754 reported by Alex Schultz
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
tripleo
Fix Released
Medium
Alex Schultz

Bug Description

Because we generate all the image container urls even if they aren't used, we end up with a giant list in the unused param warning. This is excessively verbose and misleading. Example:

WARNING: Following parameter(s) are defined but not used in plan. Could be possible that parameter is valid but currently not used.
  DockerAodhApiImage
  DockerAodhConfigImage
  DockerAodhEvaluatorImage
  DockerAodhListenerImage
  DockerAodhNotifierImage
  DockerBarbicanApiImage
  DockerBarbicanConfigImage
  DockerBarbicanKeystoneListenerConfigImage
  DockerBarbicanKeystoneListenerImage
  DockerBarbicanWorkerConfigImage
  DockerBarbicanWorkerImage
  DockerCeilometerCentralImage
  DockerCeilometerComputeImage
  DockerCeilometerConfigImage
  DockerCeilometerNotificationImage
  DockerCephDaemonImage
  DockerCinderBackupImage
  DockerCollectdConfigImage
  DockerCollectdImage
  DockerEc2ApiConfigImage
  DockerEc2ApiImage
  DockerEtcdConfigImage
  DockerEtcdImage
  DockerFluentdClientImage
  DockerFluentdConfigImage
  DockerFluentdImage
  DockerGnocchiApiImage
  DockerGnocchiConfigImage
  DockerGnocchiMetricdImage
  DockerGnocchiStatsdImage
  DockerIronicApiConfigImage
  DockerIronicApiImage
  DockerIronicConductorImage
  DockerIronicConfigImage
  DockerIronicInspectorConfigImage
  DockerIronicInspectorImage
  DockerIronicNeutronAgentImage
  DockerIronicPxeImage
  DockerKeepalivedConfigImage
  DockerKeepalivedImage
  DockerManilaApiImage
  DockerManilaConfigImage
  DockerManilaSchedulerImage
  DockerManilaShareImage
  DockerMetricsQdrConfigImage
  DockerMetricsQdrImage
  DockerMistralApiImage
  DockerMistralConfigImage
  DockerMistralEngineImage
  DockerMistralEventEngineImage
  DockerMistralExecutorImage
  DockerMysqlClientConfigImage
  DockerNeutronDHCPImage
  DockerNeutronL3AgentImage
  DockerNeutronMetadataImage
  DockerNovaComputeIronicImage
  DockerOctaviaApiImage
  DockerOctaviaConfigImage
  DockerOctaviaHealthManagerImage
  DockerOctaviaHousekeepingImage
  DockerOctaviaWorkerImage
  DockerOpenvswitchImage
  DockerPankoApiImage
  DockerPankoConfigImage
  DockerQdrouterdConfigImage
  DockerQdrouterdImage
  DockerSaharaApiImage
  DockerSaharaConfigImage
  DockerSaharaEngineImage
  DockerSensuClientImage
  DockerSensuConfigImage
  DockerSkydiveAgentImage
  DockerSkydiveAnalyzerImage
  DockerZaqarConfigImage
  DockerZaqarImage
  GnocchiRbdPoolName
  MistralDockerGroup
  NetworkerParameters
  OVNTunnelEncapType
  PythonInterpreter
  SwiftFetchDirGetTempurl
  SwiftFetchDirPutTempurl
Deploying templates in the directory /tmp/tripleoclient-6b4b9gvi/tripleo-heat-templates

We should exclude variables that we generate or that we known are valid in some situations (Docker*Image*, SwiftFetch*Tempurl, etc)

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to python-tripleoclient (master)

Fix proposed to branch: master
Review: https://review.opendev.org/680453

Changed in tripleo:
assignee: nobody → Alex Schultz (alex-schultz)
status: Triaged → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to python-tripleoclient (master)

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

commit b25a9a953bfe6923cb855ca22e4f84e620241956
Author: Alex Schultz <email address hidden>
Date: Thu Sep 5 10:04:03 2019 -0600

    Add exclusions to the unused param warning

    This adds the ability for us to specifically exclude some patterns of
    parameters from the warning that is generated during the deployment for
    unused heat params. The params being added are generated by the
    deployment and not necessarily provided by the end user. The params
    currently being excluded are:

     * '^(Docker|Container).*Image$' - container image vars
     * '^SwiftFetchDir(Get|Put)Tempurl$' - temp url for ceph
     * '^PythonInterpreter$' - python executable for the deploy

    The warning message is also slightly adjusted to try and clarify that
    the vars might be valid but not used due to service or deployment
    configs.

    Change-Id: Iad7d97346993b5c95443092b81d056293cdad752
    Closes-Bug: #1842754

Changed in tripleo:
status: In Progress → Fix Released
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to python-tripleoclient (stable/stein)

Fix proposed to branch: stable/stein
Review: https://review.opendev.org/680771

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to python-tripleoclient (stable/rocky)

Fix proposed to branch: stable/rocky
Review: https://review.opendev.org/680772

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to python-tripleoclient (stable/queens)

Fix proposed to branch: stable/queens
Review: https://review.opendev.org/680773

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to python-tripleoclient (stable/stein)

Reviewed: https://review.opendev.org/680771
Committed: https://git.openstack.org/cgit/openstack/python-tripleoclient/commit/?id=a357740a0b7569a2ee355b50464889d84c7b8f3f
Submitter: Zuul
Branch: stable/stein

commit a357740a0b7569a2ee355b50464889d84c7b8f3f
Author: Alex Schultz <email address hidden>
Date: Thu Sep 5 10:04:03 2019 -0600

    Add exclusions to the unused param warning

    This adds the ability for us to specifically exclude some patterns of
    parameters from the warning that is generated during the deployment for
    unused heat params. The params being added are generated by the
    deployment and not necessarily provided by the end user. The params
    currently being excluded are:

     * '^(Docker|Container).*Image$' - container image vars
     * '^SwiftFetchDir(Get|Put)Tempurl$' - temp url for ceph
     * '^PythonInterpreter$' - python executable for the deploy

    The warning message is also slightly adjusted to try and clarify that
    the vars might be valid but not used due to service or deployment
    configs.

    Conflicts:
     tripleoclient/constants.py
     tripleoclient/workflows/parameters.py
    Change-Id: Iad7d97346993b5c95443092b81d056293cdad752
    Closes-Bug: #1842754
    (cherry picked from commit b25a9a953bfe6923cb855ca22e4f84e620241956)

tags: added: in-stable-stein
tags: added: in-stable-queens
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to python-tripleoclient (stable/queens)

Reviewed: https://review.opendev.org/680773
Committed: https://git.openstack.org/cgit/openstack/python-tripleoclient/commit/?id=10e861e08004ce5f56b6aba40eb3ae20d8ea8e68
Submitter: Zuul
Branch: stable/queens

commit 10e861e08004ce5f56b6aba40eb3ae20d8ea8e68
Author: Alex Schultz <email address hidden>
Date: Thu Sep 5 10:04:03 2019 -0600

    Add exclusions to the unused param warning

    This adds the ability for us to specifically exclude some patterns of
    parameters from the warning that is generated during the deployment for
    unused heat params. The params being added are generated by the
    deployment and not necessarily provided by the end user. The params
    currently being excluded are:

     * '^(Docker|Container).*Image$' - container image vars
     * '^SwiftFetchDir(Get|Put)Tempurl$' - temp url for ceph
     * '^PythonInterpreter$' - python executable for the deploy

    The warning message is also slightly adjusted to try and clarify that
    the vars might be valid but not used due to service or deployment
    configs.

    Conflicts:
     tripleoclient/constants.py
     tripleoclient/workflows/parameters.py

    Change-Id: Iad7d97346993b5c95443092b81d056293cdad752
    Closes-Bug: #1842754
    (cherry picked from commit b25a9a953bfe6923cb855ca22e4f84e620241956)

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/python-tripleoclient 11.5.1

This issue was fixed in the openstack/python-tripleoclient 11.5.1 release.

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to python-tripleoclient (stable/rocky)

Reviewed: https://review.opendev.org/680772
Committed: https://git.openstack.org/cgit/openstack/python-tripleoclient/commit/?id=4c2e6acb7c86fbd928cc517df80c329174983982
Submitter: Zuul
Branch: stable/rocky

commit 4c2e6acb7c86fbd928cc517df80c329174983982
Author: Alex Schultz <email address hidden>
Date: Thu Sep 5 10:04:03 2019 -0600

    Add exclusions to the unused param warning

    This adds the ability for us to specifically exclude some patterns of
    parameters from the warning that is generated during the deployment for
    unused heat params. The params being added are generated by the
    deployment and not necessarily provided by the end user. The params
    currently being excluded are:

     * '^(Docker|Container).*Image$' - container image vars
     * '^SwiftFetchDir(Get|Put)Tempurl$' - temp url for ceph
     * '^PythonInterpreter$' - python executable for the deploy

    The warning message is also slightly adjusted to try and clarify that
    the vars might be valid but not used due to service or deployment
    configs.

    Conflicts:
     tripleoclient/constants.py
     tripleoclient/workflows/parameters.py

    Change-Id: Iad7d97346993b5c95443092b81d056293cdad752
    Closes-Bug: #1842754
    (cherry picked from commit b25a9a953bfe6923cb855ca22e4f84e620241956)

tags: added: in-stable-rocky
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/python-tripleoclient 9.3.1

This issue was fixed in the openstack/python-tripleoclient 9.3.1 release.

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/python-tripleoclient 12.2.0

This issue was fixed in the openstack/python-tripleoclient 12.2.0 release.

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/python-tripleoclient rocky-eol

This issue was fixed in the openstack/python-tripleoclient rocky-eol release.

To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.