1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
|
(howto-cluster-groups)=
# How to set up cluster groups
Cluster members can be assigned to {ref}`cluster-groups`.
By default, all cluster members belong to the `default` group.
To create a cluster group, use the [`incus cluster group create`](incus_cluster_group_create.md) command.
For example:
incus cluster group create gpu
To assign a cluster member to one or more groups, use the [`incus cluster group assign`](incus_cluster_group_assign.md) command.
This command removes the specified cluster member from all the cluster groups it currently is a member of and then adds it to the specified group or groups.
For example, to assign `server1` to only the `gpu` group, use the following command:
incus cluster group assign server1 gpu
To assign `server1` to the `gpu` group and also keep it in the `default` group, use the following command:
incus cluster group assign server1 default,gpu
To add a cluster member to a specific group without removing it from other groups, use the [`incus cluster group add`](incus_cluster_group_add.md) command.
For example, to add `server1` to the `gpu` group and also keep it in the `default` group, use the following command:
incus cluster group add server1 gpu
## Launch an instance on a cluster group member
With cluster groups, you can target an instance to run on one of the members of the cluster group, instead of targeting it to run on a specific member.
```{note}
{config:option}`cluster-cluster:scheduler.instance` must be set to either `all` (the default) or `group` to allow instances to be targeted to a cluster group.
See {ref}`clustering-instance-placement` for more information.
```
To launch an instance on a member of a cluster group, follow the instructions in {ref}`cluster-target-instance`, but use the group name prefixed with `@` for the `--target` flag.
For example:
incus launch images:debian/12 c1 --target=@gpu
## Use with restricted projects
A project can be configured to only have access to servers that are part of specific cluster groups.
This is done by setting both `restricted=true` and `restricted.cluster.groups` to a comma separated list of group names.
```{note}
If the cluster group is renamed, the project restrictions will need to be updated for the new group name.
```
|
