Label tasks and clusters

docs/source/sctool/partials/sctool_backup.yaml

@@ -70,6 +70,15 @@ options:
         Patterns are evaluated from left to right.
         If a pattern starts with '!' it unselects items that were selected by previous patterns i.e. 'a?,!aa' selects *ab* but not *aa*.
 
+    - name: label
+      usage: |
+        A comma-separated list of label modifications. Labels are represented as a key-value store.
+        Character '=' has a special meaning and cannot be a part of label's key nor value.
+        A single modification takes form of:
+        * '<key>=<value>' - sets the label <key> to <value>
+        * '<key>-'        - removes the label
+
+        For example, '--label k1=v1,k2-' will set the label 'k1' to 'v1' and will also remove label 'k2'.
     - name: location
       shorthand: L
       default_value: '[]'
@@ -80,7 +89,7 @@ options:
         The 'bucket' parameter is a bucket name, it must be an alphanumeric string and **may contain a dash and or a dot, but other characters are forbidden**.
     - name: name
       usage: |
-        Task name that can be used insead of ID.
+        Task name that can be used instead of ID.
     - name: num-retries
       shorthand: r
       default_value: "3"

docs/source/sctool/partials/sctool_backup_update.yaml

@@ -71,6 +71,15 @@ options:
         Patterns are evaluated from left to right.
         If a pattern starts with '!' it unselects items that were selected by previous patterns i.e. 'a?,!aa' selects *ab* but not *aa*.
 
+    - name: label
+      usage: |
+        A comma-separated list of label modifications. Labels are represented as a key-value store.
+        Character '=' has a special meaning and cannot be a part of label's key nor value.
+        A single modification takes form of:
+        * '<key>=<value>' - sets the label <key> to <value>
+        * '<key>-'        - removes the label
+
+        For example, '--label k1=v1,k2-' will set the label 'k1' to 'v1' and will also remove label 'k2'.
     - name: location
       shorthand: L
       default_value: '[]'
@@ -81,7 +90,7 @@ options:
         The 'bucket' parameter is a bucket name, it must be an alphanumeric string and **may contain a dash and or a dot, but other characters are forbidden**.
     - name: name
       usage: |
-        Task name that can be used insead of ID.
+        Task name that can be used instead of ID.
     - name: num-retries
       shorthand: r
       default_value: "3"

docs/source/sctool/partials/sctool_backup_validate.yaml

@@ -44,6 +44,15 @@ options:
 
         The task run date is aligned with '--start date' value.
         For example, if you select '--interval 7d' task would run weekly at the '--start-date' time.
+    - name: label
+      usage: |
+        A comma-separated list of label modifications. Labels are represented as a key-value store.
+        Character '=' has a special meaning and cannot be a part of label's key nor value.
+        A single modification takes form of:
+        * '<key>=<value>' - sets the label <key> to <value>
+        * '<key>-'        - removes the label
+
+        For example, '--label k1=v1,k2-' will set the label 'k1' to 'v1' and will also remove label 'k2'.
     - name: location
       shorthand: L
       default_value: '[]'
@@ -54,7 +63,7 @@ options:
         The 'bucket' parameter is a bucket name, it must be an alphanumeric string and **may contain a dash and or a dot, but other characters are forbidden**.
     - name: name
       usage: |
-        Task name that can be used insead of ID.
+        Task name that can be used instead of ID.
     - name: num-retries
       shorthand: r
       default_value: "3"

docs/source/sctool/partials/sctool_backup_validate_update.yaml

@@ -41,6 +41,15 @@ options:
 
         The task run date is aligned with '--start date' value.
         For example, if you select '--interval 7d' task would run weekly at the '--start-date' time.
+    - name: label
+      usage: |
+        A comma-separated list of label modifications. Labels are represented as a key-value store.
+        Character '=' has a special meaning and cannot be a part of label's key nor value.
+        A single modification takes form of:
+        * '<key>=<value>' - sets the label <key> to <value>
+        * '<key>-'        - removes the label
+
+        For example, '--label k1=v1,k2-' will set the label 'k1' to 'v1' and will also remove label 'k2'.
     - name: location
       shorthand: L
       default_value: '[]'
@@ -51,7 +60,7 @@ options:
         The 'bucket' parameter is a bucket name, it must be an alphanumeric string and **may contain a dash and or a dot, but other characters are forbidden**.
     - name: name
       usage: |
-        Task name that can be used insead of ID.
+        Task name that can be used instead of ID.
     - name: num-retries
       shorthand: r
       default_value: "3"

docs/source/sctool/partials/sctool_cluster_add.yaml

@@ -31,6 +31,15 @@ options:
       shorthand: i
       usage: |
         Explicitly specify cluster ID, when not provided random `UUID` will be generated.
+    - name: label
+      usage: |
+        A comma-separated list of label modifications. Labels are represented as a key-value store.
+        Character '=' has a special meaning and cannot be a part of label's key nor value.
+        A single modification takes form of:
+        * '<key>=<value>' - sets the label <key> to <value>
+        * '<key>-'        - removes the label
+
+        For example, '--label k1=v1,k2-' will set the label 'k1' to 'v1' and will also remove label 'k2'.
     - name: name
       shorthand: "n"
       usage: |

docs/source/sctool/partials/sctool_cluster_update.yaml

@@ -36,6 +36,15 @@ options:
         Hostname or `IP` of the node that will be used to discover other nodes belonging to the cluster.
         Note that this will be persisted and used every time Scylla Manager starts.
         You can use either an IPv4 or IPv6 address.
+    - name: label
+      usage: |
+        A comma-separated list of label modifications. Labels are represented as a key-value store.
+        Character '=' has a special meaning and cannot be a part of label's key nor value.
+        A single modification takes form of:
+        * '<key>=<value>' - sets the label <key> to <value>
+        * '<key>-'        - removes the label
+
+        For example, '--label k1=v1,k2-' will set the label 'k1' to 'v1' and will also remove label 'k2'.
     - name: name
       shorthand: "n"
       usage: |

docs/source/sctool/partials/sctool_repair.yaml

@@ -94,9 +94,18 @@ options:
         Patterns are evaluated from left to right.
         If a pattern starts with '!' it unselects items that were selected by previous patterns i.e. 'a?,!aa' selects *ab* but not *aa*.
 
+    - name: label
+      usage: |
+        A comma-separated list of label modifications. Labels are represented as a key-value store.
+        Character '=' has a special meaning and cannot be a part of label's key nor value.
+        A single modification takes form of:
+        * '<key>=<value>' - sets the label <key> to <value>
+        * '<key>-'        - removes the label
+
+        For example, '--label k1=v1,k2-' will set the label 'k1' to 'v1' and will also remove label 'k2'.
     - name: name
       usage: |
-        Task name that can be used insead of ID.
+        Task name that can be used instead of ID.
     - name: num-retries
       shorthand: r
       default_value: "3"

docs/source/sctool/partials/sctool_repair_update.yaml

@@ -95,9 +95,18 @@ options:
         Patterns are evaluated from left to right.
         If a pattern starts with '!' it unselects items that were selected by previous patterns i.e. 'a?,!aa' selects *ab* but not *aa*.
 
+    - name: label
+      usage: |
+        A comma-separated list of label modifications. Labels are represented as a key-value store.
+        Character '=' has a special meaning and cannot be a part of label's key nor value.
+        A single modification takes form of:
+        * '<key>=<value>' - sets the label <key> to <value>
+        * '<key>-'        - removes the label
+
+        For example, '--label k1=v1,k2-' will set the label 'k1' to 'v1' and will also remove label 'k2'.
     - name: name
       usage: |
-        Task name that can be used insead of ID.
+        Task name that can be used instead of ID.
     - name: num-retries
       shorthand: r
       default_value: "3"

docs/source/sctool/partials/sctool_restore.yaml

@@ -65,6 +65,15 @@ options:
         Patterns are evaluated from left to right.
         If a pattern starts with '!' it unselects items that were selected by previous patterns i.e. 'a?,!aa' selects *ab* but not *aa*.
 
+    - name: label
+      usage: |
+        A comma-separated list of label modifications. Labels are represented as a key-value store.
+        Character '=' has a special meaning and cannot be a part of label's key nor value.
+        A single modification takes form of:
+        * '<key>=<value>' - sets the label <key> to <value>
+        * '<key>-'        - removes the label
+
+        For example, '--label k1=v1,k2-' will set the label 'k1' to 'v1' and will also remove label 'k2'.
     - name: location
       shorthand: L
       default_value: '[]'
@@ -81,7 +90,7 @@ options:
         The `<bucket>` parameter is a bucket name, it must be an alphanumeric string and **may contain a dash and or a dot, but other characters are forbidden**.
     - name: name
       usage: |
-        Task name that can be used insead of ID.
+        Task name that can be used instead of ID.
     - name: num-retries
       shorthand: r
       default_value: "3"

docs/source/sctool/partials/sctool_restore_update.yaml

@@ -63,6 +63,15 @@ options:
         Patterns are evaluated from left to right.
         If a pattern starts with '!' it unselects items that were selected by previous patterns i.e. 'a?,!aa' selects *ab* but not *aa*.
 
+    - name: label
+      usage: |
+        A comma-separated list of label modifications. Labels are represented as a key-value store.
+        Character '=' has a special meaning and cannot be a part of label's key nor value.
+        A single modification takes form of:
+        * '<key>=<value>' - sets the label <key> to <value>
+        * '<key>-'        - removes the label
+
+        For example, '--label k1=v1,k2-' will set the label 'k1' to 'v1' and will also remove label 'k2'.
     - name: location
       shorthand: L
       default_value: '[]'
@@ -79,7 +88,7 @@ options:
         The `<bucket>` parameter is a bucket name, it must be an alphanumeric string and **may contain a dash and or a dot, but other characters are forbidden**.
     - name: name
       usage: |
-        Task name that can be used insead of ID.
+        Task name that can be used instead of ID.
     - name: num-retries
       shorthand: r
       default_value: "3"

docs/source/sctool/partials/sctool_suspend.yaml

@@ -47,9 +47,18 @@ options:
 
         The task run date is aligned with '--start date' value.
         For example, if you select '--interval 7d' task would run weekly at the '--start-date' time.
+    - name: label
+      usage: |
+        A comma-separated list of label modifications. Labels are represented as a key-value store.
+        Character '=' has a special meaning and cannot be a part of label's key nor value.
+        A single modification takes form of:
+        * '<key>=<value>' - sets the label <key> to <value>
+        * '<key>-'        - removes the label
+
+        For example, '--label k1=v1,k2-' will set the label 'k1' to 'v1' and will also remove label 'k2'.
     - name: name
       usage: |
-        Task name that can be used insead of ID.
+        Task name that can be used instead of ID.
     - name: num-retries
       shorthand: r
       default_value: "3"

docs/source/sctool/partials/sctool_suspend_update.yaml

@@ -39,9 +39,18 @@ options:
 
         The task run date is aligned with '--start date' value.
         For example, if you select '--interval 7d' task would run weekly at the '--start-date' time.
+    - name: label
+      usage: |
+        A comma-separated list of label modifications. Labels are represented as a key-value store.
+        Character '=' has a special meaning and cannot be a part of label's key nor value.
+        A single modification takes form of:
+        * '<key>=<value>' - sets the label <key> to <value>
+        * '<key>-'        - removes the label
+
+        For example, '--label k1=v1,k2-' will set the label 'k1' to 'v1' and will also remove label 'k2'.
     - name: name
       usage: |
-        Task name that can be used insead of ID.
+        Task name that can be used instead of ID.
     - name: num-retries
       shorthand: r
       default_value: "3"

pkg/command/cluster/clusteradd/cmd.go

@@ -25,6 +25,7 @@ type command struct {
 
 	id                     string
 	name                   string
+	label                  flag.Label
 	host                   string
 	port                   int64
 	authToken              string
@@ -57,6 +58,7 @@ func (cmd *command) init() {
 	w := cmd.Flags()
 	w.StringVarP(&cmd.id, "id", "i", "", "")
 	w.StringVarP(&cmd.name, "name", "n", "", "")
+	w.Var(&cmd.label, "label", "")
 	w.StringVar(&cmd.host, "host", "", "")
 	w.Int64Var(&cmd.port, "port", 10001, "")
 	w.StringVar(&cmd.authToken, "auth-token", "", "")
@@ -85,6 +87,7 @@ func (cmd *command) run() error {
 	c := &managerclient.Cluster{
 		ID:                     cmd.id,
 		Name:                   cmd.name,
+		Labels:                 cmd.label.NewLabels(),
 		Host:                   cmd.host,
 		AuthToken:              cmd.authToken,
 		Username:               cmd.username,

pkg/command/cluster/clusteradd/cmd_integration_api_test.go

@@ -9,6 +9,7 @@ import (
 	"bytes"
 	"context"
 	"fmt"
+	"maps"
 	"os/exec"
 	"strings"
 	"testing"
@@ -65,6 +66,18 @@ func TestSctoolClusterAddIntegrationAPITest(t *testing.T) {
 				Port:                   0,
 			},
 		},
+		{
+			name: "create cluster with label",
+			args: []string{"cluster", "add", "--auth-token", authToken, "--host", clusterIntroHost,
+				"--label", "k1=v1,with space=with-dash_underscore666",
+			},
+			expectedCluster: &models.Cluster{
+				Labels: map[string]string{
+					"k1":         "v1",
+					"with space": "with-dash_underscore666",
+				},
+			},
+		},
 	} {
 		t.Run(tc.name, func(t *testing.T) {
 			// given
@@ -86,7 +99,7 @@ func TestSctoolClusterAddIntegrationAPITest(t *testing.T) {
 			clusterID := strings.Split(string(output), "\n")[0]
 
 			defer func() {
-				if err != client.DeleteCluster(context.Background(), clusterID) {
+				if err := client.DeleteCluster(context.Background(), clusterID); err != nil {
 					t.Logf("Failed to delete cluster, err = {%v}", err)
 				}
 			}()
@@ -111,6 +124,9 @@ func TestSctoolClusterAddIntegrationAPITest(t *testing.T) {
 			if c.Port != tc.expectedCluster.Port {
 				t.Fatalf("Port mismatch {%v} != {%v}, output={%v}", c.Port, tc.expectedCluster.Port, string(output))
 			}
+			if !maps.Equal(c.Labels, tc.expectedCluster.Labels) {
+				t.Fatalf("Labels mismatch {%v} != {%v}", c.Labels, tc.expectedCluster.Labels)
+			}
 		})
 	}
 

pkg/command/cluster/clusteradd/res.yaml

@@ -28,6 +28,15 @@ name: |
   Use this parameter to identify the cluster by an alias name which is more meaningful.
   This `alias` name can be used with all commands that accept --cluster parameter.
 
+label: |
+  A comma-separated list of label modifications. Labels are represented as a key-value store.
+  Character '=' has a special meaning and cannot be a part of label's key nor value.
+  A single modification takes form of:
+  * '<key>=<value>' - sets the label <key> to <value>
+  * '<key>-'        - removes the label
+
+  For example, ``--label k1=v1,k2-`` will set the label 'k1' to 'v1' and will also remove label 'k2'.
+
 host: |
   Hostname or `IP` of the node that will be used to discover other nodes belonging to the cluster.
   Note that this will be persisted and used every time Scylla Manager starts.