From e58bbf0ba3bd905c6cc9e0d75c6e78346ae30817 Mon Sep 17 00:00:00 2001 From: supritha-kumar Date: Tue, 17 Mar 2026 11:58:12 +0530 Subject: [PATCH 1/6] DOC-14105-Update Compatibility matrix to include 8.0 --- modules/backup-restore/pages/enterprise-backup-restore.adoc | 1 + 1 file changed, 1 insertion(+) diff --git a/modules/backup-restore/pages/enterprise-backup-restore.adoc b/modules/backup-restore/pages/enterprise-backup-restore.adoc index 5524c2462c..58bd17d65b 100644 --- a/modules/backup-restore/pages/enterprise-backup-restore.adoc +++ b/modules/backup-restore/pages/enterprise-backup-restore.adoc @@ -120,6 +120,7 @@ Unless otherwise specified, backup and restore apply both to _local_ and to _clo [cols="5,3,3,3,3,3,3,3,3"] |=== | *cbbackupmgr version* +| *8.0* | *7.6* | *7.2* | *7.1* From 21ced854b2f5a038092a9597261a38c5a0dfbb8a Mon Sep 17 00:00:00 2001 From: Supritha Date: Tue, 17 Mar 2026 16:40:18 +0530 Subject: [PATCH 2/6] updated compatibility matrix --- .../pages/enterprise-backup-restore.adoc | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/modules/backup-restore/pages/enterprise-backup-restore.adoc b/modules/backup-restore/pages/enterprise-backup-restore.adoc index 58bd17d65b..4985810cfa 100644 --- a/modules/backup-restore/pages/enterprise-backup-restore.adoc +++ b/modules/backup-restore/pages/enterprise-backup-restore.adoc @@ -130,6 +130,17 @@ Unless otherwise specified, backup and restore apply both to _local_ and to _clo | *6.0.x* | *5.5.x* +| 8.0 +| ✓ +| ✓ +| ✓ +| ✓ +| ✓ +| +| +| + + | 7.6 | ✓ | ✓ From fc650fd70d3720ea1841a30f577db3f5457a8a63 Mon Sep 17 00:00:00 2001 From: Supritha Date: Tue, 24 Mar 2026 21:09:02 +0530 Subject: [PATCH 3/6] Updated compatibility matrix to include 8.0 and remove versions prior to 7.2. --- .../pages/enterprise-backup-restore.adoc | 94 +------------------ 1 file changed, 2 insertions(+), 92 deletions(-) diff --git a/modules/backup-restore/pages/enterprise-backup-restore.adoc b/modules/backup-restore/pages/enterprise-backup-restore.adoc index 4985810cfa..a6022b93d1 100644 --- a/modules/backup-restore/pages/enterprise-backup-restore.adoc +++ b/modules/backup-restore/pages/enterprise-backup-restore.adoc @@ -117,120 +117,30 @@ The following table lists the compatible cluster-versions for each version of `c Unless otherwise specified, backup and restore apply both to _local_ and to _cloud_ data. .Compatibility Requirements for Backup and Restore -[cols="5,3,3,3,3,3,3,3,3"] +[cols="5,3,3,3,"] |=== | *cbbackupmgr version* | *8.0* | *7.6* | *7.2* -| *7.1* -| *7.0* -| *6.6* -| *6.5.x* -| *6.0.x* -| *5.5.x* | 8.0 | ✓ | ✓ | ✓ -| ✓ -| ✓ -| -| -| - | 7.6 +| | ✓ | ✓ -| ✓ -| ✓ -| ✓ -| -| -| | 7.2 | -| ✓ -| ✓ -| ✓ -| ✓ -| -| -| - -| 7.1 -| | | ✓ -| ✓ -| ✓ -| ✓* -| -| - - -| 7.0 -| -| -| -| ✓ -| ✓ -| ✓* -| ✓* -| - - -| 6.6.0 and above -| -| -| -| -| ✓ -| ✓* -| ✓* -| ✓* - - -| 6.5 -| -| -| -| -| -| ✓ -| ✓ -| ✓ - - -| 6.0.x -| -| -| -| -| -| -| ✓ -| - - -| 5.5.x -| -| -| -| -| -| -| -| ✓ - |=== -+*+ For local backup only — _not_ for cloud. - .Restoring metadata and users **** * When restoring metadata to a newer Server version, From 36594003a13f528be0414073b7a315adf98f24c3 Mon Sep 17 00:00:00 2001 From: Supritha Date: Tue, 24 Mar 2026 21:10:52 +0530 Subject: [PATCH 4/6] corrected syntax of columns --- modules/backup-restore/pages/enterprise-backup-restore.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/backup-restore/pages/enterprise-backup-restore.adoc b/modules/backup-restore/pages/enterprise-backup-restore.adoc index a6022b93d1..9d4a2c6108 100644 --- a/modules/backup-restore/pages/enterprise-backup-restore.adoc +++ b/modules/backup-restore/pages/enterprise-backup-restore.adoc @@ -117,7 +117,7 @@ The following table lists the compatible cluster-versions for each version of `c Unless otherwise specified, backup and restore apply both to _local_ and to _cloud_ data. .Compatibility Requirements for Backup and Restore -[cols="5,3,3,3,"] +[cols="5,3,3,3"] |=== | *cbbackupmgr version* | *8.0* From 6dd1d63481e7cd6cde9b4dd07980b8b384a9a8a6 Mon Sep 17 00:00:00 2001 From: Supritha Date: Tue, 24 Mar 2026 21:29:24 +0530 Subject: [PATCH 5/6] Updated the text above the version compatibility table and removed example of 6.x --- modules/backup-restore/pages/enterprise-backup-restore.adoc | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/modules/backup-restore/pages/enterprise-backup-restore.adoc b/modules/backup-restore/pages/enterprise-backup-restore.adoc index 9d4a2c6108..18d3e1a666 100644 --- a/modules/backup-restore/pages/enterprise-backup-restore.adoc +++ b/modules/backup-restore/pages/enterprise-backup-restore.adoc @@ -109,9 +109,8 @@ To prevent such corruption instances, you may be required to create multiple bac [#version-compatibility] == Version Compatibility -For 6.5 and all later versions, `cbbackupmgr` can be used to back up data either from a cluster running its own version, or from a cluster running a prior, _compatible_ version. -For example, the 6.6.0 tool can back up data from a cluster running 6.6.0, 6.5.x, 6.0.x, or 5.5.x. -It can also be used to restore _to_ any of those versions data previously backed up _from_ any of those versions. +For 7.2 and all later versions, you can use `cbbackupmgr` to back up data either from a cluster running its own version, or from a cluster running a prior, `compatible` version. + You can also use it to restore data to any of these versions from backups created on any of them. The following table lists the compatible cluster-versions for each version of `cbbackupmgr`. Unless otherwise specified, backup and restore apply both to _local_ and to _cloud_ data. @@ -141,6 +140,7 @@ Unless otherwise specified, backup and restore apply both to _local_ and to _clo |=== + .Restoring metadata and users **** * When restoring metadata to a newer Server version, From c4e75921720d3d413f3c808a45d7f028177df83a Mon Sep 17 00:00:00 2001 From: Supritha Date: Tue, 24 Mar 2026 21:57:11 +0530 Subject: [PATCH 6/6] updated minor changes and some Vale suggestions --- .../pages/enterprise-backup-restore.adoc | 28 +++++++++---------- 1 file changed, 13 insertions(+), 15 deletions(-) diff --git a/modules/backup-restore/pages/enterprise-backup-restore.adoc b/modules/backup-restore/pages/enterprise-backup-restore.adoc index 18d3e1a666..7b6f2908f8 100644 --- a/modules/backup-restore/pages/enterprise-backup-restore.adoc +++ b/modules/backup-restore/pages/enterprise-backup-restore.adoc @@ -15,9 +15,9 @@ which is available for both Couchbase Server _Enterprise Edition_ and Couchbase [NOTE] ==== -`cbbackupmgr` is _not_ backward compatible with backups created by means of `cbbackup`. +`cbbackupmgr` is not backward compatible with backups created by means of `cbbackup`. -In Couchbase Enterprise Server 7.2 and after, `cbbackupmgr` is available in the `Tools` package that must be downloaded. +In Couchbase Enterprise Server 7.2 and later, `cbbackupmgr` is available in the `Tools` package that must be downloaded. See xref:cli:cli-intro.adoc#server-tools-packages[Server Tools Packages]. ==== @@ -30,10 +30,10 @@ Administrators are therefore recommended to define plans for both https://en.wik All backup is stored in and recovered from a [.term]_Backup Repository_. In turn, a [.term]_Backup Repository_ is stored in a Backup Archive on the filesystem. -Each backup job in the [.term]_Backup Repository_ stores its backup in two ways: +Each backup job in the [.term]_Backup Repository_ stores its backup in 2 ways: -* All bucket data is stored in a small, secondary database. -* All bucket creation scripts and configuration files are stored on the file system, as files. +* You can store all bucket data in a small, secondary database. +* You can store all bucket creation scripts and configuration files on the filesystem, as files. === What's Backed Up @@ -64,7 +64,7 @@ NOTE: Backups that include users contain the user's hashed passwords. Other flags let you exclude specific metadata, or select a subset of data to back up. See xref:backup-restore:cbbackupmgr-config.adoc[cbbackupmgr config] for a list of the arguments you can use to control what `cbbackupmgr` backs up. -You can also use command line flags to control how the `cbbackupmgr restore` command restores data. +You can also use command line flags to control how the `cbbackupmgr restore` command restores data. For example, use `--overwrite-users` to have `cbbackupmgr` overwrite existing users and groups in the database if the backup contains a matching user or group. By default, `cbbackupmgr` does not overwrite existing users in the database. Instead, it restores just the users in the backup that do not exist in database. @@ -72,7 +72,7 @@ See xref:backup-restore:cbbackupmgr-restore.adoc[cbbackupmgr restore] for a list === Tool Locations -When installed as part of the Couchbase Server install, `cbbackupmgr` tool is stored with all other tools in the following _per platform_ locations: +When installed as part of the Couchbase Server install, `cbbackupmgr` tool is stored with all other tools in the following per platform locations: .Backup Tool Locations [cols="1,5"] @@ -102,14 +102,14 @@ Each of the subsequent, incremental backups take a fraction of the time taken by The backup archive is a directory that contains a set of backup repositories as well as logs for the backup client. The backup directory should be modified only by the backup client, and any modifications that are not done by that client might result in a corruption of backup data. -Only one backup client can access the backup archive at one time. +Only 1 backup client can access the backup archive at 1 time. If multiple instances of the backup client are running on the same archive at the same time, this might result in corruption. To prevent such corruption instances, you may be required to create multiple backup archives depending on your use case. [#version-compatibility] == Version Compatibility -For 7.2 and all later versions, you can use `cbbackupmgr` to back up data either from a cluster running its own version, or from a cluster running a prior, `compatible` version. +For 7.2 and later versions, you can use `cbbackupmgr` to back up data either from a cluster running its own version, or from a cluster running a prior, `compatible` version. You can also use it to restore data to any of these versions from backups created on any of them. The following table lists the compatible cluster-versions for each version of `cbbackupmgr`. @@ -141,15 +141,13 @@ Unless otherwise specified, backup and restore apply both to _local_ and to _clo |=== -.Restoring metadata and users -**** +== Restoring metadata and users + * When restoring metadata to a newer Server version, if the feature that the metadata applies to no longer exists in the newer Server version, then the metadata may not be restorable. -* If the user roles no longer exist in the version that you wish to restore to, then an error will be logged for the target user. +* If the user roles no longer exist in the version that you want to restore to, then an error is logged for the target user. -* In general, if you can upgrade _directly_ to the new version, then you should be able to restore the users. +* In general, if you can upgrade to the new version, then you should be able to restore the users. If you cannot upgrade directly, then restoring users may cause errors. For example, if some of the user roles no longer exist in the newer Server version. - -****