Skip to content

Commit 8bf6721

Browse files
docs(k8s): update node-type description and fix typo (#2452)
Co-authored-by: Jules Castéran <jcasteran@scaleway.com>
1 parent 028f299 commit 8bf6721

File tree

6 files changed

+15
-15
lines changed

6 files changed

+15
-15
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,11 @@ ARGS:
2121
version=latest The Kubernetes version of the cluster
2222
cni=cilium The Container Network Interface (CNI) plugin that will run in the cluster (unknown_cni | cilium | calico | weave | flannel | kilo)
2323
pools.{index}.name The name of the pool
24-
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)
24+
pools.{index}.node-type The node type is the type of Scaleway Instance wanted for the pool
2525
[pools.{index}.placement-group-id] The placement group ID in which all the nodes of the pool will be created
2626
[pools.{index}.autoscaling] The enablement of the autoscaling feature for the pool
2727
pools.{index}.size The size (number of nodes) of the pool
28-
[pools.{index}.min-size] The minimun size of the pool
28+
[pools.{index}.min-size] The minimum size of the pool
2929
[pools.{index}.max-size] The maximum size of the pool
3030
[pools.{index}.container-runtime] The container runtime for the nodes of the pool (unknown_runtime | docker | containerd | crio)
3131
[pools.{index}.autohealing] The enablement of the autohealing feature for the pool

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@ EXAMPLES:
1818
ARGS:
1919
cluster-id The ID of the cluster in which the pool will be created
2020
name=<generated> The name of the pool
21-
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)
21+
node-type=DEV1-M The node type is the type of Scaleway Instance wanted for the pool
2222
[placement-group-id] The placement group ID in which all the nodes of the pool will be created
2323
[autoscaling] The enablement of the autoscaling feature for the pool
2424
size=1 The size (number of nodes) of the pool
25-
[min-size] The minimun size of the pool
25+
[min-size] The minimum size of the pool
2626
[max-size] The maximum size of the pool
2727
[container-runtime] The container runtime for the nodes of the pool (unknown_runtime | docker | containerd | crio)
2828
[autohealing] The enablement of the autohealing feature for the pool

docs/commands/k8s.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -69,11 +69,11 @@ scw k8s cluster create [arg=value ...]
6969
| ~~enable-dashboard~~ | Deprecated | The enablement of the Kubernetes Dashboard in the cluster |
7070
| ~~ingress~~ | Deprecated<br />One of: `unknown_ingress`, `none`, `nginx`, `traefik`, `traefik2` | The Ingress Controller that will run in the cluster |
7171
| pools.{index}.name | Required | The name of the pool |
72-
| 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) |
72+
| pools.{index}.node-type | Required | The node type is the type of Scaleway Instance wanted for the pool |
7373
| pools.{index}.placement-group-id | | The placement group ID in which all the nodes of the pool will be created |
7474
| pools.{index}.autoscaling | | The enablement of the autoscaling feature for the pool |
7575
| pools.{index}.size | Required | The size (number of nodes) of the pool |
76-
| pools.{index}.min-size | | The minimun size of the pool |
76+
| pools.{index}.min-size | | The minimum size of the pool |
7777
| pools.{index}.max-size | | The maximum size of the pool |
7878
| pools.{index}.container-runtime | One of: `unknown_runtime`, `docker`, `containerd`, `crio` | The container runtime for the nodes of the pool |
7979
| pools.{index}.autohealing | | The enablement of the autohealing feature for the pool |
@@ -760,11 +760,11 @@ scw k8s pool create [arg=value ...]
760760
|------|---|-------------|
761761
| cluster-id | Required | The ID of the cluster in which the pool will be created |
762762
| name | Required<br />Default: `<generated>` | The name of the pool |
763-
| 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) |
763+
| node-type | Required<br />Default: `DEV1-M` | The node type is the type of Scaleway Instance wanted for the pool |
764764
| placement-group-id | | The placement group ID in which all the nodes of the pool will be created |
765765
| autoscaling | | The enablement of the autoscaling feature for the pool |
766766
| size | Required<br />Default: `1` | The size (number of nodes) of the pool |
767-
| min-size | | The minimun size of the pool |
767+
| min-size | | The minimum size of the pool |
768768
| max-size | | The maximum size of the pool |
769769
| container-runtime | One of: `unknown_runtime`, `docker`, `containerd`, `crio` | The container runtime for the nodes of the pool |
770770
| autohealing | | The enablement of the autohealing feature for the pool |

go.mod

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ require (
1717
github.com/kubernetes-client/go-base v0.0.0-20190205182333-3d0e39759d98
1818
github.com/mattn/go-colorable v0.1.12
1919
github.com/mattn/go-isatty v0.0.14
20-
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.9.0.20220809090108-bececde68f13
20+
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.9.0.20220816072201-5afd05101277
2121
github.com/spf13/cobra v1.5.0
2222
github.com/spf13/pflag v1.0.5
2323
github.com/stretchr/testify v1.8.0

go.sum

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,8 @@ github.com/pkg/errors v0.8.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINE
5757
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
5858
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
5959
github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
60-
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.9.0.20220809090108-bececde68f13 h1:0Bzup92mxJ766nIVxvSWlX7oJh27AA+mvfBsKDblitY=
61-
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.9.0.20220809090108-bececde68f13/go.mod h1:fCa7OJZ/9DRTnOKmxvT6pn+LPWUptQAmHF/SBJUGEcg=
60+
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.9.0.20220816072201-5afd05101277 h1:iVeMPuy5vjI8GzeazqxsW7tvjVo52HclSyJY0HTjbrE=
61+
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.9.0.20220816072201-5afd05101277/go.mod h1:fCa7OJZ/9DRTnOKmxvT6pn+LPWUptQAmHF/SBJUGEcg=
6262
github.com/sergi/go-diff v1.2.0 h1:XU+rvMAioB0UC3q1MFrIQy4Vo5/4VsRDQQXHsEya6xQ=
6363
github.com/sergi/go-diff v1.2.0/go.mod h1:STckp+ISIX8hZLjrqAeVduY0gWCT9IjLuqbuNXdaHfM=
6464
github.com/spf13/cobra v1.5.0 h1:X+jTBEBqF0bHN+9cSMgmfuvv2VHJ9ezmFNf9Y/XstYU=

internal/namespaces/k8s/v1/k8s_cli.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -310,7 +310,7 @@ func k8sClusterCreate() *core.Command {
310310
},
311311
{
312312
Name: "pools.{index}.node-type",
313-
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)`,
313+
Short: `The node type is the type of Scaleway Instance wanted for the pool`,
314314
Required: true,
315315
Deprecated: false,
316316
Positional: false,
@@ -338,7 +338,7 @@ func k8sClusterCreate() *core.Command {
338338
},
339339
{
340340
Name: "pools.{index}.min-size",
341-
Short: `The minimun size of the pool`,
341+
Short: `The minimum size of the pool`,
342342
Required: false,
343343
Deprecated: false,
344344
Positional: false,
@@ -1228,7 +1228,7 @@ func k8sPoolCreate() *core.Command {
12281228
},
12291229
{
12301230
Name: "node-type",
1231-
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)`,
1231+
Short: `The node type is the type of Scaleway Instance wanted for the pool`,
12321232
Required: true,
12331233
Deprecated: false,
12341234
Positional: false,
@@ -1256,7 +1256,7 @@ func k8sPoolCreate() *core.Command {
12561256
},
12571257
{
12581258
Name: "min-size",
1259-
Short: `The minimun size of the pool`,
1259+
Short: `The minimum size of the pool`,
12601260
Required: false,
12611261
Deprecated: false,
12621262
Positional: false,

0 commit comments

Comments
 (0)