Managing the cluster topology

By managing regions, rack groups, and racks, replicas can be strategically placed in different regions to maximize data security.

Viewing the topology list

Procedure

Run the following command on any node in the cluster:

zbs-meta topo list [--show_details]

Parameter	Description
`--show_details`	Optional. Specifies whether to display the full topology object list, including all chunk objects and node objects.

Output example

id                                    type     name                                          parent_id      ring_id    position.row    position.column    capacity.row    capacity.column    dimension.row    dimension.column  create_time          description
------------------------------------  -------  --------------------------------------------  -----------  ---------  --------------  -----------------  --------------  -----------------  ---------------  ------------------  -------------------  -------------
27742cfa-d7e7-4fe7-ba05-3290d4723b06  CHUNK    chunk-2-27742cfa-d7e7-4fe7-ba05-3290d4723b06  topo                 1               1                  1               1                  1                1                   1  2024-06-17 14:06:13  chunk2
36c38812-4f4d-44df-a09f-06437bcedb95  BRICK    new-brick                                     defrack              0               1                  1               1                  1                1                   1  2024-06-17 15:30:42
default                               ZONE     default                                       topo                 0               1                  1               1                  1                1                   1  1970-01-01 08:00:00
defrack                               RACK                                                   default              0               1                  1             256                  1                1                   1  1970-01-01 08:00:00
f677b91b-4932-4047-b5f2-f1988c8d8e32  CHUNK    chunk-3-f677b91b-4932-4047-b5f2-f1988c8d8e32  topo                 2               1                  1               1                  1                1                   1  2024-06-17 14:06:13  chunk3
fdaee4fd-8f5d-47a8-bf80-43e0f8db6ba7  CHUNK    chunk-1-fdaee4fd-8f5d-47a8-bf80-43e0f8db6ba7  topo                 3               1                  1               1                  1                1                   1  2024-06-17 14:06:12  chunk1
topo                                  CLUSTER                                                topo                 0               1                  1               1                  1                1                   1  1970-01-01 08:00:00

Output note

Parameter	Description
`id`	The identifier.
`type`	The topology type: rack, chassis, etc.
`name`	The name.
`parent_id`	The parent node ID.
`ring_id`	The topology ring ID.
`position.row`, `position.column`	The position of the current node within the parent node: row and column coordinates.
`capacity.row`, `capacity.column`	The node capacity.
`dimension.row`, `dimension.column`	The size occupied within the parent node.

Creating a rack or chassis

Procedure

Run the following command on any node in the cluster to create a rack or chassis:

zbs-meta topo create <type> <name>

Parameter description

Parameter Description

Parameter	Description
`type`	When the type is set to `rack`, a rack is created. For example: `zbs-meta topo create rack new-rack --parent_id default` Create a new rack named `new-rack`. When the type is set to `brick`, a chassis is created, and you must specify the `--parent_id` parameter to specify which rack the chassis is located in. For example: `zbs-meta topo create brick new-brick --parent_id d7c626fd` Create a new chassis named `new-brick`, and the chassis is placed in the rack with ID `d7c626fd`.
`name`	The name of the chassis or rack to be created.

type

When the type is set to rack, a rack is created. For example:

zbs-meta topo create rack new-rack --parent_id default

Create a new rack named new-rack.

When the type is set to brick, a chassis is created, and you must specify the --parent_id parameter to specify which rack the chassis is located in. For example:
zbs-meta topo create brick new-brick --parent_id d7c626fd

Create a new chassis named new-brick, and the chassis is placed in the rack with ID d7c626fd.

name The name of the chassis or rack to be created.

Output note

If the command succeeds, no output is displayed.

Deleting a rack or chassis

Procedure

Run the following command on any node in the cluster to delete a rack or chassis:

zbs-meta topo delete <id>

id is the ID of the rack or chassis.

Output note

If the command succeeds, no output is displayed.

Viewing detailed information about a rack, chassis, or node

Procedure

Run the following command on any node in the cluster to view detailed information about racks, chassis, or nodes:

zbs-meta topo show <id> [--show_details]

Parameter	Description
`id`	Required. The ID of a rack, chassis, or node.
`--show_details`	Optional. When the ID corresponds to a chunk physical disk pool object, it specifies whether to display its actual parent node object. By default, the logical parent node object is displayed.

Output example

----------------  --------------------------------------------
id                27742cfa-d7e7-4fe7-ba05-3290d4723b06
type              CHUNK
name              chunk-2-27742cfa-d7e7-4fe7-ba05-3290d4723b06
parent_id         topo
ring_id           1
position.row      1
position.column   1
capacity.row      1
capacity.column   1
dimension.row     1
dimension.column  1
create_time       2024-06-17 14:06:13
description       chunk2
----------------  --------------------------------------------

Output note

Parameter	Description
`id`	The identifier.
`type`	The topology type: rack, chassis, etc.
`name`	The name.
`parent_id`	The parent node ID.
`ring_id`	The topology ring ID.
`position.row`, `position.column`	The position of the current node within the parent node: row and column coordinates.
`capacity.row`, `capacity.column`	The node capacity.
`dimension.row`, `dimension.column`	The size occupied within the parent node.

Updating detailed information about a rack, chassis, or node

Procedure

Execute the following command on any cluster node to update information for a chassis, rack, or node. (When updating the location of a chunk physical disk pool object, the update will automatically apply to the corresponding node object.)

zbs-meta topo update <id>

Output note

If the command succeeds, no output is displayed.

In this article

Viewing the topology list
Creating a rack or chassis
Deleting a rack or chassis
Viewing detailed information about a rack, chassis, or node
Updating detailed information about a rack, chassis, or node