STX-Openstack | Can't create volume backup with `--location` flag via Openstack CLI

[Lucas de Ataides Barreto]

Brief Description
-----------------
When creating a volume backup via Openstack CLI, specifying the `–location` parameter, the backup creation fails with the error "Backup driver reported an error: Multidriver is set but a backup driver wasn't provided.".

This issue is specific to the Openstack CLI, as the same cannot be reproduced with the Cinder CLI.

Severity
--------
Major: System/Feature is usable but degraded

Steps to Reproduce
------------------
1. Create a volume
2. Boot a VM with this volume
3. Create a backup using the Openstack CLI, and specify the `–location` parameter

Expected Behavior
------------------
Backup is created

Actual Behavior
----------------
Backup fails with error: Backup driver reported an error: Multidriver is set but a backup driver wasn't provided.

Reproducibility
---------------
Reproducible

System Configuration
--------------------
Any

Branch/Pull Time/Commit
-----------------------
20231112T170059Z

Timestamp/Logs
--------------
[sysadmin@controller-0 ~(keystone_tenant2)]$ openstack volume backup create --force --location ceph b624af98-cdbd-40ba-a472-02baf6b8f8c4 --name backup-openstack-cli
+-------+--------------------------------------+
| Field | Value                                |
+-------+--------------------------------------+
| id    | 3062af7a-a485-4209-963a-24467593e15a |
| name  | backup-openstack-cli                 |
+-------+--------------------------------------+
[sysadmin@controller-0 ~(keystone_tenant2)]$ openstack volume backup list
+--------------------------------------+----------------------+-------------+-----------+------+
| ID                                   | Name                 | Description | Status    | Size |
+--------------------------------------+----------------------+-------------+-----------+------+
| 3062af7a-a485-4209-963a-24467593e15a | backup-openstack-cli | None        | error     |   10 |
+--------------------------------------+----------------------+-------------+-----------+------+
[sysadmin@controller-0 ~(keystone_tenant2)]$ openstack volume backup show backup-openstack-cli
+-----------------------+------------------------------------------------------------------------------------------+
| Field                 | Value                                                                                    |
+-----------------------+------------------------------------------------------------------------------------------+
| availability_zone     | None                                                                                     |
| container             | None                                                                                     |
| created_at            | 2023-11-13T13:07:16.000000                                                               |
| data_timestamp        | 2023-11-13T13:07:16.000000                                                               |
| description           | None                                                                                     |
| fail_reason           | Backup driver reported an error: Multidriver is set but a backup driver wasn't provided. |
| has_dependent_backups | False                                                                                    |
| id                    | 3062af7a-a485-4209-963a-24467593e15a                                                     |
| is_incremental        | False                                                                                    |
| location              | None                                                                                     |
| name                  | backup-openstack-cli                                                                     |
| object_count          | 0                                                                                        |
| size                  | 10                                                                                       |
| snapshot_id           | None                                                                                     |
| status                | error                                                                                    |
| updated_at            | 2023-11-13T13:07:16.000000                                                               |
| volume_id             | b624af98-cdbd-40ba-a472-02baf6b8f8c4                                                     |
+-----------------------+------------------------------------------------------------------------------------------+

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

Workaround
----------
Use Cinder CLI: cinder backup-create

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

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

commit a515f0dc546ac2c7344313a89f36089c6fd14e17
Author: Lucas de Ataides <email address hidden>
Date: Mon Nov 13 11:56:56 2023 -0300

    Fix volume backup creation with Openstack CLI

    Since we started using Openstack Antelope, it was noticed that, when
    creating backups using the Openstack CLI and specifying the `--location`
    parameter, the backups would always fail with the error message:
    "Backup driver reported an error: Multidriver is set but a backup
    driver wasn't provided." This error was caused because, even though
    patch 0002 introduced the `--location` parameter to the CLI, it was not
    passing it through to the Cinder API.

    This change fixes that by passing the location parameter on the backup
    creation, when using the Openstack CLI.

    Test Plan:
    PASS: Build stx-openstackclients image
    PASS: Upload / apply stx-openstack
    PASS: Manually upload built image to the system's registry and perform
          helm-override to use it in the clients containers
    PASS: Create a Cinder volume, and boot a VM from it
    PASS: Create a backup using the Openstack CLI, and passing the
          `--location` parameter
    PASS: Remove / delete stx-openstack

    Closes-Bug: 2043383

    Change-Id: Ie6f8756e3c647d2191489e298e3ea138f32c30d4
    Signed-off-by: Lucas de Ataides <email address hidden>