starlingx/docs
Code Issues Proposed changes
Files
d3784712c71a451de77a3a76ea8b95bb0b8c4a86
docs/doc/source/dist_cloud/kubernetes/managing-subclouds-using-the-cli.rst
Suzana Fernandes 5fdcc40922 Subcloud install or restore of previous release 
Story: 2010611
Task: 49524

Change-Id: I938046184cb74f561b15b1fa9f177d4c5405e679
Signed-off-by: Suzana Fernandes <Suzana.Fernandes@windriver.com>
2024-11-18 11:57:12 +00:00

194 lines
8.8 KiB
ReStructuredText
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

.. rrh1558616429378
.. _managing-subclouds-using-the-cli:
==============================
Manage Subclouds Using the CLI
==============================
You can use the |CLI| to list subclouds, reconfigure subclouds if deployment
fails, delete subclouds, and monitor or change the managed status of subclouds.
.. _managing-subclouds-using-the-cli-steps-unordered-r4m-2w5-5cb:
- To list subclouds, use the :command:`subcloud list` command.
For example:
.. code-block:: none
[sysadmin@controller-0 ~(keystone_admin)]$ dcmanager subcloud list
+----+-----------+------------+--------------+---------------+-------------+------------------+-----------------+
| id | name | management | availability | deploy status | sync | backup status | prestage status |
+----+-----------+------------+--------------+---------------+-------------+------------------+-----------------+
| 1 | subcloud1 | managed | online | complete | in-sync | complete-central | Complete |
| 2 | subcloud2 | managed | online | complete | in-sync | None | None |
| 3 | subcloud3 | managed | online | complete | out-of-sync | None | None |
| 4 | subcloud4 | unmanaged | offline | rehome-failed | unknown | None | None |
+----+-----------+------------+--------------+---------------+-------------+------------------+-----------------+
Options:
'd/-detail': Display all columns for the subclouds.
'c/-column': Specify the column(s) for the subclouds. eg. '-c column1 -c column2 ...'
- To show information for a subcloud, use the :command:`subcloud show` command.
.. code-block:: none
[sysadmin@controller-0 ~(keystone_admin)]$ dcmanager subcloud show <subcloud-name>
For example:
.. code-block:: none
[sysadmin@controller-0 ~(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 :command:`subcloud show <subcloud-name> --detail` command.
For example,
.. code-block:: none
[sysadmin@controller-0 ~(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 :command:`subcloud update`
command.
.. code-block:: none
[sysadmin@controller-0 ~(keystone_admin)]$ dcmanager subcloud update \
[–- description] <description> \
[– location] <location> \
<subcloud-name>
- To toggle a subcloud between **Unmanaged** and **Managed**, pass these
parameters to the :command:`subcloud` command.
For example:
.. code-block:: none
[sysadmin@controller-0 ~(keystone_admin)]$ dcmanager subcloud unmanage <subcloud-name>
.. code-block:: none
[sysadmin@controller-0 ~(keystone_admin)]$ dcmanager subcloud manage <subcloud-name>
- To reconfigure a subcloud, if deployment fails, use the :command:`subcloud deploy config` command.
.. note::
You can enter the ``sysadmin`` password to avoid being prompted for the password.
.. code-block:: none
[sysadmin@controller-0 ~(keystone_admin)]$ dcmanager subcloud deploy config <subcloud-id/name> --deploy-config \
<filepath> --sysadmin-password <password>
where ``--deploy-config`` must reference the deployment configuration file.
.. only:: partner
.. include:: /_includes/managing-subclouds-using-the-cli.rest
:start-after: deploy-config-begin
:end-before: deploy-config-end
.. note::
The subcloud can be managed only if the deploy status is 'complete'.
Run the following command to manage the subcloud:
.. code-block:: none
[sysadmin@controller-0 ~(keystone_admin)]$ dcmanager subcloud manage <subcloud-id/name>
- To delete a subcloud, use the :command:`subcloud delete` command.
.. code-block:: none
[sysadmin@controller-0 ~(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 :command:`subcloud errors <subcloud-name>` command.
For example:
.. code-block:: none
[sysadmin@controller-0 ~(keystone_admin)]$ dcmanager subcloud errors 4
FAILED bootstrapping playbook of (subcloud1).
detail: fatal: [subcloud1]: FAILED! => changed-false
msg:
- Failed to log in one of the registry. Please check if docker_registries parameter
- "is properly configured in bootstrap overrides yaml file and docker registry certificate (where " - applicable) is valid.
- Err_code=images_download_failure
- "Possible failures: Logging into registry.k8s.io for user admin failed 500 Server Error: Internal Server Error ("Get "https://registry.k8s.io/v2/": net/http: request canceled while waiting for connection (Client.Timeout exceeded while awaiting headers)") | Logging into icr.io for user admin failed - 500 Server Error: Internal Server Error ("Get "https://icr.io/v2/": net/http: request canceled while waiting for connection (Client.Timeout exceeded while awaitin g headers)")"
FAILED TASK: TASK [common/push-docker-images: Display registry login error] Tuesday 21 March 2023 0 31:13 +0000 (0:00:00.076)
0:22:47.420
Check docker_registries and docker proxy configurations in bootstrap values yaml file. Ensure you can manually log into the registry e.g. sudo docker login registry.local:9001 -u <registry-user> -p <registry-password>
For bootstrap failures, please delete and re-add the subcloud after the cause of failure has been resolved.
View Git Blame Copy Permalink