diff --git a/docs/source/sctool/partials/sctool_backup.yaml b/docs/source/sctool/partials/sctool_backup.yaml index 8db3fbf6d..1a28c615e 100644 --- a/docs/source/sctool/partials/sctool_backup.yaml +++ b/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: + * '=' - sets the label to + * '-' - 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" diff --git a/docs/source/sctool/partials/sctool_backup_update.yaml b/docs/source/sctool/partials/sctool_backup_update.yaml index 3ab5d610a..ac3ee7146 100644 --- a/docs/source/sctool/partials/sctool_backup_update.yaml +++ b/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: + * '=' - sets the label to + * '-' - 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" diff --git a/docs/source/sctool/partials/sctool_backup_validate.yaml b/docs/source/sctool/partials/sctool_backup_validate.yaml index c1e92f90d..d7eee3633 100644 --- a/docs/source/sctool/partials/sctool_backup_validate.yaml +++ b/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: + * '=' - sets the label to + * '-' - 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" diff --git a/docs/source/sctool/partials/sctool_backup_validate_update.yaml b/docs/source/sctool/partials/sctool_backup_validate_update.yaml index 6c0302b4d..02d4a5a79 100644 --- a/docs/source/sctool/partials/sctool_backup_validate_update.yaml +++ b/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: + * '=' - sets the label to + * '-' - 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" diff --git a/docs/source/sctool/partials/sctool_cluster_add.yaml b/docs/source/sctool/partials/sctool_cluster_add.yaml index 3c8b7f8f0..f236b7b2c 100644 --- a/docs/source/sctool/partials/sctool_cluster_add.yaml +++ b/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: + * '=' - sets the label to + * '-' - 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: | diff --git a/docs/source/sctool/partials/sctool_cluster_update.yaml b/docs/source/sctool/partials/sctool_cluster_update.yaml index e4e707097..c66e8c7f8 100644 --- a/docs/source/sctool/partials/sctool_cluster_update.yaml +++ b/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: + * '=' - sets the label to + * '-' - 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: | diff --git a/docs/source/sctool/partials/sctool_repair.yaml b/docs/source/sctool/partials/sctool_repair.yaml index 3d3593bf1..4b0a7524c 100644 --- a/docs/source/sctool/partials/sctool_repair.yaml +++ b/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: + * '=' - sets the label to + * '-' - 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" diff --git a/docs/source/sctool/partials/sctool_repair_update.yaml b/docs/source/sctool/partials/sctool_repair_update.yaml index 22527e0f9..adf30acb8 100644 --- a/docs/source/sctool/partials/sctool_repair_update.yaml +++ b/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: + * '=' - sets the label to + * '-' - 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" diff --git a/docs/source/sctool/partials/sctool_restore.yaml b/docs/source/sctool/partials/sctool_restore.yaml index e85169e64..5472c7a2b 100644 --- a/docs/source/sctool/partials/sctool_restore.yaml +++ b/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: + * '=' - sets the label to + * '-' - 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 `` 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" diff --git a/docs/source/sctool/partials/sctool_restore_update.yaml b/docs/source/sctool/partials/sctool_restore_update.yaml index 3ef1fa617..34666bf00 100644 --- a/docs/source/sctool/partials/sctool_restore_update.yaml +++ b/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: + * '=' - sets the label to + * '-' - 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 `` 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" diff --git a/docs/source/sctool/partials/sctool_suspend.yaml b/docs/source/sctool/partials/sctool_suspend.yaml index f718a0c47..67f9efb01 100644 --- a/docs/source/sctool/partials/sctool_suspend.yaml +++ b/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: + * '=' - sets the label to + * '-' - 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" diff --git a/docs/source/sctool/partials/sctool_suspend_update.yaml b/docs/source/sctool/partials/sctool_suspend_update.yaml index 9ec2de4af..358fb2e4d 100644 --- a/docs/source/sctool/partials/sctool_suspend_update.yaml +++ b/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: + * '=' - sets the label to + * '-' - 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" diff --git a/pkg/command/cluster/clusteradd/res.yaml b/pkg/command/cluster/clusteradd/res.yaml index 917a36215..51808b9a1 100644 --- a/pkg/command/cluster/clusteradd/res.yaml +++ b/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: + * '=' - sets the label to + * '-' - 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. diff --git a/pkg/command/cluster/clusterupdate/res.yaml b/pkg/command/cluster/clusterupdate/res.yaml index 91f1fc7d1..1c38c0181 100644 --- a/pkg/command/cluster/clusterupdate/res.yaml +++ b/pkg/command/cluster/clusterupdate/res.yaml @@ -15,6 +15,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: + * '=' - sets the label to + * '-' - 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. diff --git a/pkg/command/flag/task.yaml b/pkg/command/flag/task.yaml index 58873a9e5..f5069f87f 100644 --- a/pkg/command/flag/task.yaml +++ b/pkg/command/flag/task.yaml @@ -2,7 +2,16 @@ enabled: | Not enabled tasks are not executed and are hidden from the task list. name: | - Task name that can be used insead of ID. + Task name that can be used instead of ID. + +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: + * '=' - sets the label to + * '-' - removes the label + + For example, ``--label k1=v1,k2-`` will set the label 'k1' to 'v1' and will also remove label 'k2'. cron: | Task schedule as a cron `expression`.