docs/doc/source/dist_cloud/creating-subcloud-groups.rst

Create Subcloud Groups

When a subcloud is created it is automatically added to the 'Default' subcloud group, unless the group is specified. Subclouds can be associated with a particular group when they are created, and that association can be changed to a different subcloud group, if required.

You can use commands to add new subcloud groups, list, update or delete subcloud groups. The commands for managing subcloud groups are:

dcmanager subcloud-group add: Adds a new subcloud group.

dcmanager subcloud-group delete: Deletes subcloud group details from the database.

Note

The 'Default' subcloud group cannot be deleted

dcmanager subcloud-group list: Lists subcloud groups.

dcmanager subcloud-group list-subclouds: List subclouds referencing a subcloud group.

dcmanager subcloud-group show: Shows the details of a subcloud group.

dcmanager subcloud-group update: Updates attributes of a subcloud group.

Note

The name of the 'Default' subcloud group cannot be changed

• To create a subcloud group, use the following command:

  ~(keystone_admin)]$ dcmanager subcloud-group add --name <<group>>
  usage: dcmanager subcloud-group add [-h] [-f {json,shell,table,value,yaml}]
   [-c COLUMN] [--max-width <integer>]
   [--fit-width] [--print-empty] [--noindent]
   [--prefix PREFIX] --name NAME
   [--description DESCRIPTION]
   [--update_apply_type UPDATE_APPLY_TYPE]
   [--max_parallel_subclouds MAX_PARALLEL_SUBCLOUDS]

  For example,

  ~(keystone_admin)]$ dcmanager subcloud-group add --name <Group1>
  +------------------------+----------------------------+
  | Field                  | Value                      |
  +------------------------+----------------------------+
  | id                     | 1                          |
  | name                   | Group1                     |
  | description            | No description provided    |
  | update apply type      | parallel                   |
  | max parallel subclouds | 20                         |
  | created_at             | 2020-09-15 19:03:30.050353 |
  | updated_at             | None                       |
  +------------------------+----------------------------+

  To create an upgrade strategy, if required, use the dcmanager upgrade-strategy create, dcmanager patch-strategy create, or dcmanager fw-update-strategy create commands. For more information, see Managing Subcloud Groups <managing-subcloud-groups>.

• To list subcloud groups, use the following command:

  ~(keystone_admin)]$ dcmanager subcloud-group list

  To list subclouds referencing a subcloud group, use the following command:

  ~(keystone_admin)]$ dcmanager subcloud-group list-subclouds

  For example,

  ~(keystone_admin)]$ dcmanager subcloud-group list-subclouds Group1
  
  +--+------+----+----+-------+-------+------+-----------+-----------+-------------+-----------+------------+------------+------+----------+----------+
  |id|name  |desc|loc.|sof.ver|mgmnt  |avail |deploy_stat|mgmt_subnet|mgmt_start_ip|mgmt_end_ip|mgmt_gtwy_ip|sysctrl_gtwy|grp_id|created_at|updated_at|
  +--+------+----+----+-------+-------+------+-----------+-----------+-------------+-----------+------------+------------+------+----------+----------+
  |3 |subcl1|None|None|20.06  |managed|online|complete   |fd01:12::0.|fd01:12::2   |fd01:12::11|fd01:12::1  |fd01:11::1  | 2    |2021-01-09|2021-01-12|
  |4 |subcl2|None|None|20.06  |managed|online|complete   |fd01:13::0.|fd01:13::2   |fd01:13::11|fd01:13::1  |fd01:11::1  | 2    |2021-01-09|2021-01-12|
  +--+------+----+----+-------+-------+------+-----------+-----------+-------------+-----------+------------+------------+------+----------+----------+

• To show the details of a subcloud group, use the following command:

  ~(keystone_admin)]$ dcmanager subcloud-group show

  For example,

  ~(keystone_admin)]$ dcmanager subcloud-group show Group1
  +------------------------+----------------------------+
  | Field                  | Value                      |
  +------------------------+----------------------------+
  | id                     | 2                          |
  | name                   | Group1                     |
  | description            | subcloud 3 and 4           |
  | update apply type      | parallel                   |
  | max parallel subclouds | 2                          |
  | created_at             | 2021-01-12 18:57:38.382269 |
  | updated_at             | None                       |
  +------------------------+----------------------------+

• To update the attributes and associate a subcloud with a specific subcloud group, use the following command, for example:

  ~(keystone_admin)]$ dcmanager subcloud update --group Group1 Subcloud1
  usage: dcmanager subcloud update [-h] [-f {json,shell,table,value,yaml}]
                                   [-c COLUMN] [--max-width <integer>]
                                   [--fit-width] [--print-empty] [--noindent]
                                   [--prefix PREFIX] [--description DESCRIPTION]
                                   [--location LOCATION] [--group GROUP]
                                   [--install-values INSTALL_VALUES]
                                   [--bmc-password BMC_PASSWORD]
                                   subcloud