docs(k8s): fix examples for pool (#1976)

scaleway-bot · remyleone · web-flow · commit 709d7cc1fe1c · 2021-10-07T18:46:19.000+02:00
Co-authored-by: Rémy Léone &lt;rleone@scaleway.com&gt;
diff --git a/cmd/scw/testdata/test-all-usage-k8s-pool-create-usage.golden b/cmd/scw/testdata/test-all-usage-k8s-pool-create-usage.golden
@@ -7,13 +7,13 @@ USAGE:
 
 EXAMPLES:
   Create a pool named bar with 2 DEV1-XL on a given cluster
-    scw k8s pool create 11111111-1111-1111-111111111111 name=bar node-type=DEV1-XL size=2
+    scw k8s pool create cluster-id=11111111-1111-1111-111111111111 name=bar node-type=DEV1-XL size=2
 
   Create a pool named fish with 5 GP1-L with autoscaling enabled within 0 and 10 nodes, autohealing enabled, and containerd as the container runtime on a given cluster
-    scw k8s pool create 11111111-1111-1111-111111111111 name=fish node-type=GP1-L size=5 min-size=0 max-size=10 autoscaling=true autohealing=true container-runtime=containerd
+    scw k8s pool create cluster-id=11111111-1111-1111-111111111111 name=fish node-type=GP1-L size=5 min-size=0 max-size=10 autoscaling=true autohealing=true container-runtime=containerd
 
   Create a tagged pool named turtle with 1 GP1-S which is using the already created placement group 2222222222222-2222-222222222222 for all the nodes in the pool on a given cluster
-    scw k8s pool create 11111111-1111-1111-111111111111 name=turtle node-type=GP1-S size=1 placement-group-id=2222222222222-2222-222222222222 tags.0=turtle tags.1=placement-group
+    scw k8s pool create cluster-id=11111111-1111-1111-111111111111 name=turtle node-type=GP1-S size=1 placement-group-id=2222222222222-2222-222222222222 tags.0=turtle tags.1=placement-group
 
 ARGS:
   cluster-id                         The ID of the cluster in which the pool will be created
diff --git a/cmd/scw/testdata/test-all-usage-k8s-pool-list-usage.golden b/cmd/scw/testdata/test-all-usage-k8s-pool-list-usage.golden
@@ -7,16 +7,16 @@ USAGE:
 
 EXAMPLES:
   List all pools for a given cluster
-    scw k8s pool list 11111111-1111-1111-111111111111
+    scw k8s pool list cluster-id=11111111-1111-1111-111111111111
 
   List all scaling pools for a given cluster
-    scw k8s pool list 11111111-1111-1111-111111111111 status=scaling
+    scw k8s pool list cluster-id=11111111-1111-1111-111111111111 status=scaling
 
   List all pools for a given cluster that contain the word foo in the pool name
-    scw k8s pool list 11111111-1111-1111-111111111111 name=foo
+    scw k8s pool list cluster-id=11111111-1111-1111-111111111111 name=foo
 
   List all pools for a given cluster and order them by ascending creation date
-    scw k8s pool list 11111111-1111-1111-111111111111 order-by=created_at_asc
+    scw k8s pool list cluster-id=11111111-1111-1111-111111111111 order-by=created_at_asc
 
 ARGS:
   cluster-id        The ID of the cluster from which the pools will be listed from
diff --git a/docs/commands/k8s.md b/docs/commands/k8s.md
@@ -736,17 +736,17 @@ scw k8s pool create [arg=value ...]
 
 Create a pool named bar with 2 DEV1-XL on a given cluster
 ```
-scw k8s pool create 11111111-1111-1111-111111111111 name=bar node-type=DEV1-XL size=2
+scw k8s pool create cluster-id=11111111-1111-1111-111111111111 name=bar node-type=DEV1-XL size=2
 ```
 
 Create a pool named fish with 5 GP1-L with autoscaling enabled within 0 and 10 nodes, autohealing enabled, and containerd as the container runtime on a given cluster
 ```
-scw k8s pool create 11111111-1111-1111-111111111111 name=fish node-type=GP1-L size=5 min-size=0 max-size=10 autoscaling=true autohealing=true container-runtime=containerd
+scw k8s pool create cluster-id=11111111-1111-1111-111111111111 name=fish node-type=GP1-L size=5 min-size=0 max-size=10 autoscaling=true autohealing=true container-runtime=containerd
 ```
 
 Create a tagged pool named turtle with 1 GP1-S which is using the already created placement group 2222222222222-2222-222222222222 for all the nodes in the pool on a given cluster
 ```
-scw k8s pool create 11111111-1111-1111-111111111111 name=turtle node-type=GP1-S size=1 placement-group-id=2222222222222-2222-222222222222 tags.0=turtle tags.1=placement-group
+scw k8s pool create cluster-id=11111111-1111-1111-111111111111 name=turtle node-type=GP1-S size=1 placement-group-id=2222222222222-2222-222222222222 tags.0=turtle tags.1=placement-group
 ```
 
 
@@ -839,22 +839,22 @@ scw k8s pool list [arg=value ...]
 
 List all pools for a given cluster
 ```
-scw k8s pool list 11111111-1111-1111-111111111111
+scw k8s pool list cluster-id=11111111-1111-1111-111111111111
 ```
 
 List all scaling pools for a given cluster
 ```
-scw k8s pool list 11111111-1111-1111-111111111111 status=scaling
+scw k8s pool list cluster-id=11111111-1111-1111-111111111111 status=scaling
 ```
 
 List all pools for a given cluster that contain the word foo in the pool name
 ```
-scw k8s pool list 11111111-1111-1111-111111111111 name=foo
+scw k8s pool list cluster-id=11111111-1111-1111-111111111111 name=foo
 ```
 
 List all pools for a given cluster and order them by ascending creation date
 ```
-scw k8s pool list 11111111-1111-1111-111111111111 order-by=created_at_asc
+scw k8s pool list cluster-id=11111111-1111-1111-111111111111 order-by=created_at_asc
 ```
 
 
diff --git a/internal/namespaces/k8s/v1/k8s_cli.go b/internal/namespaces/k8s/v1/k8s_cli.go
@@ -1108,19 +1108,19 @@ func k8sPoolList() *core.Command {
 		Examples: []*core.Example{
 			{
 				Short: "List all pools for a given cluster",
-				Raw:   `scw k8s pool list 11111111-1111-1111-111111111111`,
+				Raw:   `scw k8s pool list cluster-id=11111111-1111-1111-111111111111`,
 			},
 			{
 				Short: "List all scaling pools for a given cluster",
-				Raw:   `scw k8s pool list 11111111-1111-1111-111111111111 status=scaling`,
+				Raw:   `scw k8s pool list cluster-id=11111111-1111-1111-111111111111 status=scaling`,
 			},
 			{
 				Short: "List all pools for a given cluster that contain the word foo in the pool name",
-				Raw:   `scw k8s pool list 11111111-1111-1111-111111111111 name=foo`,
+				Raw:   `scw k8s pool list cluster-id=11111111-1111-1111-111111111111 name=foo`,
 			},
 			{
 				Short: "List all pools for a given cluster and order them by ascending creation date",
-				Raw:   `scw k8s pool list 11111111-1111-1111-111111111111 order-by=created_at_asc`,
+				Raw:   `scw k8s pool list cluster-id=11111111-1111-1111-111111111111 order-by=created_at_asc`,
 			},
 		},
 		View: &core.View{Fields: []*core.ViewField{
@@ -1312,15 +1312,15 @@ func k8sPoolCreate() *core.Command {
 		Examples: []*core.Example{
 			{
 				Short: "Create a pool named bar with 2 DEV1-XL on a given cluster",
-				Raw:   `scw k8s pool create 11111111-1111-1111-111111111111 name=bar node-type=DEV1-XL size=2`,
+				Raw:   `scw k8s pool create cluster-id=11111111-1111-1111-111111111111 name=bar node-type=DEV1-XL size=2`,
 			},
 			{
 				Short: "Create a pool named fish with 5 GP1-L with autoscaling enabled within 0 and 10 nodes, autohealing enabled, and containerd as the container runtime on a given cluster",
-				Raw:   `scw k8s pool create 11111111-1111-1111-111111111111 name=fish node-type=GP1-L size=5 min-size=0 max-size=10 autoscaling=true autohealing=true container-runtime=containerd`,
+				Raw:   `scw k8s pool create cluster-id=11111111-1111-1111-111111111111 name=fish node-type=GP1-L size=5 min-size=0 max-size=10 autoscaling=true autohealing=true container-runtime=containerd`,
 			},
 			{
 				Short: "Create a tagged pool named turtle with 1 GP1-S which is using the already created placement group 2222222222222-2222-222222222222 for all the nodes in the pool on a given cluster",
-				Raw:   `scw k8s pool create 11111111-1111-1111-111111111111 name=turtle node-type=GP1-S size=1 placement-group-id=2222222222222-2222-222222222222 tags.0=turtle tags.1=placement-group`,
+				Raw:   `scw k8s pool create cluster-id=11111111-1111-1111-111111111111 name=turtle node-type=GP1-S size=1 placement-group-id=2222222222222-2222-222222222222 tags.0=turtle tags.1=placement-group`,
 			},
 		},
 	}

Original file line number	Diff line number	Diff line change
`@@ -1108,19 +1108,19 @@ func k8sPoolList() *core.Command {`
`1108`	`1108`	`Examples: []*core.Example{`
`1109`	`1109`	`{`
`1110`	`1110`	`Short: "List all pools for a given cluster",`
`1111`		- Raw: `scw k8s pool list 11111111-1111-1111-111111111111`,
	`1111`	+ Raw: `scw k8s pool list cluster-id=11111111-1111-1111-111111111111`,
`1112`	`1112`	`},`
`1113`	`1113`	`{`
`1114`	`1114`	`Short: "List all scaling pools for a given cluster",`
`1115`		- Raw: `scw k8s pool list 11111111-1111-1111-111111111111 status=scaling`,
	`1115`	+ Raw: `scw k8s pool list cluster-id=11111111-1111-1111-111111111111 status=scaling`,
`1116`	`1116`	`},`
`1117`	`1117`	`{`
`1118`	`1118`	`Short: "List all pools for a given cluster that contain the word foo in the pool name",`
`1119`		- Raw: `scw k8s pool list 11111111-1111-1111-111111111111 name=foo`,
	`1119`	+ Raw: `scw k8s pool list cluster-id=11111111-1111-1111-111111111111 name=foo`,
`1120`	`1120`	`},`
`1121`	`1121`	`{`
`1122`	`1122`	`Short: "List all pools for a given cluster and order them by ascending creation date",`
`1123`		- Raw: `scw k8s pool list 11111111-1111-1111-111111111111 order-by=created_at_asc`,
	`1123`	+ Raw: `scw k8s pool list cluster-id=11111111-1111-1111-111111111111 order-by=created_at_asc`,
`1124`	`1124`	`},`
`1125`	`1125`	`},`
`1126`	`1126`	`View: &core.View{Fields: []*core.ViewField{`
`@@ -1312,15 +1312,15 @@ func k8sPoolCreate() *core.Command {`
`1312`	`1312`	`Examples: []*core.Example{`
`1313`	`1313`	`{`
`1314`	`1314`	`Short: "Create a pool named bar with 2 DEV1-XL on a given cluster",`
`1315`		- Raw: `scw k8s pool create 11111111-1111-1111-111111111111 name=bar node-type=DEV1-XL size=2`,
	`1315`	+ Raw: `scw k8s pool create cluster-id=11111111-1111-1111-111111111111 name=bar node-type=DEV1-XL size=2`,
`1316`	`1316`	`},`
`1317`	`1317`	`{`
`1318`	`1318`	`Short: "Create a pool named fish with 5 GP1-L with autoscaling enabled within 0 and 10 nodes, autohealing enabled, and containerd as the container runtime on a given cluster",`
`1319`		- Raw: `scw k8s pool create 11111111-1111-1111-111111111111 name=fish node-type=GP1-L size=5 min-size=0 max-size=10 autoscaling=true autohealing=true container-runtime=containerd`,
	`1319`	+ Raw: `scw k8s pool create cluster-id=11111111-1111-1111-111111111111 name=fish node-type=GP1-L size=5 min-size=0 max-size=10 autoscaling=true autohealing=true container-runtime=containerd`,
`1320`	`1320`	`},`
`1321`	`1321`	`{`
`1322`	`1322`	`Short: "Create a tagged pool named turtle with 1 GP1-S which is using the already created placement group 2222222222222-2222-222222222222 for all the nodes in the pool on a given cluster",`
`1323`		- Raw: `scw k8s pool create 11111111-1111-1111-111111111111 name=turtle node-type=GP1-S size=1 placement-group-id=2222222222222-2222-222222222222 tags.0=turtle tags.1=placement-group`,
	`1323`	+ Raw: `scw k8s pool create cluster-id=11111111-1111-1111-111111111111 name=turtle node-type=GP1-S size=1 placement-group-id=2222222222222-2222-222222222222 tags.0=turtle tags.1=placement-group`,
`1324`	`1324`	`},`
`1325`	`1325`	`},`
`1326`	`1326`	`}`