Comment 1 for bug 2062372

Reviewed: https://review.opendev.org/c/starlingx/distcloud/+/916139
Committed: https://opendev.org/starlingx/distcloud/commit/d3b7434a5b6279ecdc924f625e19579033868321
Submitter: "Zuul (22348)"
Branch: master

commit d3b7434a5b6279ecdc924f625e19579033868321
Author: Gustavo Herzmann <email address hidden>
Date: Wed Apr 17 15:40:28 2024 -0300

    Fix peer-controller-gateway-address update

    This commit updates the peer group association sync status to
    'out-of-sync' after the user updates the
    peer-controller-gateway-address attribute of the system-peer object.

    This commit also modifies the subcloud update function to update the
    subcloud route whenever the systemcontroller_gateway_address is
    updated on the primary side and synced to the secondary.

    It also adds an informative message to remind the caller to run the
    sync command after updating the peer-controller-gateway-address.

    Test Plan:
    1. PASS: Do the following steps:
             - Create a system peer with an incorrect systemcontroller
             gateway address that's inside the management subcloud, but
             outside the reserved IP range and then create an association.
             Verify that the secondary subcloud and a route was created
             using the incorrect IP.
             - Update the system peer with the correct systemcontroller
             gateway address on the primary site. Verify that the PGA
             sync status is set to 'out-of-sync' on both sites.
             - Sync the PGA and verify that the secondary subcloud
             systemcontroller gateway address was updated and that the
             old route was deleted and a new one using the new address
             was created.
             - Migrate the SPG to the non-primary site and verify that
             it completes successfully and that the subcloud becomes
             online and managed.
    2. PASS: Repeat the first step of test case #1, but use an incorrect
             address that's outside the management subnet. Then create
             a PGA and verify that it fails due to the following
             validation:
             "systemcontroller_gateway_address invalid: Address must be in
             subnet <management subnet>"
    3. PASS: Repeat the first step of test case #1, but use an incorrect
             address that's inside the reserved IP range. Then create
             a PGA and verify that it fails due to the following
             validation:
             "systemcontroller_gateway_address invalid, is within
             management pool <ip range>"
    4. PASS: Create a system peer with a correct systemcontroller gateway
             address for the first time and then create an association.
             Verify that the secondary subcloud and a route was created
             using the correct IP.
    5. PASS: Update an attribute of the subcloud (e.g. the subcloud
             description) on the primary site and verify that the sync
             status chages to 'out-of-sync' on both sites, then run
             the PGA sync operation and verify that the attribute was
             synced to the secondary subcloud on the peer site.

    Closes-Bug: 2062372

    Change-Id: Ibffe6c86656a56a85d10deca54c161bbed7f0d17
    Signed-off-by: Gustavo Herzmann <email address hidden>