Skip to content

Commit 440befa

Browse files
authored
docs(k8s): update api docs (#3110)
1 parent 93340c9 commit 440befa

File tree

6 files changed

+9
-9
lines changed

6 files changed

+9
-9
lines changed

cmd/scw/testdata/test-all-usage-k8s-cluster-create-usage.golden

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ EXAMPLES:
1414

1515
ARGS:
1616
[project-id] Project ID to use. If none is passed the default project ID will be used
17-
[type] Type of the cluster
17+
[type] Type of the cluster (possible values are kapsule, multicloud).
1818
name=<generated> Name of the cluster
1919
[description] Description of the cluster
2020
[tags.{index}] Tags associated with the cluster

cmd/scw/testdata/test-all-usage-k8s-cluster-set-type-usage.golden

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ EXAMPLES:
1111

1212
ARGS:
1313
cluster-id ID of the cluster to migrate from one type to another
14-
type Type of the cluster
14+
type Type of the cluster. Note that some migrations are not possible (please refer to product documentation).
1515
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
1616

1717
FLAGS:

docs/commands/k8s.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ scw k8s cluster create [arg=value ...]
6161
| Name | | Description |
6262
|------|---|-------------|
6363
| project-id | | Project ID to use. If none is passed the default project ID will be used |
64-
| type | | Type of the cluster |
64+
| type | | Type of the cluster (possible values are kapsule, multicloud). |
6565
| name | Required<br />Default: `<generated>` | Name of the cluster |
6666
| description | | Description of the cluster |
6767
| tags.{index} | | Tags associated with the cluster |
@@ -311,7 +311,7 @@ scw k8s cluster set-type <cluster-id ...> [arg=value ...]
311311
| Name | | Description |
312312
|------|---|-------------|
313313
| cluster-id | Required | ID of the cluster to migrate from one type to another |
314-
| type | Required | Type of the cluster |
314+
| type | Required | Type of the cluster. Note that some migrations are not possible (please refer to product documentation). |
315315
| region | Default: `fr-par`<br />One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config |
316316

317317

go.mod

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ require (
2626
github.com/moby/buildkit v0.11.6
2727
github.com/opencontainers/go-digest v1.0.0
2828
github.com/pkg/errors v0.9.1
29-
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.16.0.20230509101251-6bff51802440
29+
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.16.0.20230510093006-b00ddce97048
3030
github.com/spf13/cobra v1.7.0
3131
github.com/spf13/pflag v1.0.5
3232
github.com/stretchr/testify v1.8.2

go.sum

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -483,8 +483,8 @@ github.com/rogpeppe/go-internal v1.10.0/go.mod h1:UQnix2H7Ngw/k4C5ijL5+65zddjncj
483483
github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
484484
github.com/sabhiram/go-gitignore v0.0.0-20210923224102-525f6e181f06 h1:OkMGxebDjyw0ULyrTYWeN0UNCCkmCWfjPnIA2W6oviI=
485485
github.com/sabhiram/go-gitignore v0.0.0-20210923224102-525f6e181f06/go.mod h1:+ePHsJ1keEjQtpvf9HHw0f4ZeJ0TLRsxhunSI2hYJSs=
486-
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.16.0.20230509101251-6bff51802440 h1:Mfjd98EL+Qa/ckCZZnYdGRD/llBx0aOju4+7zMD2tl8=
487-
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.16.0.20230509101251-6bff51802440/go.mod h1:fCa7OJZ/9DRTnOKmxvT6pn+LPWUptQAmHF/SBJUGEcg=
486+
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.16.0.20230510093006-b00ddce97048 h1:kTC0xKY/C2nsmjNJezBi2ubddeEsJaTpNg9Jf8HN8ww=
487+
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.16.0.20230510093006-b00ddce97048/go.mod h1:fCa7OJZ/9DRTnOKmxvT6pn+LPWUptQAmHF/SBJUGEcg=
488488
github.com/sclevine/spec v1.4.0 h1:z/Q9idDcay5m5irkZ28M7PtQM4aOISzOpj4bUPkDee8=
489489
github.com/secure-systems-lab/go-securesystemslib v0.4.0 h1:b23VGrQhTA8cN2CbBw7/FulN9fTtqYUdS5+Oxzt+DUE=
490490
github.com/sergi/go-diff v1.0.0/go.mod h1:0CfEIISq7TuYL3j771MWULgwwjU+GofnZX9QAmXWZgo=

internal/namespaces/k8s/v1/k8s_cli.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -242,7 +242,7 @@ func k8sClusterCreate() *core.Command {
242242
core.ProjectIDArgSpec(),
243243
{
244244
Name: "type",
245-
Short: `Type of the cluster`,
245+
Short: `Type of the cluster (possible values are kapsule, multicloud).`,
246246
Required: false,
247247
Deprecated: false,
248248
Positional: false,
@@ -1000,7 +1000,7 @@ func k8sClusterSetType() *core.Command {
10001000
},
10011001
{
10021002
Name: "type",
1003-
Short: `Type of the cluster`,
1003+
Short: `Type of the cluster. Note that some migrations are not possible (please refer to product documentation).`,
10041004
Required: true,
10051005
Deprecated: false,
10061006
Positional: false,

0 commit comments

Comments
 (0)