Skip to content

docs(k8s): update api docs #3110

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Codelax merged 1 commit into from
May 10, 2023
Merged

docs(k8s): update api docs #3110

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion cmd/scw/testdata/test-all-usage-k8s-cluster-create-usage.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ EXAMPLES:

ARGS:
[project-id] Project ID to use. If none is passed the default project ID will be used
[type] Type of the cluster
[type] Type of the cluster (possible values are kapsule, multicloud).
name=<generated> Name of the cluster
[description] Description of the cluster
[tags.{index}] Tags associated with the cluster
Expand Down
2 changes: 1 addition & 1 deletion cmd/scw/testdata/test-all-usage-k8s-cluster-set-type-usage.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ EXAMPLES:

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

FLAGS:
Expand Down
4 changes: 2 additions & 2 deletions docs/commands/k8s.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ scw k8s cluster create [arg=value ...]
| Name | | Description |
|------|---|-------------|
| project-id | | Project ID to use. If none is passed the default project ID will be used |
| type | | Type of the cluster |
| type | | Type of the cluster (possible values are kapsule, multicloud). |
| name | Required<br />Default: `<generated>` | Name of the cluster |
| description | | Description of the cluster |
| tags.{index} | | Tags associated with the cluster |
Expand Down Expand Up @@ -311,7 +311,7 @@ scw k8s cluster set-type <cluster-id ...> [arg=value ...]
| Name | | Description |
|------|---|-------------|
| cluster-id | Required | ID of the cluster to migrate from one type to another |
| type | Required | Type of the cluster |
| type | Required | Type of the cluster. Note that some migrations are not possible (please refer to product documentation). |
| 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 |


Expand Down
2 changes: 1 addition & 1 deletion go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ require (
github.com/moby/buildkit v0.11.6
github.com/opencontainers/go-digest v1.0.0
github.com/pkg/errors v0.9.1
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.16.0.20230509101251-6bff51802440
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.16.0.20230510093006-b00ddce97048
github.com/spf13/cobra v1.7.0
github.com/spf13/pflag v1.0.5
github.com/stretchr/testify v1.8.2
Expand Down
4 changes: 2 additions & 2 deletions go.sum
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -483,8 +483,8 @@ github.com/rogpeppe/go-internal v1.10.0/go.mod h1:UQnix2H7Ngw/k4C5ijL5+65zddjncj
github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
github.com/sabhiram/go-gitignore v0.0.0-20210923224102-525f6e181f06 h1:OkMGxebDjyw0ULyrTYWeN0UNCCkmCWfjPnIA2W6oviI=
github.com/sabhiram/go-gitignore v0.0.0-20210923224102-525f6e181f06/go.mod h1:+ePHsJ1keEjQtpvf9HHw0f4ZeJ0TLRsxhunSI2hYJSs=
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.16.0.20230509101251-6bff51802440 h1:Mfjd98EL+Qa/ckCZZnYdGRD/llBx0aOju4+7zMD2tl8=
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.16.0.20230509101251-6bff51802440/go.mod h1:fCa7OJZ/9DRTnOKmxvT6pn+LPWUptQAmHF/SBJUGEcg=
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.16.0.20230510093006-b00ddce97048 h1:kTC0xKY/C2nsmjNJezBi2ubddeEsJaTpNg9Jf8HN8ww=
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.16.0.20230510093006-b00ddce97048/go.mod h1:fCa7OJZ/9DRTnOKmxvT6pn+LPWUptQAmHF/SBJUGEcg=
github.com/sclevine/spec v1.4.0 h1:z/Q9idDcay5m5irkZ28M7PtQM4aOISzOpj4bUPkDee8=
github.com/secure-systems-lab/go-securesystemslib v0.4.0 h1:b23VGrQhTA8cN2CbBw7/FulN9fTtqYUdS5+Oxzt+DUE=
github.com/sergi/go-diff v1.0.0/go.mod h1:0CfEIISq7TuYL3j771MWULgwwjU+GofnZX9QAmXWZgo=
Expand Down
4 changes: 2 additions & 2 deletions internal/namespaces/k8s/v1/k8s_cli.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -242,7 +242,7 @@ func k8sClusterCreate() *core.Command {
core.ProjectIDArgSpec(),
{
Name: "type",
Short: `Type of the cluster`,
Short: `Type of the cluster (possible values are kapsule, multicloud).`,
Required: false,
Deprecated: false,
Positional: false,
Expand Down Expand Up @@ -1000,7 +1000,7 @@ func k8sClusterSetType() *core.Command {
},
{
Name: "type",
Short: `Type of the cluster`,
Short: `Type of the cluster. Note that some migrations are not possible (please refer to product documentation).`,
Required: true,
Deprecated: false,
Positional: false,
Expand Down