Skip to content

Commit 3dc87a0

Browse files
authored
docs(instance): add documentation on placement group (#1520)
1 parent 45262e8 commit 3dc87a0

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

cmd/scw/testdata/test-all-usage-instance-placement-group-update-usage.golden

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ EXAMPLES:
1818
ARGS:
1919
placement-group-id UUID of the placement group
2020
[name] Name of the placement group
21-
[policy-mode] (optional | enforced)
22-
[policy-type] (max_availability | low_latency)
21+
[policy-mode] The operating mode of the placement group (optional | enforced)
22+
[policy-type] The policy type of the placement group (max_availability | low_latency)
2323
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1 | pl-waw-1)
2424

2525
FLAGS:

internal/namespaces/instance/v1/instance_cli.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2088,13 +2088,15 @@ func instancePlacementGroupUpdate() *core.Command {
20882088
},
20892089
{
20902090
Name: "policy-mode",
2091+
Short: `The operating mode of the placement group`,
20912092
Required: false,
20922093
Deprecated: false,
20932094
Positional: false,
20942095
EnumValues: []string{"optional", "enforced"},
20952096
},
20962097
{
20972098
Name: "policy-type",
2099+
Short: `The policy type of the placement group`,
20982100
Required: false,
20992101
Deprecated: false,
21002102
Positional: false,

0 commit comments

Comments
 (0)