Skip to content

DOC-14105-Update Compatibility matrix to include 8.0 #4096

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
supritha-kumar wants to merge 6 commits into
base: release/8.0
Choose a base branch
from
Open

DOC-14105-Update Compatibility matrix to include 8.0 #4096

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
e58bbf0
DOC-14105-Update Compatibility matrix to include 8.0
supritha-kumar Mar 17, 2026
21ced85
updated compatibility matrix
supritha-kumar Mar 17, 2026
fc650fd
Updated compatibility matrix to include 8.0 and remove versions prior…
supritha-kumar Mar 24, 2026
3659400
corrected syntax of columns
supritha-kumar Mar 24, 2026
6dd1d63
Updated the text above the version compatibility table and removed ex…
supritha-kumar Mar 24, 2026
c4e7592
updated minor changes and some Vale suggestions
supritha-kumar Mar 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
120 changes: 20 additions & 100 deletions modules/backup-restore/pages/enterprise-backup-restore.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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].
====

Expand All @@ -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

Expand Down Expand Up @@ -64,15 +64,15 @@ 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.
See xref:backup-restore:cbbackupmgr-restore.adoc[cbbackupmgr restore] for a list of the arguments you can use to control what `cbbackupmgr` restores.

=== 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"]
Expand Down Expand Up @@ -102,132 +102,52 @@ 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 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 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.

.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*
Copy link
Copy Markdown
Contributor

@RichardSmedley RichardSmedley Mar 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With this shift to 10 columns, you'll need an extra column in the other rows, including the [cols="..."]

Copy link
Copy Markdown
Contributor Author

@supritha-kumar supritha-kumar Mar 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes Richard - i decided to let this be till i have a conversation with Support (as per our Slack chat) and will update it together once I get a final confirmation regarding the older versions.

| *7.6*
| *7.2*
| *7.1*
| *7.0*
| *6.6*
| *6.5.x*
| *6.0.x*
| *5.5.x*

| 7.6
| ✓
| 8.0
| ✓
| ✓
| ✓
| ✓
|
|
|

| 7.2
| 7.6
|
| ✓
| ✓
| ✓
| ✓
|
|
|

| 7.1
|
| 7.2
|
|
| ✓
| ✓
| ✓
| ✓*
|
|


| 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
****
== 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.

****