Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -10,23 +10,23 @@ EXAMPLES:
scw instance server image create name=foobar snapshot-id=11111111-1111-1111-1111-111111111111 arch=x86_64

ARGS:
[name=<generated>] Name of the image
snapshot-id UUID of the snapshot that will be used as root volume in the image
arch Architecture of the image (x86_64 | arm | arm64)
[additional-snapshots.{index}.id] UUID of the snapshot to add
[additional-snapshots.{index}.name] Name of the additional snapshot
[additional-snapshots.{index}.size] Size of the additional snapshot
[additional-snapshots.{index}.volume-type] Underlying volume type of the additional snapshot (l_ssd | b_ssd | unified | scratch | sbs_volume)
[additional-snapshots.{index}.project-id] Project ID that own the additional snapshot
[project-id] Project ID to use. If none is passed the default project ID will be used
[tags.{index}] Tags of the image
[public] True to create a public image
[organization-id] Organization ID to use. If none is passed the default organization ID will be used
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | fr-par-3 | nl-ams-1 | nl-ams-2 | nl-ams-3 | pl-waw-1 | pl-waw-2 | pl-waw-3)
[name=<generated>] Name of the image
snapshot-id UUID of the snapshot that will be used as root volume in the image
arch Architecture of the image (x86_64 | arm | arm64)
[additional-volumes.{index}.id] UUID of the snapshot to add
[additional-volumes.{index}.name] Name of the additional snapshot
[additional-volumes.{index}.size] Size of the additional snapshot
[additional-volumes.{index}.volume-type] Underlying volume type of the additional snapshot (l_ssd | b_ssd | unified | scratch | sbs_volume)
[additional-volumes.{index}.project-id] Project ID that own the additional snapshot
[project-id] Project ID to use. If none is passed the default project ID will be used
[tags.{index}] Tags of the image
[public] True to create a public image
[organization-id] Organization ID to use. If none is passed the default organization ID will be used
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | fr-par-3 | nl-ams-1 | nl-ams-2 | nl-ams-3 | pl-waw-1 | pl-waw-2 | pl-waw-3)

DEPRECATED ARGS:
[default-bootscript] Default bootscript of the image
[additional-snapshots.{index}.organization-id] Organization ID that own the additional snapshot
[default-bootscript] Default bootscript of the image
[additional-volumes.{index}.organization-id] Organization ID that own the additional snapshot

FLAGS:
-h, --help help for create
Expand Down
12 changes: 6 additions & 6 deletions docs/commands/instance.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,12 +129,12 @@ scw instance image create [arg=value ...]
| snapshot-id | Required | UUID of the snapshot that will be used as root volume in the image |
| arch | Required<br />One of: `x86_64`, `arm`, `arm64` | Architecture of the image |
| ~~default-bootscript~~ | Deprecated | Default bootscript of the image |
| additional-snapshots.{index}.id | | UUID of the snapshot to add |
| additional-snapshots.{index}.name | | Name of the additional snapshot |
| additional-snapshots.{index}.size | | Size of the additional snapshot |
| additional-snapshots.{index}.volume-type | One of: `l_ssd`, `b_ssd`, `unified`, `scratch`, `sbs_volume` | Underlying volume type of the additional snapshot |
| additional-snapshots.{index}.project-id | | Project ID that own the additional snapshot |
| ~~additional-snapshots.{index}.organization-id~~ | Deprecated | Organization ID that own the additional snapshot |
| additional-volumes.{index}.id | | UUID of the snapshot to add |
| additional-volumes.{index}.name | | Name of the additional snapshot |
| additional-volumes.{index}.size | | Size of the additional snapshot |
| additional-volumes.{index}.volume-type | One of: `l_ssd`, `b_ssd`, `unified`, `scratch`, `sbs_volume` | Underlying volume type of the additional snapshot |
| additional-volumes.{index}.project-id | | Project ID that own the additional snapshot |
| ~~additional-volumes.{index}.organization-id~~ | Deprecated | Organization ID that own the additional snapshot |
| project-id | | Project ID to use. If none is passed the default project ID will be used |
| tags.{index} | | Tags of the image |
| public | | True to create a public image |
Expand Down
12 changes: 6 additions & 6 deletions internal/namespaces/instance/v1/custom_image.go
Original file line number Diff line number Diff line change
Expand Up @@ -104,22 +104,22 @@ func imageCreateBuilder(c *core.Command) *core.Command {
}

c.ArgSpecs.GetByName("extra-volumes.{key}.id").Short = "UUID of the snapshot to add"
c.ArgSpecs.GetByName("extra-volumes.{key}.id").Name = "additional-snapshots.{index}.id"
c.ArgSpecs.GetByName("extra-volumes.{key}.id").Name = "additional-volumes.{index}.id"

c.ArgSpecs.GetByName("extra-volumes.{key}.name").Short = "Name of the additional snapshot"
c.ArgSpecs.GetByName("extra-volumes.{key}.name").Name = "additional-snapshots.{index}.name"
c.ArgSpecs.GetByName("extra-volumes.{key}.name").Name = "additional-volumes.{index}.name"

c.ArgSpecs.GetByName("extra-volumes.{key}.size").Short = "Size of the additional snapshot"
c.ArgSpecs.GetByName("extra-volumes.{key}.size").Name = "additional-snapshots.{index}.size"
c.ArgSpecs.GetByName("extra-volumes.{key}.size").Name = "additional-volumes.{index}.size"

c.ArgSpecs.GetByName("extra-volumes.{key}.volume-type").Short = "Underlying volume type of the additional snapshot"
c.ArgSpecs.GetByName("extra-volumes.{key}.volume-type").Name = "additional-snapshots.{index}.volume-type"
c.ArgSpecs.GetByName("extra-volumes.{key}.volume-type").Name = "additional-volumes.{index}.volume-type"

c.ArgSpecs.GetByName("extra-volumes.{key}.organization").Short = "Organization ID that own the additional snapshot"
c.ArgSpecs.GetByName("extra-volumes.{key}.organization").Name = "additional-snapshots.{index}.organization-id"
c.ArgSpecs.GetByName("extra-volumes.{key}.organization").Name = "additional-volumes.{index}.organization-id"

c.ArgSpecs.GetByName("extra-volumes.{key}.project").Short = "Project ID that own the additional snapshot"
c.ArgSpecs.GetByName("extra-volumes.{key}.project").Name = "additional-snapshots.{index}.project-id"
c.ArgSpecs.GetByName("extra-volumes.{key}.project").Name = "additional-volumes.{index}.project-id"

c.ArgSpecs.GetByName("root-volume").Short = "UUID of the snapshot that will be used as root volume in the image"
c.ArgSpecs.GetByName("root-volume").Name = "snapshot-id"
Expand Down