docs/doc/source/dist_cloud/kubernetes/managing-subclouds-using-the-cli.rst
Elisamara Aoki Goncalves 003d5d4439 Improved Subcloud Deployment / Upgrading Error Reporting (GUI & CLI)
Add new items with example to sections.
Add new example figure.
Fix numbering.
Resize figures to fit the page.
Update log files name.
Add item 4 in include file.
RS> Conditionalize 'dcmanager subcloud list' states for
    various run scenarios
RS> Move step from .. only:: block to .. include::
RS> Pre-process included blocks in non-block context
RS> Remove debug message from script
EG> Added example
EG> Fixed caution box

Story: 2010271
Task: 46946

Signed-off-by: Elisamara Aoki Goncalves <elisamaraaoki.goncalves@windriver.com>
Change-Id: I3791a23fefba8d9d428ae208b3bfcb9274d49278
2022-12-15 13:31:33 -03:00

8.0 KiB
Raw Blame History

Manage Subclouds Using the CLI

You can use the to list subclouds, reconfigure subclouds if deployment fails, delete subclouds, and monitor or change the managed status of subclouds.

  • To list subclouds, use the subcloud list command.

    For example:

    ~(keystone_admin)]$ dcmanager subcloud list
    +----+-----------+--------------+--------------------+-------------+
    | id | name      | management   | availability       | sync        |
    +----+-----------+--------------+--------------------+-------------+
    |  1 | subcloud1 | managed      | online             | in-sync     |
    |  2 | subcloud2 | managed      | online             | in-sync     |
    |  3 | subcloud3 | managed      | online             | out-of-sync |
    |  4 | subcloud4 | managed      | offline            | unknown     |
    +----+-----------+--------------+--------------------+-------------+
  • To show information for a subcloud, use the subcloud show command.

    ~(keystone_admin)]$ dcmanager subcloud show <subcloud-name>

    For example:

    ~(keystone_admin)]$ dcmanager subcloud show subcloud2
    +-----------------------------+----------------------------+
    | Field                       | Value                      |
    +-----------------------------+----------------------------+
    | id                          | 2                          |
    | name                        | subcloud2                  |
    | description                 | subcloud2 description      |
    | location                    | subcloud 2 location        |
    | software_version            | nn.nn                      |
    | management                  | managed                    |
    | availability                | online                     |
    | deploy_status               | complete                   |
    | management_subnet           | 192.168.101.0/24           |
    | management_start_ip         | 192.168.101.2              |
    | management_end_ip           | 192.168.101.50             |
    | management_gateway_ip       | 192.168.101.1              |
    | systemcontroller_gateway_ip | 192.168.204.101            |
    | created_at                  | 2020-03-05 21:43:46.525251 |
    | updated_at                  | 2020-03-06 19:53:39.560771 |
    | identity_sync_status        | in-sync                    |
    | patching_sync_status        | in-sync                    |
    | platform_sync_status        | in-sync                    |
    +-----------------------------+----------------------------+
  • To show information about the oam-floating-ip field for a specific subcloud, use the subcloud show <subcloud-name> --detail command.

    For example,

    ~(keystone_admin)]$ dcmanager subcloud show subcloud2 --detail
    +-----------------------------+----------------------------+
    | Field                       | Value                      |
    +-----------------------------+----------------------------+
    | id                          | 2                          |
    | name                        | subcloud2                  |
    | description                 | subcloud2 description      |
    | location                    | subcloud 2 location        |
    | software_version            | nn.nn                      |
    | management                  | managed                    |
    | availability                | online                     |
    | deploy_status               | complete                   |
    | management_subnet           | 192.168.101.0/24           |
    | management_start_ip         | 192.168.101.2              |
    | management_end_ip           | 192.168.101.50             |
    | management_gateway_ip       | 192.168.101.1              |
    | systemcontroller_gateway_ip | 192.168.204.101            |
    | created_at                  | 2020-03-05 21:43:46.525251 |
    | updated_at                  | 2020-03-06 19:53:39.560771 |
    | identity_sync_status        | in-sync                    |
    | patching_sync_status        | in-sync                    |
    | platform_sync_status        | in-sync                    |
    | oam_floating_ip             | 10.10.10.12                |
    +-----------------------------+----------------------------+
  • To edit the settings for a subcloud, use the subcloud update command.

    ~(keystone_admin)]$ dcmanager subcloud update \
    [- description] <description> \
    [ location] <location> \
    <subcloud-name>
  • To toggle a subcloud between Unmanaged and Managed, pass these parameters to the subcloud command.

    For example:

    ~(keystone_admin)]$ dcmanager subcloud unmanage <subcloud-name>
    ~(keystone_admin)]$ dcmanager subcloud manage <subcloud-name>
  • To reconfigure a subcloud, if deployment fails, use the subcloud reconfig command.

    Note

    You can enter the sysadmin password to avoid being prompted for the password.

    ~(keystone_admin)]$ dcmanager subcloud reconfig <subcloud-id/name> --deploy-config \
    <filepath> --sysadmin-password <<password>>

    where --deploy-config must reference the deployment configuration file.

    partner

    Note

    The subcloud can be managed only if the deploy status is 'complete'.

    Run the following command to manage the subcloud:

    ~(keystone_admin)]$ dcmanager subcloud manage <subcloud-id/name>
  • To delete a subcloud, use the subcloud delete command.

    ~(keystone_admin)]$ dcmanager subcloud delete <subcloud-name>

    Caution

    You must reinstall a deleted subcloud before re-adding it.

  • To show detailed information about subcloud install/bootstrap/deploy failures, use the subcloud errors <subcloud-name> command.

    For example:

    [sysadmin@controller-0 ~(keystone_admin)]$ dcmanager subcloud errors 1
    FAILED bootstrapping playbook of (subcloud1).
     detail: fatal: [subcloud1]: FAILED! => changed=true
      failed_when_result: true
      msg: non-zero return code
        500 Server Error: Internal Server Error ("manifest unknown: manifest unknown")
         Image download failed: admin-2.cumulus.mss.com: 30093/wind-river/cloud-platform-deployment-manager: WRCP_22.06 500 Server Error: Internal Server Error ("Get https://admin-2.cumulus .mss.com: 30093/v2/: dial tcp: lookup admin-2.cumulus.mss.com on 10.41.0.1:53: read udp 10.41.1.3:40251->10.41.0.1:53: i/o timeout")
         Image download failed: gcd.io/kubebuilder/kube-rdac-proxy:v0.11.0 500 Server Error: Internal Server Error ("Get https://gcd.io/v2/: dial tcp: lookup gcd.io on 10.41.0.1:53: read udp 10.41.1.3:52485->10.41.0.1:53: i/o timeout")
        raise Exception("Failed to download images %s" % failed_downloads)
         Exception: Failed to download images ["admin-2.cumulus.mss.com: 30093/wind-river/cloud-platform-deployment-manager: WRCP_22.06", "gcd.io kubebuilder/kube-rdac-proxy:v0.11.0"]
    FAILED TASK: TASK [common/push-docker-images Download images and push to local registry] Wednesday 12 October 2022 12:27:31 +0000 (0:00:00.042)
    0:16:34.495