Reviewed:  https://review.opendev.org/c/starlingx/distcloud-client/+/794794
Committed: https://opendev.org/starlingx/distcloud-client/commit/0d0781278fd07d93b65d0be666dd116f14fa5449
Submitter: "Zuul (22348)"
Branch:    f/centos8

commit 8d2b5478c68579c1a9121f71b2085dc397ce9b85
Author: albailey <email address hidden>
Date:   Wed May 19 15:47:55 2021 -0500

    Specify the nodeset for zuul jobs
    
    The py2.7 jobs need to specify xenial
    The py3.6 jobs need to specify bionic
    The focal zuul nodes only have python 3.8 installed in them
    
    The copyright date was updated in order to trigger
    the zuul jobs, as a no-delta type of change
    
    Note: pep8 and pylint jobs are not being specified for this repo
    because they specify a generic python3 interpreter, and are
    currently passing in python 3.6 and python 3.8.
    
    Partial-Bug: 1928978
    Signed-off-by: albailey <email address hidden>
    Change-Id: I4de3a640419ed431619cc4154ab928eebef71280

commit d52a9080082db5fda2e77fb9e342f812ea8c17e1
Author: Rafael Jordão Jardim <email address hidden>
Date:   Thu May 6 16:27:06 2021 -0400

    Specify the cacert file in the verify option when in secure mode
    
    When running in secure mode we want to set the "verify"
    option to the path to the cacert file
    
    Tests:
    1° I generate a certificate using the documentation and installed on the
    controller (activate https), I got the ca cert and I set up a remote
    cli pointing to a DC and I exported the certificate in a variable
    OS_CACERT to the client get it, I ran some commands from DC.
    2° I passed a flag insecure to execute the dcmanager client
    in a insecure mode
    3° Built an ISO to check if something broke and installed on DC using
    VDM to check if the dcmanager keeps the current behavior
    
    Note: I think is a good ideia to plan a standardization of the clients
    mainly the keystone (authentication) part
    
    This change is based on the documentation of the requests documentation
    https://docs.python-requests.org/en/master/user/advanced/#ssl-cert-verification
    
    Closes-bug: 1927723
    Signed-off-by: Rafael Jordão Jardim <email address hidden>
    Change-Id: I4221657b97592b319b3fbf54b5b8c6d325ec9aa3

commit 859864c21dadf0fc1888f5df94853a3c6d5472ac
Author: Rafael Jordão Jardim <email address hidden>
Date:   Wed Apr 7 13:05:53 2021 -0400

    Python 2 to Python 3 compatibility DC
    
    The code was adding two content-types, and when executing with
    python3 it got an error from the server, cause it was sending
    content-type application json but it was supposed to send
    a form data, so the fix was just add a verification to ensure that is
    not add 2 content-types if it already exists
    
    Development: When I was trying to find things to modify I followed the
    approach of build the client, get the tar file, I set up 2 environments
    one based on python2 and another python3, I installed the tar client
    in both environments and i exported the env vars that the client expect
    to get to request the controller, and doing that I could switch between
    the two python and indentifying what I should modify.
    
    Test: After all the modification I built an ISO and I installed that
    to run some commands and check if my changes got any side effects. After
    that followed the procedure to update the remote CLI docker image and
    insert the updated client there and I test this new image in the
    remote CLI.
    
    Story: 2007106
    Task: 42269
    
    Signed-off-by: Rafael Jardim <email address hidden>
    Change-Id: Ibe5c719bfecb09d5c2927d29df43ede59738a563

commit 91ce260bff4bd1b21050f613bd95c27bbf3dae58
Author: Yuxing Jiang <email address hidden>
Date:   Mon Feb 1 10:32:56 2021 -0500

    Add a -- migrate option in subcloud add CLI
    
    This commit adds a "--migrate" to the "dcmanager subcloud add" command
    for migrating a subcloud from another distributed cloud.
    
    Tests see: https://review.opendev.org/c/starlingx/distcloud/+/779567
    
    Depends-On: https://review.opendev.org/c/starlingx/distcloud/+/779567
    Story: 2008774
    Task: 42151
    Change-Id: I0c5c9f954e7dd902ce40e90657a2031919b5e813
    Signed-off-by: Yuxing Jiang <email address hidden>

commit 99e2f22e47100dc746ba4bb039f0eb15a330d6ce
Author: Tee Ngo <email address hidden>
Date:   Mon Feb 22 23:42:04 2021 -0500

    Add dcmanager subcloud restore command
    
    This commit introduces a new dcmanager command to
    restore a subcloud from backup data.
    Usage: dcmanager subcloud restore \
               --restore-values RESTORE_VALUES \
               --sysadmin-password SYSADMIN_PASSWORD \
               [--with-install] subcloud-name-or-id
    
    where:
       - RESTORE_VALUES is a yaml file contains custom config for a
         remote restore.
       - SYSADMIN_PASSWORD is another mandatory argument. The user
         will be prompted if it not specified.
       - --with-install is an optional parameter, meant for Redfish
         capable subcloud.
    
    Tests:
      - dcmanager help sucloud restore
      - incomplete command
      - missing restore values file
      - backup_filename not specified in restore values file
      - sysadmin password is not specified
      - subcloud not found
      - restore request without install
      - restore request for a managed subcloud
      - restore request before importing load --active
      - valid restore request
    
    Task: 41909
    Story: 2008573
    Depends-On: https://review.opendev.org/c/starlingx/distcloud/+/777052
    Change-Id: I537ba761604689dfe64dfc043172caa25d6b07fe
    Signed-off-by: Tee Ngo <email address hidden>

commit ddbca5645d7b30672ea44e4630f275ada5e02d9d
Author: Charles Short <email address hidden>
Date:   Wed Feb 24 08:58:46 2021 -0500

    Deprecate apiclient
    
    The apiclient, gettextutils, importutils, strutils, and uuidutils
    dates back to when openstack projects maintained common code and was later
    replaced with oslo_i18n and oslo_utils.
    
    Here we removed the apiclient code because there was no code using it,
    as a result the gettext, importutils, strutils, and uuidutils was
    removed as well since apiclient was the only place it was being used.
    
    Story: 2006796
    Task: 41901
    
    Signed-off-by: Charles Short <email address hidden>
    Change-Id: I2ce5f8035bb0df37189915308e1f576684d63389

commit 2d558d7882beb985cd7e24259764cd7cad1c3605
Author: Charles Short <email address hidden>
Date:   Mon Feb 22 11:21:13 2021 -0500

    Deprecate cliutils
    
    The cliutils code dates back to when openstack projects
    maintained common code and was later replaced by oslo_utils.
    
    Cliutils module was removed in this patch, and the function
    env() was moved to shell.py since that was the only reference
    to it.
    
    Additional patches will continue to trim from openstack/common.
    
    Story: 2006796
    Task: 41897
    
    Signed-off-by: Charles Short <email address hidden>
    Change-Id: I5ab9771db7356a6d45b9c9e06e49c6fd670b663e

commit 396eeaf963f684b68a5b070af151fd5adb288388
Author: albailey <email address hidden>
Date:   Wed Oct 28 10:19:25 2020 -0500

    Add distributed cloud kubernetes upgrade orchestration commands
    
    The kube-upgrade-strategy subcommands are similar to other
    orchestration subcommands.
    
    dcmanager kube-upgrade-strategy
      create delete apply abort show
    
    Include unit tests for create, delete, apply, abort and show
    for all DC orchestration strategy types.
    
    Improves coverage reporting through tox.
    
    Remove a pylint error code that did not need to be suppressed.
    
    Change-Id: I90978103e650a56d9616e21b8c4dc4ce01e522b9
    Story: 2008137
    Task: 40869
    Depends-On: https://review.opendev.org/c/starlingx/distcloud/+/758609
    Signed-off-by: albailey <email address hidden>

commit 584898efbe1a5212a65e404db34bec6dd3d73d8c
Author: Tao Liu <email address hidden>
Date:   Mon Jan 4 10:49:20 2021 -0500

    Add group option for Orchestration CLI command
    
    This update adds an optional parameter to allow creating an
    orchestration strategy for a single subcloud group.
    
    Story: 2007267
    Task: 41525
    Depends-On: https://review.opendev.org/c/starlingx/distcloud/+/769154
    Signed-off-by: Tao Liu <email address hidden>
    Change-Id: Ibe3f71902ee573626f66f270fc4be94b95c52939

commit bb96242adf3d5f95ed01ccc355d80fdb5591985e
Author: albailey <email address hidden>
Date:   Fri Dec 18 13:18:59 2020 -0600

    Fix zuul jobs broken due to pip upversion
    
    The bandit defined in base level test-requirements.txt
    needed to be restricted to python3.
    
    The version of hacking was conflicting.
    Updated pylint to be python3.
    The newer hacking pulls in some additional flake8 warnings
    which are being suppressed for now.
    
    The gettextutils has per line suppressions based
    on the new version of pylint, however that file should be
    removed in favor of a solution based on oslo.i18n.
    
    The multiple test-requirements.txt files should be
    revisited.
    
    Change-Id: I9de0ad5871865fc3baf79f89e3f9f6bedc523e05
    Partial-Bug: #1907678
    Signed-off-by: albailey <email address hidden>

commit 33d8e1f8d544b6fdf97ae9e1e1496e316d4da617
Author: Yuxing Jiang <email address hidden>
Date:   Mon Aug 17 17:15:00 2020 -0400

    Add an CLI command to reinstall a subcloud
    
    This commit adds a new CLI command to reinstall a subcloud with its
    previous install configurations. The reinstall process will reuse
    the previous install values and use the same software version as the
    system controller.
    
    CLI format:
    dcmanager subcloud reinstall <id/name>
    
    Users are required to type "reinstall" to start the reinstall, any
    other input will abort the reinstall operation. After the reinstall
    and bootstrap tasks complete a subcloud reconfigure command with
    deploy_config file is expected to deploy the subcloud and make it
    online.
    
    Tests see in https://review.opendev.org/#/c/746615/.
    
    Change-Id: Iecc439ae23cc0f018bcc3d1eebcbf1d0a8b29d45
    Story: 2007267
    Task: 40731
    Depends-On: https://review.opendev.org/#/c/746615/
    Signed-off-by: Yuxing Jiang <email address hidden>

commit f10e0455f020e621f8cdaac714f9c4f8c8b9dba7
Author: albailey <email address hidden>
Date:   Thu Aug 13 07:59:54 2020 -0500

    Enabled python3 unit tests in tox and zuul
    
    Replaces the unittest2 base module with testtools.
    Adds py36 unit test target in tox.ini, called from zuul.
    Updates unit tests to pass when run in both py27 and py36.
    
    Add sample CLI unit tests for fw update strategy based on
    a mixin for update strategy.
    
    Story: 2007875
    Task: 40674
    Change-Id: Ia1b94110a53d48249aed76c94b07f8ffc2946bb3
    Signed-off-by: albailey <email address hidden>

commit 7036f1fd11cd3bbae743aee89908e8195e4ded40
Author: Tee Ngo <email address hidden>
Date:   Thu Jul 30 19:02:20 2020 -0400

    Add --force option when managing a subcloud
    
    When managing a subcloud, allow a --force option to be
    specified. The force option will allow an offline subcloud
    to be managed.
    
    This is necessary in cases where the user has (mistakenly)
    unmanaged a subcloud that is offline and the subcloud
    cannot be recovered while it is unmanaged. One example is
    a failure during DC upgrade orchestration that leaves the
    subcloud offline. To rerun upgrade orchestration and
    recover the subcloud, the subcloud must be managed.
    
    Story: 2007403
    Task: 40467
    Change-Id: I0c0fa0f489208c322b463d0c3b889c26575d06f4
    Signed-off-by: Tee Ngo <email address hidden>

commit b51808f02fed04bdca36533785ec53f95d2d796a
Author: albailey <email address hidden>
Date:   Tue Apr 14 15:00:01 2020 -0500

    Enabling firmware update dcmanager orchestration commands
    
    The code had been previously submitted and disabled.
    This commit enables the commands under:
      dcmanager fw-update-strategy
    
    Depends-On: https://review.opendev.org/#/c/741306
    Change-Id: Iab780184f864b484aa38f8582adb2892f050e181
    Story: 2007875
    Task: 40422
    Signed-off-by: albailey <email address hidden>

commit 339f4490515759f2017b3149632e20e3a9019757
Author: Tee Ngo <email address hidden>
Date:   Fri Jul 17 16:47:07 2020 -0400

    Add --force option to upgrade-strategy create CLI
    
    The new option will allow the user to retry the upgrade
    of the specified offline subcloud(s) that previously failed
    during remote install or data migration step.
    
    Story: 2007403
    Task: 40386
    Depends-On: https://review.opendev.org/#/c/741715
    Change-Id: Id6008ad4501e4c73fc5946cee228f265ffc987bf
    Signed-off-by: Tee Ngo <email address hidden>

commit 990898fa273cb2461407d2813b99fbc2c7d95e74
Author: albailey <email address hidden>
Date:   Tue Jun 23 21:35:27 2020 -0500

    Only apply strategy actions to the update type of the CLI
    
    Previously a patch strategy could be deleted from the upgrade CLI.
    Now, only operations assoicated with that update type are permitted
    for each CLI.
    
    For example: an 'upgrade' strategy cannot be deleted or applied by
    the patch strategy CLI.
    
    Change-Id: I9a4436724937095fff1d47786f67e06ae3e1f13d
    Depends-On: https://review.opendev.org/#/c/739754
    Story: 2007403
    Task: 40349
    Signed-off-by: albailey <email address hidden>

commit e3736b5227ab7e264e5f6e6df277dc3f14997f35
Author: Tao Liu <email address hidden>
Date:   Thu Jun 25 13:32:57 2020 -0400

    Fix subcloud manage/unmanage commands
    
    The subcloud_update interface was changed to support
    files and data parameters. The manage/unmanage CLI
    that uses the subcloud update interface was not updated.
    As a result, the command failed. This update fixes this
    issue.
    
    Tests:
    Manage/unmanage subclouds few times.
    
    Closes-Bug: 1885141
    
    Change-Id: I729895d76bbc76eac87420215bff04836d7eb678
    Signed-off-by: Tao Liu <email address hidden>

commit dd05eccb0826ad4047201d361abea20b7a788bf5
Author: Tao Liu <email address hidden>
Date:   Tue Jun 23 17:06:27 2020 -0400

    Add CLI/API to populate data_install
    
    The dcmanager subcloud update CLI is extended to allow
    populating/updating the install values required for
    remote install (upgrade to stx 4.0).
    dcmanager subcloud update subcloud1 --install-values\
    install-values.yaml --bmc-password <password>
    
    Depends-On: https://review.opendev.org/#/c/737630/
    Story: 2007403
    Task: 40148
    
    Change-Id: Ifd7812a164cd110b4082974ac66ef9bd86c9c9dc
    Signed-off-by: Tao Liu <email address hidden>

commit 1c12fada9155c5cf609022e6577f93321d844304
Author: Jessica Castelino <email address hidden>
Date:   Thu May 21 14:49:29 2020 -0400

    CLI command to deploy a subcloud
    
    If deployment failed, the user has no option than to delete and
    re-add it. If the user was re-adding the subcloud without
    re-installing, it would further result in a bootstrap failure.
    Thus, to simplify things, a new CLI command is provided to allow
    re-deployment. Furthermore, if the user still chooses to delete
    the subcloud and re-add it without a re-install, a better error
    message is provided asking them to re-install the host.
    
    Change-Id: I1db9a172aa063e9e97141fc5e9284e8c477851bf
    Depends-On: https://review.opendev.org/#/c/732395/
    Partial-Bug: 1864756
    Signed-off-by: Jessica Castelino <email address hidden>

commit 7394a5fcaddfad376396e0ee680cf2abfd40abba
Author: Sharath Kumar K <email address hidden>
Date:   Tue May 5 06:48:36 2020 +0200

    Tox and Zuul job for the bandit code scan in stx/distrib-client
    
    Setting up the bandit tool for the scanning of HIGH severity issues
    in the python codes under Starlingx/distributedcloud-client folder.
    Expecting this merge will enable zuul job for CI/CD of bandit scan.
    
    Configuration files:
    1. tox.ini for adding bandit environment and command.
    2. test-requirements.txt for adding bandit version.
    3. .zuul.yaml file for adding bandit job and configuring under
       check job to run code scan every time before code commit.
    
    Test:
    Run tox -e bandit command inside the fault folder to validate the
    bandit scan and result.
    
    Please note:
    Changes will be implemented in batches and  this is Batch7 change.
    
    Story: 2007541
    Task: 39649
    Depends-On: https://review.opendev.org/#/c/721294/
    
    Change-Id: I8d1f0307c5b7ccf9ce6956b9808c5151987954a2
    Signed-off-by: Sharath Kumar K <email address hidden>

commit ff1203e53af9a3c7fd4e9ad8c96e130f81909f4e
Author: Andreas Jaeger <email address hidden>
Date:   Thu Jun 4 14:14:31 2020 +0200

    Switch to newer openstackdocstheme and reno versions
    
    Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using
    these versions will allow especially:
    * Linking from HTML to PDF document
    * Allow parallel building of documents
    * Fix some rendering problems
    
    Update Sphinx version as well.
    
    Disable openstackdocs_auto_name to use 'project' variable as name.
    
    Change pygments_style to 'native' since old theme version always used
    'native' and the theme now respects the setting and using 'sphinx' can
    lead to some strange rendering.
    
    openstackdocstheme renames some variables, so follow the renames
    before the next release removes them. A couple of variables are also
    not needed anymore, remove them.
    
    See also
    http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html
    
    Change-Id: I3b9bcb2bf8e09ddb3dcb8182f4d7ff21c8a07fde