feat(k8s): add taints and labels management

Author: jtherin

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

@@ -7,16 +7,26 @@ USAGE:
   scw k8s pool <command>
 
 AVAILABLE COMMANDS:
-  add-external-node Add an external node to a Kosmos Pool
-  create            Create a new Pool in a Cluster
-  delete            Delete a Pool in a Cluster
-  get               Get a Pool in a Cluster
-  list              List Pools in a Cluster
-  update            Update a Pool in a Cluster
-  upgrade           Upgrade a Pool in a Cluster
+  add-external-node    Add an external node to a Kosmos Pool
+  create               Create a new Pool in a Cluster
+  delete               Delete a Pool in a Cluster
+  get                  Get a Pool in a Cluster
+  list                 List Pools in a Cluster
+  update               Update a Pool in a Cluster
+  upgrade              Upgrade a Pool in a Cluster
+
+LABEL COMMANDS:
+  remove-label         Remove a label from a Pool
+  set-label            Add or edit a taint to a Pool
+
+TAINT COMMANDS:
+  remove-startup-taint Remove a startup taint from a Pool
+  remove-taint         Remove a taint from a Pool
+  set-startup-taint    Add or edit a startup taint to a Pool
+  set-taint            Add or edit a taint to a Pool
 
 WORKFLOW COMMANDS:
-  wait              Wait for a pool to reach a stable state
+  wait                 Wait for a pool to reach a stable state
 
 FLAGS:
   -h, --help                help for pool

docs/commands/k8s.md

@@ -38,6 +38,12 @@ This API allows you to manage Kubernetes Kapsule and Kosmos clusters.
   - [Delete a Pool in a Cluster](#delete-a-pool-in-a-cluster)
   - [Get a Pool in a Cluster](#get-a-pool-in-a-cluster)
   - [List Pools in a Cluster](#list-pools-in-a-cluster)
+  - [Remove a label from a Pool](#remove-a-label-from-a-pool)
+  - [Remove a startup taint from a Pool](#remove-a-startup-taint-from-a-pool)
+  - [Remove a taint from a Pool](#remove-a-taint-from-a-pool)
+  - [Add or edit a taint to a Pool](#add-or-edit-a-taint-to-a-pool)
+  - [Add or edit a startup taint to a Pool](#add-or-edit-a-startup-taint-to-a-pool)
+  - [Add or edit a taint to a Pool](#add-or-edit-a-taint-to-a-pool)
   - [Update a Pool in a Cluster](#update-a-pool-in-a-cluster)
   - [Upgrade a Pool in a Cluster](#upgrade-a-pool-in-a-cluster)
   - [Wait for a pool to reach a stable state](#wait-for-a-pool-to-reach-a-stable-state)
@@ -1160,6 +1166,212 @@ scw k8s pool list cluster-id=11111111-1111-1111-1111-111111111111 order-by=creat
 
 
 
+### Remove a label from a Pool
+
+Remove a label from all nodes of the pool (only apply to labels which was set through scaleway api).
+
+**Usage:**
+
+```
+scw k8s pool remove-label <pool-id ...> [arg=value ...]
+```
+
+
+**Args:**
+
+| Name |   | Description |
+|------|---|-------------|
+| pool-id | Required | ID of the pool. |
+| key | Required | Key of the label. |
+| region | Default: `fr-par` | Region to target. If none is passed will use default region from the config |
+
+
+**Examples:**
+
+
+Remove a label of a specific pool
+```
+scw k8s pool remove-label 11111111-1111-1111-1111-111111111111 key=foo
+```
+
+
+
+
+### Remove a startup taint from a Pool
+
+New nodes will not have this taint at startup (does not remove taints from kubernetes side).
+
+**Usage:**
+
+```
+scw k8s pool remove-startup-taint <pool-id ...> [arg=value ...]
+```
+
+
+**Args:**
+
+| Name |   | Description |
+|------|---|-------------|
+| pool-id | Required | ID of the pool. |
+| key | Required | Key of the taint. |
+| region | Default: `fr-par` | Region to target. If none is passed will use default region from the config |
+
+
+**Examples:**
+
+
+Remove a startup taint of a specific pool
+```
+scw k8s pool remove-startup-taint 11111111-1111-1111-1111-111111111111 key=foo
+```
+
+
+
+
+### Remove a taint from a Pool
+
+Remove a taint from all all nodes of the pool (only apply to taints which was set through scaleway api).
+
+**Usage:**
+
+```
+scw k8s pool remove-taint <pool-id ...> [arg=value ...]
+```
+
+
+**Args:**
+
+| Name |   | Description |
+|------|---|-------------|
+| pool-id | Required | ID of the pool. |
+| key | Required | Key of the taint. |
+| region | Default: `fr-par` | Region to target. If none is passed will use default region from the config |
+
+
+**Examples:**
+
+
+Remove a taint to a specific pool
+```
+scw k8s pool remove-taint 11111111-1111-1111-1111-111111111111 key=foo
+```
+
+
+
+
+### Add or edit a taint to a Pool
+
+Apply a label to all nodes of the pool which will be periodically reconciled by scaleway.
+
+**Usage:**
+
+```
+scw k8s pool set-label <pool-id ...> [arg=value ...]
+```
+
+
+**Args:**
+
+| Name |   | Description |
+|------|---|-------------|
+| pool-id | Required | ID of the pool. |
+| key | Required | Key of the label. |
+| value | Required | Value of the label. |
+| region | Default: `fr-par` | Region to target. If none is passed will use default region from the config |
+
+
+**Examples:**
+
+
+Apply a label to a specific pool
+```
+scw k8s pool set-label 11111111-1111-1111-1111-111111111111 key=foo value=bar
+```
+
+Apply a full label to a specific pool
+```
+scw k8s pool set-label 11111111-1111-1111-1111-111111111111 key=organization.example/gpu value=true
+```
+
+
+
+
+### Add or edit a startup taint to a Pool
+
+Apply a taint at node creation but does not reconcile after.
+
+**Usage:**
+
+```
+scw k8s pool set-startup-taint <pool-id ...> [arg=value ...]
+```
+
+
+**Args:**
+
+| Name |   | Description |
+|------|---|-------------|
+| pool-id | Required | ID of the pool. |
+| key | Required | Key of the taint. |
+| value | Required | Value of the taint. |
+| effect | Required<br />One of: `NoSchedule`, `PreferNoSchedule`, `NoExecute` | Effect of the taint. |
+| region | Default: `fr-par` | Region to target. If none is passed will use default region from the config |
+
+
+**Examples:**
+
+
+Apply a startup taint to a specific pool
+```
+scw k8s pool set-startup-taint 11111111-1111-1111-1111-111111111111 key=foo value=bar effect=NoSchedule
+```
+
+Apply a full startup taint to a specific pool
+```
+scw k8s pool set-startup-taint 11111111-1111-1111-1111-111111111111 key=organization.example/gpu value=true effect=NoSchedule
+```
+
+
+
+
+### Add or edit a taint to a Pool
+
+Apply a taint to all nodes of the pool which will be periodically reconciled by scaleway.
+
+**Usage:**
+
+```
+scw k8s pool set-taint <pool-id ...> [arg=value ...]
+```
+
+
+**Args:**
+
+| Name |   | Description |
+|------|---|-------------|
+| pool-id | Required | ID of the pool. |
+| key | Required | Key of the taint. |
+| value | Required | Value of the taint. |
+| effect | Required<br />One of: `NoSchedule`, `PreferNoSchedule`, `NoExecute` | Effect of the taint. |
+| region | Default: `fr-par` | Region to target. If none is passed will use default region from the config |
+
+
+**Examples:**
+
+
+Apply a taint to a specific pool
+```
+scw k8s pool set-taint 11111111-1111-1111-1111-111111111111 key=foo value=bar effect=NoSchedule
+```
+
+Apply a full taint to a specific pool
+```
+scw k8s pool set-taint 11111111-1111-1111-1111-111111111111 key=organization.example/gpu value=true effect=NoSchedule
+```
+
+
+
+
 ### Update a Pool in a Cluster
 
 Update the attributes of a specific pool, such as its desired size, autoscaling settings, and tags. To upgrade a pool, you will need to use the dedicated endpoint.

internal/namespaces/k8s/v1/custom.go

@@ -31,10 +31,17 @@ func GetCommands() *core.Commands {
 		k8sNodeWaitCommand(),
 		k8sPoolWaitCommand(),
 		k8sPoolAddExternalNodeCommand(),
+		k8sPoolSetTaintCommand(),
+		k8sPoolRemoveTaintCommand(),
+		k8sPoolSetStartupTaintCommand(),
+		k8sPoolRemoveStartupTaintCommand(),
+		k8sPoolSetLabelCommand(),
+		k8sPoolRemoveLabelCommand(),
 	))
 
 	human.RegisterMarshalerFunc(k8s.Version{}, versionMarshalerFunc)
 	human.RegisterMarshalerFunc(k8s.Cluster{}, clusterMarshalerFunc)
+	human.RegisterMarshalerFunc(k8s.Pool{}, poolMarshalerFunc)
 	human.RegisterMarshalerFunc(
 		k8s.ClusterStatus(""),
 		human.EnumMarshalFunc(clusterStatusMarshalSpecs),

internal/namespaces/k8s/v1/custom_pool.go

@@ -44,6 +44,39 @@ const (
 	poolActionDelete
 )
 
+func poolMarshalerFunc(i any, opt *human.MarshalOpt) (string, error) {
+	type humanPool k8s.Pool
+	pool := humanPool(i.(k8s.Pool))
+
+	// Sections
+	opt.Sections = []*human.MarshalSection{
+		{
+			FieldName: "UpgradePolicy",
+			Title:     "Upgrade Policy",
+		},
+		{
+			FieldName: "Labels",
+			Title:     "Node labels",
+		},
+		{
+			FieldName: "Taints",
+			Title:     "Node taints",
+		},
+
+		{
+			FieldName: "StartupTaints",
+			Title:     "Node startup taints",
+		},
+	}
+
+	str, err := human.Marshal(pool, opt)
+	if err != nil {
+		return "", err
+	}
+
+	return str, nil
+}
+
 func poolCreateBuilder(c *core.Command) *core.Command {
 	c.WaitFunc = waitForPoolFunc(poolActionCreate)