Skip to content

docs(k8s): update node-type description and fix typo #2452

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 2 commits into from
Aug 23, 2022
Merged

docs(k8s): update node-type description and fix typo #2452

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4591ea1
feat: update generated cli
scaleway-bot Aug 17, 2022
6aafbee
Merge branch 'master' into v1.2647.0
Codelax Aug 23, 2022
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
4 changes: 2 additions & 2 deletions 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 @@ -21,11 +21,11 @@ ARGS:
version=latest The Kubernetes version of the cluster
cni=cilium The Container Network Interface (CNI) plugin that will run in the cluster (unknown_cni | cilium | calico | weave | flannel | kilo)
pools.{index}.name The name of the pool
pools.{index}.node-type The node type is the type of Scaleway Instance wanted for the pool, nodes with insufficient memory are not eligible (DEV1-S, PLAY2-PICO, STARDUST)
pools.{index}.node-type The node type is the type of Scaleway Instance wanted for the pool
[pools.{index}.placement-group-id] The placement group ID in which all the nodes of the pool will be created
[pools.{index}.autoscaling] The enablement of the autoscaling feature for the pool
pools.{index}.size The size (number of nodes) of the pool
[pools.{index}.min-size] The minimun size of the pool
[pools.{index}.min-size] The minimum size of the pool
[pools.{index}.max-size] The maximum size of the pool
[pools.{index}.container-runtime] The container runtime for the nodes of the pool (unknown_runtime | docker | containerd | crio)
[pools.{index}.autohealing] The enablement of the autohealing feature for the pool
Expand Down
4 changes: 2 additions & 2 deletions cmd/scw/testdata/test-all-usage-k8s-pool-create-usage.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,11 @@ EXAMPLES:
ARGS:
cluster-id The ID of the cluster in which the pool will be created
name=<generated> The name of the pool
node-type=DEV1-M The node type is the type of Scaleway Instance wanted for the pool, nodes with insufficient memory are not eligible (DEV1-S, PLAY2-PICO, STARDUST)
node-type=DEV1-M The node type is the type of Scaleway Instance wanted for the pool
[placement-group-id] The placement group ID in which all the nodes of the pool will be created
[autoscaling] The enablement of the autoscaling feature for the pool
size=1 The size (number of nodes) of the pool
[min-size] The minimun size of the pool
[min-size] The minimum size of the pool
[max-size] The maximum size of the pool
[container-runtime] The container runtime for the nodes of the pool (unknown_runtime | docker | containerd | crio)
[autohealing] The enablement of the autohealing feature for the pool
Expand Down
8 changes: 4 additions & 4 deletions docs/commands/k8s.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,11 +69,11 @@ scw k8s cluster create [arg=value ...]
| ~~enable-dashboard~~ | Deprecated | The enablement of the Kubernetes Dashboard in the cluster |
| ~~ingress~~ | Deprecated<br />One of: `unknown_ingress`, `none`, `nginx`, `traefik`, `traefik2` | The Ingress Controller that will run in the cluster |
| pools.{index}.name | Required | The name of the pool |
| pools.{index}.node-type | Required | The node type is the type of Scaleway Instance wanted for the pool, nodes with insufficient memory are not eligible (DEV1-S, PLAY2-PICO, STARDUST) |
| pools.{index}.node-type | Required | The node type is the type of Scaleway Instance wanted for the pool |
| pools.{index}.placement-group-id | | The placement group ID in which all the nodes of the pool will be created |
| pools.{index}.autoscaling | | The enablement of the autoscaling feature for the pool |
| pools.{index}.size | Required | The size (number of nodes) of the pool |
| pools.{index}.min-size | | The minimun size of the pool |
| pools.{index}.min-size | | The minimum size of the pool |
| pools.{index}.max-size | | The maximum size of the pool |
| pools.{index}.container-runtime | One of: `unknown_runtime`, `docker`, `containerd`, `crio` | The container runtime for the nodes of the pool |
| pools.{index}.autohealing | | The enablement of the autohealing feature for the pool |
Expand Down Expand Up @@ -760,11 +760,11 @@ scw k8s pool create [arg=value ...]
|------|---|-------------|
| cluster-id | Required | The ID of the cluster in which the pool will be created |
| name | Required<br />Default: `<generated>` | The name of the pool |
| node-type | Required<br />Default: `DEV1-M` | The node type is the type of Scaleway Instance wanted for the pool, nodes with insufficient memory are not eligible (DEV1-S, PLAY2-PICO, STARDUST) |
| node-type | Required<br />Default: `DEV1-M` | The node type is the type of Scaleway Instance wanted for the pool |
| placement-group-id | | The placement group ID in which all the nodes of the pool will be created |
| autoscaling | | The enablement of the autoscaling feature for the pool |
| size | Required<br />Default: `1` | The size (number of nodes) of the pool |
| min-size | | The minimun size of the pool |
| min-size | | The minimum size of the pool |
| max-size | | The maximum size of the pool |
| container-runtime | One of: `unknown_runtime`, `docker`, `containerd`, `crio` | The container runtime for the nodes of the pool |
| autohealing | | The enablement of the autohealing feature for the pool |
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 @@ -17,7 +17,7 @@ require (
github.com/kubernetes-client/go-base v0.0.0-20190205182333-3d0e39759d98
github.com/mattn/go-colorable v0.1.12
github.com/mattn/go-isatty v0.0.14
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.9.0.20220809090108-bececde68f13
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.9.0.20220816072201-5afd05101277
github.com/spf13/cobra v1.5.0
github.com/spf13/pflag v1.0.5
github.com/stretchr/testify v1.8.0
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 @@ -57,8 +57,8 @@ github.com/pkg/errors v0.8.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINE
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.9.0.20220809090108-bececde68f13 h1:0Bzup92mxJ766nIVxvSWlX7oJh27AA+mvfBsKDblitY=
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.9.0.20220809090108-bececde68f13/go.mod h1:fCa7OJZ/9DRTnOKmxvT6pn+LPWUptQAmHF/SBJUGEcg=
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.9.0.20220816072201-5afd05101277 h1:iVeMPuy5vjI8GzeazqxsW7tvjVo52HclSyJY0HTjbrE=
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.9.0.20220816072201-5afd05101277/go.mod h1:fCa7OJZ/9DRTnOKmxvT6pn+LPWUptQAmHF/SBJUGEcg=
github.com/sergi/go-diff v1.2.0 h1:XU+rvMAioB0UC3q1MFrIQy4Vo5/4VsRDQQXHsEya6xQ=
github.com/sergi/go-diff v1.2.0/go.mod h1:STckp+ISIX8hZLjrqAeVduY0gWCT9IjLuqbuNXdaHfM=
github.com/spf13/cobra v1.5.0 h1:X+jTBEBqF0bHN+9cSMgmfuvv2VHJ9ezmFNf9Y/XstYU=
Expand Down
8 changes: 4 additions & 4 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 @@ -310,7 +310,7 @@ func k8sClusterCreate() *core.Command {
},
{
Name: "pools.{index}.node-type",
Short: `The node type is the type of Scaleway Instance wanted for the pool, nodes with insufficient memory are not eligible (DEV1-S, PLAY2-PICO, STARDUST)`,
Short: `The node type is the type of Scaleway Instance wanted for the pool`,
Required: true,
Deprecated: false,
Positional: false,
Expand Down Expand Up @@ -338,7 +338,7 @@ func k8sClusterCreate() *core.Command {
},
{
Name: "pools.{index}.min-size",
Short: `The minimun size of the pool`,
Short: `The minimum size of the pool`,
Required: false,
Deprecated: false,
Positional: false,
Expand Down Expand Up @@ -1228,7 +1228,7 @@ func k8sPoolCreate() *core.Command {
},
{
Name: "node-type",
Short: `The node type is the type of Scaleway Instance wanted for the pool, nodes with insufficient memory are not eligible (DEV1-S, PLAY2-PICO, STARDUST)`,
Short: `The node type is the type of Scaleway Instance wanted for the pool`,
Required: true,
Deprecated: false,
Positional: false,
Expand Down Expand Up @@ -1256,7 +1256,7 @@ func k8sPoolCreate() *core.Command {
},
{
Name: "min-size",
Short: `The minimun size of the pool`,
Short: `The minimum size of the pool`,
Required: false,
Deprecated: false,
Positional: false,
Expand Down