STX-O Antelope | 'openstack stack' is not an openstack command

[Gabriel Calixto de Paula]

Brief Description
-----------------
The 'openstack stack <option>' commands are no longer usable in antelope.

Severity
--------
Major

Steps to Reproduce
------------------
run any 'openstack stack' commands

Expected Behavior
------------------
command should work normally

Actual Behavior
----------------
The commands are not found

Reproducibility
---------------
reproducible

System Configuration
--------------------
DX

Branch/Pull Time/Commit
-----------------------

Last Pass
---------
Last sanity Aug-29, ussuri STX-O

Timestamp/Logs
--------------
E Details: CLI '/var/opt/openstack/clients-wrapper.sh openstack --os-username 'tenant1' --os-password 'Li69nux*' --os-project-name tenant1 --os-auth-url http://keystone.openstack.svc.cluster.local/v3 --os-user-domain-name Default --os-project-domain-name Default --os-identity-api-version 3 --os-interface internal --os-region-name RegionOne stack list' failed to execute. Output: openstack: 'stack list' is not an openstack command. See 'openstack --help'.
E Did you mean one of these?
E block storage cleanup
E block storage cluster list
E block storage cluster set
E block storage cluster show
E block storage log level list
E block storage log level set
E block storage resource filter list
E block storage resource filter show
E block storage snapshot manageable list
E block storage volume manageable list
E local ip association create
E local ip association delete
E local ip association list
E local ip create
E local ip delete
E local ip list
E local ip set
E local ip show
E command terminated with exit code 2
Test Activity
-------------
Sanity

Workaround
----------
N/A

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: f/antelope
Review: https://review.opendev.org/c/starlingx/openstack-armada-app/+/898003

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.opendev.org/c/starlingx/openstack-armada-app/+/898003
Committed: https://opendev.org/starlingx/openstack-armada-app/commit/5bcbab406aacffeb89468d4f37624cb9cc403b10
Submitter: "Zuul (22348)"
Branch: f/antelope

commit 5bcbab406aacffeb89468d4f37624cb9cc403b10
Author: Luan Nunes Utimura <email address hidden>
Date: Wed Oct 11 15:56:51 2023 -0300

    stx-openstackclients: Move all clients to DIST

    In [1], two OpenStack clients were moved to the `DIST_PACKAGES` section
    of the `stx-openstackclients` container image build recipe due to the
    need to use packages patched exclusively for StarlingX:

      * python3-cinderclient;
      * python3-openstackclient.

    Although this change served its purpose, it had a side-effect that
    caused the main CLI, `openstack`, to stop recognizing other clients
    installed via `PIP_PACKAGES`.

    This occurred because once installed via `DIST_PACKAGES`, both
    `cinderclient` and `openstackclient` started to reside in the
    dist-packages/ directory, while all other clients continued to reside in
    site-packages/. As `openstackclient` is the one responsible for the main
    CLI, it stopped finding the other clients because its search directory
    changed to dist-packages/.

    Therefore, in this change, we chose to move all OpenStack clients to
    DIST_PACKAGES. This way, it is guaranteed that the main CLI will
    correctly identify the other OpenStack clients.

    [1] https://review.opendev.org/c/starlingx/openstack-armada-app/+/896129

    Test Plan:
    PASS - Build stx-debian base image
    PASS - Build stx-openstackclients container image
    PASS - Upload/apply stx-openstack
    PASS - Upload built image to the system's local registry and perform
           a helm-override to use it in the OpenStack clients container
    PASS - Run commands that had disappeared since the merge of [1], e.g.,
           the ones provided by `heatclient`:
           * openstack stack list
           * openstack stack create
           ...
    PASS - Remove/delete stx-openstack

    Closes-Bug: 2039096

    Co-authored-by: Lucas de Ataides <email address hidden>
    Co-authored-by: Romulo Leite <email address hidden>
    Change-Id: I61d653ceef07f99568a21b4ad6f6dceffed22ca1
    Signed-off-by: Luan Nunes Utimura <email address hidden>

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.opendev.org/c/starlingx/openstack-armada-app/+/898461

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.opendev.org/c/starlingx/openstack-armada-app/+/898461
Committed: https://opendev.org/starlingx/openstack-armada-app/commit/3793f3ca4be75aa103b06b85ecc59a29b83b9faa
Submitter: "Zuul (22348)"
Branch: master

commit 3793f3ca4be75aa103b06b85ecc59a29b83b9faa
Author: Luan Nunes Utimura <email address hidden>
Date: Wed Oct 11 15:56:51 2023 -0300

    stx-openstackclients: Move all clients to DIST

    In [1], two OpenStack clients were moved to the `DIST_PACKAGES` section
    of the `stx-openstackclients` container image build recipe due to the
    need to use packages patched exclusively for StarlingX:

      * python3-cinderclient;
      * python3-openstackclient.

    Although this change served its purpose, it had a side-effect that
    caused the main CLI, `openstack`, to stop recognizing other clients
    installed via `PIP_PACKAGES`.

    This occurred because once installed via `DIST_PACKAGES`, both
    `cinderclient` and `openstackclient` started to reside in the
    dist-packages/ directory, while all other clients continued to reside in
    site-packages/. As `openstackclient` is the one responsible for the main
    CLI, it stopped finding the other clients because its search directory
    changed to dist-packages/.

    Therefore, in this change, we chose to move all OpenStack clients to
    DIST_PACKAGES. This way, it is guaranteed that the main CLI will
    correctly identify the other OpenStack clients.

    [1] https://review.opendev.org/c/starlingx/openstack-armada-app/+/896129

    Test Plan:
    PASS - Build stx-debian base image
    PASS - Build stx-openstackclients container image
    PASS - Upload/apply stx-openstack
    PASS - Upload built image to the system's local registry and perform
           a helm-override to use it in the OpenStack clients container
    PASS - Run commands that had disappeared since the merge of [1], e.g.,
           the ones provided by `heatclient`:
           * openstack stack list
           * openstack stack create
           ...
    PASS - Remove/delete stx-openstack

    Closes-Bug: 2039096

    Co-authored-by: Lucas de Ataides <email address hidden>
    Co-authored-by: Romulo Leite <email address hidden>
    Change-Id: I61d653ceef07f99568a21b4ad6f6dceffed22ca1
    Signed-off-by: Luan Nunes Utimura <email address hidden>
    (cherry picked from commit 5bcbab406aacffeb89468d4f37624cb9cc403b10)