Skip to content

Commit 3901788

Browse files
bkgoodremyleone
andauthored
docs(instance): clarify how to update server volumes (#5360)
Co-authored-by: Rémy Léone <rleone@scaleway.com>
1 parent c9a7799 commit 3901788

File tree

3 files changed

+14
-0
lines changed

3 files changed

+14
-0
lines changed

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,9 @@ EXAMPLES:
2121
Put a specified Instance in the specified placement group. Instance must be off
2222
scw instance server server update 11111111-1111-1111-1111-111111111111 placement-group-id=11111111-1111-1111-1111-111111111111
2323

24+
Boot an Instance from a specific volume
25+
scw instance server update 11111111-1111-1111-1111-111111111111 volumes.0.id=11111111-1111-1111-1111-111111111111 volumes.0.boot=true
26+
2427
ARGS:
2528
server-id UUID of the Instance
2629
[name] Name of the Instance

docs/commands/instance.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2366,6 +2366,11 @@ Put a specified Instance in the specified placement group. Instance must be off
23662366
scw instance server server update 11111111-1111-1111-1111-111111111111 placement-group-id=11111111-1111-1111-1111-111111111111
23672367
```
23682368

2369+
Boot an Instance from a specific volume
2370+
```
2371+
scw instance server update 11111111-1111-1111-1111-111111111111 volumes.0.id=11111111-1111-1111-1111-111111111111 volumes.0.boot=true
2372+
```
2373+
23692374

23702375

23712376

internal/namespaces/instance/v1/custom_server.go

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -379,6 +379,12 @@ func serverUpdateBuilder(c *core.Command) *core.Command {
379379
},
380380
}
381381

382+
// clarify how to address attached volumes, specific to the cli.
383+
c.Examples = append(c.Examples, &core.Example{
384+
Short: "Boot an Instance from a specific volume",
385+
Raw: `scw instance server update 11111111-1111-1111-1111-111111111111 volumes.0.id=11111111-1111-1111-1111-111111111111 volumes.0.boot=true`,
386+
})
387+
382388
return c
383389
}
384390

0 commit comments

Comments
 (0)