You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs(backup): describe native backup support for gs
Native backup for gs is supported starting from scylla 2026.1,
so we should reflect it in our docs. This commit also fixes broken
link and ajdusts example s3 object storage endpoint to the new format.
Copy file name to clipboardExpand all lines: docs/source/backup/native-backup.rst
+11-10Lines changed: 11 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,22 +26,25 @@ All other stages are still performed by the rclone server (e.g., deduplication o
26
26
The ``ScyllaDB Version`` column describes the ScyllaDB version from which the functionality is considered production ready, even though the functionality might be available in earlier versions as well.
27
27
28
28
.. list-table::
29
-
:widths:15 15 50 25
29
+
:widths:20 15 50 25
30
30
:header-rows: 1
31
31
32
32
* - Functionality
33
-
- Since ScyllaDB Version
33
+
- ScyllaDB Version
34
34
- Description
35
35
- Limitations
36
-
* - SSTable upload
36
+
* - SSTable upload to :doc:`s3 <setup-s3-compatible-storage>`
37
37
- 2025.2
38
38
- As this is the most time- and resource-consuming part of the backup procedure, moving it to ScyllaDB brings the most benefits.
39
39
It also leverages knowledge of ScyllaDB internals to prioritize the upload of already compacted SSTables, which can then be fully deleted after upload,
40
40
which reduces disk storage utilization caused by the snapshot. To ensure that native SSTable upload
41
41
does not interfere with ScyllaDB performance, it should be throttled by configuring
42
42
`stream_io_throughput_mb_per_sec <https://docs.scylladb.com/manual/stable/reference/configuration-parameters.html#confval-stream_io_throughput_mb_per_sec>`_ in `scylla.yaml`.
43
-
- Works with S3 provider only.
44
-
Does not support creation of :ref:`versioned SSTables <backup-versioned-sstables>`.
43
+
- Does not support creation of :ref:`versioned SSTables <backup-versioned-sstables>`.
44
+
* - SSTable upload to :doc:`gcs <setup-gcs>`
45
+
- 2026.1
46
+
- Same as above.
47
+
- Same as above.
45
48
46
49
.. _configure-native-backup-in-scylla:
47
50
@@ -52,7 +55,7 @@ To configure native backup, perform the following steps for each ScyllaDB node:
52
55
53
56
#. Make sure that ScyllaDB Manager Agent is :ref:`configured <install-agent>` as usual.
54
57
55
-
#. Configure `object_storage_endpoints <https://docs.scylladb.com/manual/stable/operating-scylla/admin.html#configuring-object-storage-experimental>`_ in `scylla.yaml`.
58
+
#. Configure `object_storage_endpoints <https://docs.scylladb.com/manual/stable/operating-scylla/admin.html#configuring-object-storage>`_ in `scylla.yaml`.
56
59
57
60
This configures the backup location access for the ScyllaDB node itself. The backup location access for ScyllaDB Manager Agent needs to be configured separately,
58
61
in the same way as it is done for the regular backup purposes (see :doc:`setup-amazon-s3`). The configurations in `scylla.yaml` and `scylla-manager-agent.yaml` should match.
@@ -72,9 +75,7 @@ To configure native backup, perform the following steps for each ScyllaDB node:
72
75
.. code-block:: yaml
73
76
74
77
object_storage_endpoints:
75
-
- name: s3.us-east-1.amazonaws.com
76
-
port: 443
77
-
https: true
78
+
- name: https://s3.us-east-1.amazonaws.com:443
78
79
aws_region: us-east-1
79
80
80
81
#. Throttle `stream_io_throughput_mb_per_sec <https://docs.scylladb.com/manual/stable/reference/configuration-parameters.html#confval-stream_io_throughput_mb_per_sec>`_ in `scylla.yaml`.
@@ -93,7 +94,7 @@ It supports three values: ``rclone`` (default), ``native``, and ``auto``:
93
94
Note that this will fail when:
94
95
95
96
* ScyllaDB is not configured properly (see ``object_storage_endpoints`` in `Configuration`_)
96
-
* Provider other than S3 is used (see limitations in `Status`_)
97
+
* Provider not supported by used ScyllaDB version is used (see limitations in `Status`_)
97
98
* The upload of snapshot directories would result in creation of versioned SSTables (see limitations in `Status`_)
98
99
99
100
* ``auto``: Uses native backup functionalities when possible, otherwise falls back to rclone backup.
0 commit comments