stx-openstack: Unable to access containerized clients on Standard systems

Bug #2032382 reported by Luan Nunes Utimura
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
StarlingX
Fix Released
Medium
Luan Nunes Utimura

Bug Description

Brief Description
-----------------
On Standard systems, it has been observed that users are unable to access the containerized clients after sourcing `/var/opt/openstack/admin-openrc`, due to `clients` pods not having the `controller-` suffix (which is mandatory).

Severity
--------
Major.

Steps to Reproduce
------------------
1) Upload/apply stx-openstack on a Standard system;
2) Source `/var/opt/openstack/admin-openrc`;
3) Attempt to run an OpenStack command, e.g., `openstack hypervisor list`.

Expected Behavior
------------------
Command is executed.

Actual Behavior
----------------
Command isn't executed because there is not `clients` pod with a `controller-` suffix.

Reproducibility
---------------
Reproducible.

System Configuration
--------------------
Standard system.

Branch/Pull Time/Commit
-----------------------
StarlingX (master)
StarlingX OpenStack (master)

Last Pass
---------
N/A.

Timestamp/Logs
--------------
```
[sysadmin@controller-0 ~(keystone_admin)]$ openstack hypervisor list
Could not find `clients` pod in controller-0.
Make sure the pod is running and try again.
```

Test Activity
-------------
Developer Testing.

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

tags: added: stx.9.0 stx.distro.openstack
Changed in starlingx:
assignee: nobody → Luan Nunes Utimura (lutimura)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to openstack-armada-app (master)
Changed in starlingx:
status: New → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to openstack-armada-app (master)

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

commit 44cc84b24b70c5acb78f8ea37bd1d7557eab0e18
Author: Luan Nunes Utimura <email address hidden>
Date: Mon Aug 21 13:26:53 2023 -0300

    clients: Fix host-specific config overrides

    It has been observed that, on Standard systems, users are unable to
    interact with containerized clients due to the fact that the `clients`
    pods are being initialized without the `controller-` suffix in their
    names. These names are relevant for the clients wrapper script to be
    able to find and execute commands inside the clients containers [1].

    The reason pods are being initialized with wrong names on Standard
    systems is because the host-specific overrides are being generated for
    hosts with `WORKER` personality instead of `CONTROLLER`, which makes no
    sense as the containerized clients were designed to *only* run on
    controller nodes.

    Therefore, the proposed fix is straightforward and only requires us to
    change the host personality required to generate host-specific
    overrides.

    [1] https://opendev.org/starlingx/openstack-armada-app/src/commit/4c238a8063c27815954c3aa151cdcae7dd5f67cb/stx-openstack-helm-fluxcd/stx-openstack-helm-fluxcd/helm-charts/clients/templates/bin/_clients-wrapper.sh.tpl#L52-L55

    Test Plan (on Standard):
    PASS - Build python3-k8sapp-openstack package
    PASS - Build stx-openstack-helm-fluxcd package
    PASS - Build stx-openstack helm charts
    PASS - Upload/apply stx-openstack
    PASS - Source `/var/opt/openstack/admin-openrc` and check that the
           containerized clients are responding to commands as expected
    PASS - Remove/delete stx-openstack

    Closes-Bug: 2032382

    Change-Id: I65b3fb64046567d18abb5335042a3df3b887d7c3
    Signed-off-by: Luan Nunes Utimura <email address hidden>

Changed in starlingx:
status: In Progress → Fix Released
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to openstack-armada-app (f/antelope)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to openstack-armada-app (f/antelope)

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

commit cb8c2329dd833eb8fb70f3ebc30e8a83f57c194f
Author: Luan Nunes Utimura <email address hidden>
Date: Mon Aug 21 13:26:53 2023 -0300

    clients: Fix host-specific config overrides

    It has been observed that, on Standard systems, users are unable to
    interact with containerized clients due to the fact that the `clients`
    pods are being initialized without the `controller-` suffix in their
    names. These names are relevant for the clients wrapper script to be
    able to find and execute commands inside the clients containers [1].

    The reason pods are being initialized with wrong names on Standard
    systems is because the host-specific overrides are being generated for
    hosts with `WORKER` personality instead of `CONTROLLER`, which makes no
    sense as the containerized clients were designed to *only* run on
    controller nodes.

    Therefore, the proposed fix is straightforward and only requires us to
    change the host personality required to generate host-specific
    overrides.

    [1] https://opendev.org/starlingx/openstack-armada-app/src/commit/4c238a8063c27815954c3aa151cdcae7dd5f67cb/stx-openstack-helm-fluxcd/stx-openstack-helm-fluxcd/helm-charts/clients/templates/bin/_clients-wrapper.sh.tpl#L52-L55

    Test Plan (on Standard):
    PASS - Build python3-k8sapp-openstack package
    PASS - Build stx-openstack-helm-fluxcd package
    PASS - Build stx-openstack helm charts
    PASS - Upload/apply stx-openstack
    PASS - Source `/var/opt/openstack/admin-openrc` and check that the
           containerized clients are responding to commands as expected
    PASS - Remove/delete stx-openstack

    Closes-Bug: 2032382

    Change-Id: I65b3fb64046567d18abb5335042a3df3b887d7c3
    Signed-off-by: Luan Nunes Utimura <email address hidden>
    (cherry picked from commit 44cc84b24b70c5acb78f8ea37bd1d7557eab0e18)

tags: added: in-f-antelope
Ghada Khalil (gkhalil)
Changed in starlingx:
importance: Undecided → Medium
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.