Options for the prepare command are confusing

Bug #1723157 reported by Martin André
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
tripleo
Fix Released
Low
Martin André

Bug Description

The `openstack overcloud container image prepare` command currently has the following options (among others):

  --images-file <file path>
                        File to write resulting image entries to, as well as
                        stdout. Any existing file will be overwritten.
  --service-environment-file <file path>, -e <file path>
                        Environment files specifying which services are
                        containerized. Entries will be filtered to only
                        contain images used by containerized services. (Can be
                        specified more than once.)
  --env-file <file path>
                        File to write heat environment file which specifies
                        all image parameters. Any existing file will be
                        overwritten.

The '--images-file' and '--env-file' options are confusing now that we've added the '--service-environment-file' option. They should be renamed in a way that it's clear they control the path of the output file.

Additionally, the '--service-environment-file' long option is different from the equivalent '--environment-file' option for the `openstack overcloud deploy` command. This is problematic as we advise users to use the same arguments to the prepare command as the ones they are going to pass to the deploy command.

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

Fix proposed to branch: master
Review: https://review.openstack.org/511514

Changed in tripleo:
assignee: nobody → Martin André (mandre)
status: Triaged → In Progress
Changed in tripleo:
milestone: queens-1 → queens-2
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to python-tripleoclient (master)

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

commit d2cc4c548978b94ef7a78cd6479d191c38ee1736
Author: Martin André <email address hidden>
Date: Thu Oct 12 16:42:04 2017 +0100

    Rename options to the prepare command for clarity

    Changed the following options:
    * '--images-file' to '--output-images-file'
    * '--env-file' to '--output-env-file'
    * '--service-environment-file' to '--environment-file' in order to
      match the equivalent option of the deploy command.

    The old options are still in place and show a Deprecation warning in
    the help message.

    Change-Id: I24a6021d19ffe74760f9897e9bf3453742939bc9
    Closes-Bug: #1723157

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

Fix proposed to branch: stable/pike
Review: https://review.openstack.org/518041

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

Reviewed: https://review.openstack.org/518041
Committed: https://git.openstack.org/cgit/openstack/python-tripleoclient/commit/?id=8682b681ba65c7ee08822f98f5425882f820dca2
Submitter: Zuul
Branch: stable/pike

commit 8682b681ba65c7ee08822f98f5425882f820dca2
Author: Martin André <email address hidden>
Date: Thu Oct 12 16:42:04 2017 +0100

    Rename options to the prepare command for clarity

    Changed the following options:
    * '--images-file' to '--output-images-file'
    * '--env-file' to '--output-env-file'
    * '--service-environment-file' to '--environment-file' in order to
      match the equivalent option of the deploy command.

    The old options are still in place and show a Deprecation warning in
    the help message.

    Change-Id: I24a6021d19ffe74760f9897e9bf3453742939bc9
    Closes-Bug: #1723157
    (cherry picked from commit d2cc4c548978b94ef7a78cd6479d191c38ee1736)

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

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

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

This issue was fixed in the openstack/python-tripleoclient 8.1.0 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.