How to manage cluster links¶

View cluster links¶

To list all cluster links (that you have permission to see), run:

lxc cluster link list

To list all cluster links (that you have permission to see), send the following request:

lxc query --request GET /1.0/cluster/links

To display detailed information about each cluster link, use Recursion:

lxc query --request GET /1.0/cluster/links?recursion=1

See GET /1.0/cluster/links and GET /1.0/cluster/links?recursion=1 for more information.

To view the full configuration of a specific cluster link, run:

lxc cluster link show <name>

lxc query --request GET /1.0/cluster/links/<name>

See GET /1.0/cluster/links/{name} for more information.

To view detailed information about the state of a specific cluster link, run:

lxc cluster link info <name>

lxc query --request GET /1.0/cluster/links/<name>/state

See GET /1.0/cluster/links/{name}/state for more information.

Manage cluster link permissions¶

To modify the permissions of a cluster link, add its identity to authentication groups. See Manage permissions for more information.

For example, you can create an authentication group with server viewer permissions and add the cluster link identity to it:

lxc auth group create viewers
lxc auth group permission add viewers server viewer
lxc auth identity group add tls/<cluster-link-name> viewers

Alternatively, you can specify an authentication group when creating a cluster link, which will automatically assign the cluster link identity to that group.

Example:

lxc cluster link create cluster_b --auth-group server-admins

Configure a cluster link¶

See Cluster link configuration for more details on cluster link configuration options.

There are multiple ways to update the configuration for a cluster link.

You can edit the entire configuration at once:

To edit a cluster link in your default text editor, enter the following command:

lxc cluster link edit <name>

To edit a cluster link, send the following request:

lxc query --request PUT /1.0/cluster/links/<name> --data "<link_configuration>"

See PUT /1.0/cluster/links/{name} for more information.

You can update a single property for a cluster link:

Use the set command with the --property flag:

lxc cluster link set <cluster-link-name> --property <key>=<value>

For example, to update the description property:

lxc cluster link set cluster_b --property description="Backup cluster in data center 2"

To modify a specific property, send the following request:

lxc query --request PATCH /1.0/cluster/links/<name> --data '{"<key>": "<value>"}'

Example:

lxc query --request PATCH /1.0/cluster/links/cluster_b --data '{"description": "Backup cluster in data center B"}'

See PATCH /1.0/cluster/links/{name} for more information.

Cluster links have the following properties:

description

Description of the cluster link

Key:	`description`
Type:	string
Required:	no

name

The name of the cluster link

Key:	`name`
Type:	string
Required:	no

You can also update a single configuration option for a cluster link. Run:

lxc cluster link set <name> <key>=<value>

lxc query --request PATCH /1.0/cluster/links/<name> --data '{"config": <config>}'

See PATCH /1.0/cluster/links/{name} for more information.

Delete a cluster link¶

To delete a cluster link, run:

lxc cluster link delete <name>

lxc query --request DELETE /1.0/cluster/links/<name>

See DELETE /1.0/cluster-links/{name} for more information.

Note

Deleting a cluster link removes the established trust and deletes the associated identity on the local cluster. If you only run the command on one cluster, the other cluster will still have the cluster link identity and trust established (still allowing requests from the linked cluster). To fully disconnect the clusters, run the command on both clusters.