feat(1-1-restore): adds 1-1-restore cli and service stub

docs/source/sctool/partials/sctool_restore.yaml

@@ -195,4 +195,5 @@ inherited_options:
         If running sctool on the same machine as server, it's generated based on '/etc/scylla-manager/scylla-manager.yaml' file.
 see_also:
     - sctool - Scylla Manager Snapshot
+    - sctool restore 1-1-restore - Run an ad-hoc restore of tables to a cluster that mirrors the topology (DCs, racks, nodes structure and tokens) of a backup cluster.
     - sctool restore update - Modify properties of the existing restore task

docs/source/sctool/partials/sctool_restore_1-1-restore.yaml

@@ -0,0 +1,149 @@
+name: sctool restore 1-1-restore
+synopsis: |
+    Run an ad-hoc restore of tables to a cluster that mirrors the topology (DCs, racks, nodes structure and tokens) of a backup cluster.
+description: "This command allows you to run ad-hoc restore of tables to a cluster that mirrors the topology of a backup cluster. This means that the target cluster must have \nthe same number of nodes in each datacenter and rack, as well as the same token assignment for each node.  \n**Note:** This command only restores the data within the tables. \nYou must first restore the schema of the database separately using the regular restore command with the `--restore-schema` flag.\n"
+usage: sctool restore 1-1-restore --cluster <id|name> --location [<dc>:]<provider>:<bucket> --snapshot-tag <tag> [flags] --source-cluster-id <id> --nodes-mapping <filepath>
+options:
+    - name: cluster
+      shorthand: c
+      usage: |
+        The target cluster `name or ID` (envvar SCYLLA_MANAGER_CLUSTER).
+    - name: cron
+      usage: |
+        Task schedule as a cron `expression`.
+        It supports the extended syntax including @monthly, @weekly, @daily, @midnight, @hourly, @every X[h|m|s].
+    - name: dry-run
+      default_value: "false"
+      usage: |
+        Validates and displays restore information without actually running the restore.
+        This allows you to display what will happen should the restore run with the parameters you set.
+    - name: enabled
+      default_value: "true"
+      usage: |
+        Not enabled tasks are not executed and are hidden from the task list.
+    - name: help
+      shorthand: h
+      default_value: "false"
+      usage: help for 1-1-restore
+    - name: interval
+      shorthand: i
+      usage: |
+        --interval is deprecated, please use `--cron` instead
+
+
+        Time after which a successfully completed task would be run again. The supported units are:
+
+        * 'd' - days
+        * 'h' - hours
+        * 'm' - minutes
+        * 's' - seconds
+        * 'ms' - milliseconds
+
+        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: keyspace
+      shorthand: K
+      default_value: '[]'
+      usage: |+
+        A list of `glob` patterns separated by a comma used to include or exclude tables.
+        The patterns match keyspaces and tables, separate the keyspace name from the table name with a dot e.g. 'keyspace,!keyspace.table_prefix_*'.
+        The following syntax for glob patterns is supported:
+
+        * '*' - matches any number of any characters including none
+        * '?' - matches any single character
+        * '[abc]' - matches one character given in the bracket
+        * '[a-z]' - matches one character from the range given in the bracket
+
+        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: '[]'
+      usage: |
+        A list of backup locations separated by a comma, specifies places where restored backup is stored.
+
+        The format is `[<dc>:]<provider>:<bucket>`.
+        The `<dc>` parameter is optional. It allows you to specify the datacenter whose nodes will be used to restore the data
+        from this location in a multi-dc setting, it must match Scylla nodes datacenter.
+        By default, all live nodes are used to restore data from specified locations.
+
+        Note that specifying datacenters closest to backup locations might reduce download time of restored data.
+        The supported storage '<provider>'s are 'azure', 'gcs', 's3'.
+        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 instead of ID.
+    - name: nodes-mapping
+      usage: |
+        Path to a file with source cluster and target cluster nodes mapping. Each line should contain node mapping in the following format <source_dc>:<source_rack>:<source_host_id>=<destination_dc>:<destination_rack>:<destination_host_id>
+    - name: num-retries
+      shorthand: r
+      default_value: "3"
+      usage: |
+        Number of times a task reruns following a failure.
+    - name: retry-wait
+      default_value: 10m
+      usage: |
+        Initial exponential backoff `duration` X[h|m|s].
+        With --retry-wait 10m task will wait 10 minutes, 20 minutes and 40 minutes after first, second and third consecutire failure.
+    - name: snapshot-tag
+      shorthand: T
+      usage: |
+        Scylla Manager snapshot tag identifying restored backup.
+        Snapshot tags can be obtained from backup listing ('./sctool backup list' command - e.g. sm_20060102150405UTC).
+    - name: source-cluster-id
+      usage: |
+        Cluster ID of the backup cluster.
+    - name: start-date
+      shorthand: s
+      usage: |
+        The date can be expressed relatively to now or as a RFC3339 formatted string.
+        To run the task in 2 hours use 'now+2h'. The supported units are:
+
+        * 'd' - days
+        * 'h' - hours
+        * 'm' - minutes
+        * 's' - seconds
+        * 'ms' - milliseconds
+
+        If you want the task to start at a specified date use RFC3339 formatted string i.e. '2018-01-02T15:04:05-07:00'.
+        If you want the repair to start immediately, use the value 'now' or skip this flag.
+    - name: timezone
+      default_value: UTC
+      usage: |
+        Timezone of --cron and --window flag values.
+        The default value is taken from this system, namely 'TZ' envvar or '/etc/localtime' file.
+    - name: window
+      default_value: '[]'
+      usage: |
+        A comma-separated list of time markers in a form `[WEEKDAY-]HH:MM`.
+        WEEKDAY can be written as the whole word or only using the first 3 characters, HH:MM is an hour from 00:00 to 23:59.
+
+        * 'MON-00:00,FRI-15:00' - can be executed from Monday to Friday 3PM
+        * '23:00,06:00' - can be executed every night from 11PM to 6AM
+        * '23:00,06:00,SAT-00:00,SUN-23:59' - can be executed every night from 11PM to 6AM and all day during the weekend
+inherited_options:
+    - name: api-cert-file
+      usage: |
+        File `path` to HTTPS client certificate used to access the Scylla Manager server when client certificate validation is enabled (envvar SCYLLA_MANAGER_API_CERT_FILE).
+    - name: api-key-file
+      usage: |
+        File `path` to HTTPS client key associated with --api-cert-file flag (envvar SCYLLA_MANAGER_API_KEY_FILE).
+    - name: api-url
+      default_value: http://127.0.0.1:5080/api/v1
+      usage: |
+        Base `URL` of Scylla Manager server (envvar SCYLLA_MANAGER_API_URL).
+        If running sctool on the same machine as server, it's generated based on '/etc/scylla-manager/scylla-manager.yaml' file.
+see_also:
+    - sctool restore - Run an ad-hoc restore of schema or tables
+    - sctool restore 1-1-restore update - Modify properties of the existing 1_1_restore task

docs/source/sctool/partials/sctool_restore_1-1-restore_update.yaml

@@ -0,0 +1,149 @@
+name: sctool restore 1-1-restore update
+synopsis: Modify properties of the existing 1_1_restore task
+description: |
+    This command allows you to modify properties of an already existing 1_1_restore task.
+    If there is one 1_1_restore task the '1_1_restore/task-id' argument is not needed.
+usage: sctool restore 1-1-restore update --cluster <id|name> [flags] [<1_1_restore/task-id>]
+options:
+    - name: cluster
+      shorthand: c
+      usage: |
+        The target cluster `name or ID` (envvar SCYLLA_MANAGER_CLUSTER).
+    - name: cron
+      usage: |
+        Task schedule as a cron `expression`.
+        It supports the extended syntax including @monthly, @weekly, @daily, @midnight, @hourly, @every X[h|m|s].
+    - name: dry-run
+      default_value: "false"
+      usage: |
+        Validates and displays restore information without actually running the restore.
+        This allows you to display what will happen should the restore run with the parameters you set.
+    - name: enabled
+      default_value: "true"
+      usage: |
+        Not enabled tasks are not executed and are hidden from the task list.
+    - name: help
+      shorthand: h
+      default_value: "false"
+      usage: help for update
+    - name: interval
+      shorthand: i
+      usage: |
+        --interval is deprecated, please use `--cron` instead
+
+
+        Time after which a successfully completed task would be run again. The supported units are:
+
+        * 'd' - days
+        * 'h' - hours
+        * 'm' - minutes
+        * 's' - seconds
+        * 'ms' - milliseconds
+
+        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: keyspace
+      shorthand: K
+      default_value: '[]'
+      usage: |+
+        A list of `glob` patterns separated by a comma used to include or exclude tables.
+        The patterns match keyspaces and tables, separate the keyspace name from the table name with a dot e.g. 'keyspace,!keyspace.table_prefix_*'.
+        The following syntax for glob patterns is supported:
+
+        * '*' - matches any number of any characters including none
+        * '?' - matches any single character
+        * '[abc]' - matches one character given in the bracket
+        * '[a-z]' - matches one character from the range given in the bracket
+
+        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: '[]'
+      usage: |
+        A list of backup locations separated by a comma, specifies places where restored backup is stored.
+
+        The format is `[<dc>:]<provider>:<bucket>`.
+        The `<dc>` parameter is optional. It allows you to specify the datacenter whose nodes will be used to restore the data
+        from this location in a multi-dc setting, it must match Scylla nodes datacenter.
+        By default, all live nodes are used to restore data from specified locations.
+
+        Note that specifying datacenters closest to backup locations might reduce download time of restored data.
+        The supported storage '<provider>'s are 'azure', 'gcs', 's3'.
+        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 instead of ID.
+    - name: nodes-mapping
+      usage: |
+        Path to a file with source cluster and target cluster nodes mapping. Each line should contain node mapping in the following format <source_dc>:<source_rack>:<source_host_id>=<destination_dc>:<destination_rack>:<destination_host_id>
+    - name: num-retries
+      shorthand: r
+      default_value: "3"
+      usage: |
+        Number of times a task reruns following a failure.
+    - name: retry-wait
+      default_value: 10m
+      usage: |
+        Initial exponential backoff `duration` X[h|m|s].
+        With --retry-wait 10m task will wait 10 minutes, 20 minutes and 40 minutes after first, second and third consecutire failure.
+    - name: snapshot-tag
+      shorthand: T
+      usage: |
+        Scylla Manager snapshot tag identifying restored backup.
+        Snapshot tags can be obtained from backup listing ('./sctool backup list' command - e.g. sm_20060102150405UTC).
+    - name: source-cluster-id
+      usage: |
+        Cluster ID of the backup cluster.
+    - name: start-date
+      shorthand: s
+      usage: |
+        The date can be expressed relatively to now or as a RFC3339 formatted string.
+        To run the task in 2 hours use 'now+2h'. The supported units are:
+
+        * 'd' - days
+        * 'h' - hours
+        * 'm' - minutes
+        * 's' - seconds
+        * 'ms' - milliseconds
+
+        If you want the task to start at a specified date use RFC3339 formatted string i.e. '2018-01-02T15:04:05-07:00'.
+        If you want the repair to start immediately, use the value 'now' or skip this flag.
+    - name: timezone
+      default_value: UTC
+      usage: |
+        Timezone of --cron and --window flag values.
+        The default value is taken from this system, namely 'TZ' envvar or '/etc/localtime' file.
+    - name: window
+      default_value: '[]'
+      usage: |
+        A comma-separated list of time markers in a form `[WEEKDAY-]HH:MM`.
+        WEEKDAY can be written as the whole word or only using the first 3 characters, HH:MM is an hour from 00:00 to 23:59.
+
+        * 'MON-00:00,FRI-15:00' - can be executed from Monday to Friday 3PM
+        * '23:00,06:00' - can be executed every night from 11PM to 6AM
+        * '23:00,06:00,SAT-00:00,SUN-23:59' - can be executed every night from 11PM to 6AM and all day during the weekend
+inherited_options:
+    - name: api-cert-file
+      usage: |
+        File `path` to HTTPS client certificate used to access the Scylla Manager server when client certificate validation is enabled (envvar SCYLLA_MANAGER_API_CERT_FILE).
+    - name: api-key-file
+      usage: |
+        File `path` to HTTPS client key associated with --api-cert-file flag (envvar SCYLLA_MANAGER_API_KEY_FILE).
+    - name: api-url
+      default_value: http://127.0.0.1:5080/api/v1
+      usage: |
+        Base `URL` of Scylla Manager server (envvar SCYLLA_MANAGER_API_URL).
+        If running sctool on the same machine as server, it's generated based on '/etc/scylla-manager/scylla-manager.yaml' file.
+see_also:
+    - sctool restore 1-1-restore - Run an ad-hoc restore of tables to a cluster that mirrors the topology (DCs, racks, nodes structure and tokens) of a backup cluster.

docs/source/sctool/restore.rst

@@ -17,4 +17,16 @@ restore update
 ==============
 
 .. datatemplate:yaml:: partials/sctool_restore_update.yaml
-   :template: command.tmpl
+   :template: command.tmpl
+
+1-1-restore
+===========
+
+.. datatemplate:yaml:: partials/sctool_restore_1-1-restore.yaml
+   :template: command.tmpl
+
+1-1-restore update
+==================
+
+.. datatemplate:yaml:: partials/sctool_restore_1-1-restore_update.yaml
+   :template: command.tmpl

go.mod

@@ -31,7 +31,7 @@ require (
 	github.com/scylladb/go-reflectx v1.0.1
 	github.com/scylladb/go-set v1.0.2
 	github.com/scylladb/gocqlx/v2 v2.8.0
-	github.com/scylladb/scylla-manager/v3/pkg/managerclient v0.0.0-20250122142320-e1127475cc4c
+	github.com/scylladb/scylla-manager/v3/pkg/managerclient v0.0.0-20250129134654-ad359657f571
 	github.com/scylladb/scylla-manager/v3/pkg/util v0.0.0-20250122142320-e1127475cc4c
 	github.com/scylladb/scylla-manager/v3/swagger v0.0.0-20250122142320-e1127475cc4c
 	github.com/spf13/cobra v1.8.0

go.sum

@@ -1062,8 +1062,8 @@ github.com/scylladb/google-api-go-client v0.34.1-patched h1:DW+T0HA+74o6FDr3TFzV
 github.com/scylladb/google-api-go-client v0.34.1-patched/go.mod h1:RriRmS2wJXH+2yd9PRTEcR380U9AXmurWwznqVhzsSc=
 github.com/scylladb/rclone v1.54.1-0.20240312172628-afe1fd2aa65e h1:lJRphCtu+nKd+mfo8whOTeFkgjMWvk8iCSlqgibKSa8=
 github.com/scylladb/rclone v1.54.1-0.20240312172628-afe1fd2aa65e/go.mod h1:JGZp4EvCUK+6AM1Fe1dye5xvihTc/Bk0WnHHSCJOePM=
-github.com/scylladb/scylla-manager/v3/pkg/managerclient v0.0.0-20250122142320-e1127475cc4c h1:scmfi5j0Sgl7i3g6tVsu5yhCBlnT/PLN/PYVaY8B+Hc=
-github.com/scylladb/scylla-manager/v3/pkg/managerclient v0.0.0-20250122142320-e1127475cc4c/go.mod h1:7+yHDmds+qO/8b0w4xTptCLh/Gr/hXyAjIIZkMj4KHk=
+github.com/scylladb/scylla-manager/v3/pkg/managerclient v0.0.0-20250129134654-ad359657f571 h1:oZihHS9xlhRbzOeQeFz0VlsD61mdh+arBfFS8i8YcKQ=
+github.com/scylladb/scylla-manager/v3/pkg/managerclient v0.0.0-20250129134654-ad359657f571/go.mod h1:IUo0KL/TTqXUg8ur6sGhAc1jDDF8TBV6LYVTKB2AlIQ=
 github.com/scylladb/scylla-manager/v3/pkg/util v0.0.0-20250122142320-e1127475cc4c h1:RLgSH0r/TI+Aw1f2bHUqnjVOI+8cOc9eX5Kr73N9Iuc=
 github.com/scylladb/scylla-manager/v3/pkg/util v0.0.0-20250122142320-e1127475cc4c/go.mod h1:VKqHSrDj9zfgCKilpbdpmqV1TjmSglt/df79eIg6wuI=
 github.com/scylladb/scylla-manager/v3/swagger v0.0.0-20250122142320-e1127475cc4c h1:1qkWdf5FbOwW3iE712s7mwOFSHaTRf9vlZ1LW+HDmVE=

pkg/cmd/sctool/sctool.go

@@ -24,6 +24,7 @@ import (
 	"github.com/scylladb/scylla-manager/v3/pkg/command/legacy/task/taskstart"
 	"github.com/scylladb/scylla-manager/v3/pkg/command/legacy/task/taskstop"
 	"github.com/scylladb/scylla-manager/v3/pkg/command/legacy/task/taskupdate"
+	"github.com/scylladb/scylla-manager/v3/pkg/command/one2onerestore"
 	"github.com/scylladb/scylla-manager/v3/pkg/command/progress"
 	"github.com/scylladb/scylla-manager/v3/pkg/command/repair"
 	"github.com/scylladb/scylla-manager/v3/pkg/command/repair/repaircontrol"
@@ -63,6 +64,7 @@ func buildCommand() *cobra.Command {
 	)
 
 	restoreCmd := restore.NewCommand(&client)
+	restoreCmd.AddCommand(one2onerestore.NewCommand(&client))
 
 	clusterCmd := &cobra.Command{
 		Use:   "cluster",