DOC-12561 Continuous backup PITR by ggray-cb · Pull Request #4138 · couchbase/docs-server

ggray-cb · 2026-07-02T13:14:25Z

Adds documentation for Continuous backup and point-in-time recovery,

The links in the following changes led to the preview site. You will need the Docs Team credentials on Confluence.

New pages added:

Continuous Backup — Concepts page for Continuous Backup.
Manage Continuous Backup — How to configure and manage continuous backup
Manage Point-in-Time Recovery — How to use PITR to restore data to a specific point in time
Monitor Continuous Backup — How to monitor continuous backup status

Existing pages updated:

Backup Service — Notes added referencing the new continuous backup capability
Install Ports and Server Processes — Port/process entry added for cbcontbk
What's New — Continuous Backup and PITR announced as new features

Please review by July 12th.

…e service page.

* Added minitor continuous backup. * Updated metrics. * Finished draft of manage continuous backup.

…he install section.

Copilot

Pull request overview

Adds Couchbase Server 8.1 documentation and reference updates for the new Continuous Backup + Point-in-Time Recovery (PITR) capabilities, including new Learn/Manage pages, navigation entries, and supporting operational reference updates (ports/processes/metrics metadata).

Changes:

Introduces new Learn + Manage documentation for continuous backup and PITR, plus example command/log snippets.
Updates site navigation and related “new features”/cross-reference pages to surface continuous backup.
Extends metrics metadata and operational reference docs (install ports + server processes) to reflect new/updated functionality.

Reviewed changes

Copilot reviewed 19 out of 20 changed files in this pull request and generated 23 comments.

Show a summary per file

File	Description
preview/DOC-12561_Continuous_backup_PITR.yml	Adds a preview build config enabling the `backup` content source for the DOC-12561 preview.
modules/ROOT/nav.adoc	Adds nav entries for the new continuous backup/PITR learn + manage pages.
modules/metrics-reference/attachments/n1ql_metrics_metadata.json	Adds/adjusts SQL++ (N1QL) metrics metadata entries.
modules/metrics-reference/attachments/kv_metrics_metadata.json	Adds/adjusts KV metrics metadata (including continuous backup/magma/fusion-related metrics).
modules/metrics-reference/attachments/index_metrics_metadata.json	Adds new index metrics metadata for vector-related index counts.
modules/metrics-reference/attachments/goxdcr_metrics_metadata.json	Updates XDCR metrics help/notes and adjusts a metric type/version entry.
modules/metrics-reference/attachments/fts_metrics_metadata.json	Adds new FTS metrics metadata for vector indexes in CPU/GPU memory.
modules/metrics-reference/attachments/cm_metrics_metadata.json	Adds a new CM telemetry metric metadata entry.
modules/manage/pages/manage-backup-and-restore/monitor-continuous-backup.adoc	New “monitor continuous backup” operational doc page.
modules/manage/pages/manage-backup-and-restore/manage-pitr.adoc	New PITR management doc page.
modules/manage/pages/manage-backup-and-restore/manage-continuous-backup.adoc	New “configure/manage continuous backup” doc page.
modules/manage/examples/continuous-backup.sh	Adds example `cbcontbk` CLI snippets referenced by the Manage docs.
modules/manage/examples/continuous-backup.log	Adds example output referenced by the Manage docs.
modules/learn/pages/services-and-indexes/services/continuous-backup.adoc	New Learn overview page describing continuous backup + PITR concepts.
modules/learn/pages/services-and-indexes/services/backup-service.adoc	Adds a section linking Backup Service to continuous backup/PITR.
modules/learn/pages/data/change-history.adoc	Adds guidance tying change history requirements to continuous backup usage.
modules/learn/pages/clusters-and-availability/hard-failover.adoc	Adds a caution about unsafe failover behavior when continuous backup is enabled.
modules/introduction/partials/new-features-81.adoc	Adds 8.1 release notes bullets for continuous backup + PITR.
modules/install/pages/server-processes.adoc	Documents the `cbcontbk` process and normalizes path formatting in the process table.
modules/install/pages/install-ports.adoc	Adds port 9125 and documents the `cbcontbk` port usage.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

incomplete sentences.

matthallcb · 2026-07-02T16:34:59Z


 TBD.
+
+=== Backup Service


Perhaps this should just be "Backup & Restore" as it isn't to do with the backup service

matthallcb · 2026-07-02T16:36:53Z

+# tag::get-backup-info[]
+| Buckets
+| -------
+| 
+| * Bucket
+|   ------
+|   Name          | UUID                             |
+|   travel-sample | b5de13bdc656985b0a41dd3d832c9be6 |
+|   
+|   Range
+|   -----
+|   Start                | End                  |
+|   2026-06-05T14:57:18Z | 2026-06-23T17:55:22Z |
+|  
+# end::get-backup-info[]


I'm currently adding a change where we show the encryption status, e.g.:

| Buckets | ------- | | * Bucket | ------ | Name | UUID | Encryption | | default | a5b995170807afc74238a6a89fac5072 | full | | | Range | ----- | Start | End | | 2026-07-01T13:48:22+01:00 | 2026-07-01T13:53:29+01:00 |

matthallcb · 2026-07-02T16:55:03Z

+
+. You must set the history retention time for the bucket to a period long enough for continuous backup to collect and save the bucket's history to the backup location.
+This period is 15 minutes or double the continuous backup interval, whichever is longer.
+For example, if you chose 10 minutes for your continuous backup interval, set the retention time to 20 minutes.


Suggested change

For example, if you chose 10 minutes for your continuous backup interval, set the retention time to 20 minutes.

For example, if you chose 10 minutes for your continuous backup interval, set the retention time to at least 20 minutes.

matthallcb · 2026-07-02T16:55:58Z

+. If you entered a cloud storage URI for the Backup Location, choose the credential from the credential store for the Backup Service to use when authenticating with the cloud provider.
+Make sure you have granted access to Backup Service for this credential.
+. If you have enabled encryption at rest for the data in the bucket, enter the URI for the KMS Key.
+Valid URIs start with `awskms`, `azurekeyvalue`, or `gcpkms`.


Suggested change

Valid URIs start with `awskms`, `azurekeyvalue`, or `gcpkms`.

Valid URIs start with `awskms`, `azurekeyvault`, or `gcpkms`.

matthallcb · 2026-07-03T08:03:56Z

+
+The following example enables continuous backup for `travel-sample` bucket. 
+It sets the backup interval to 10 minutes.
+The backup location is an NFS share mounted on each not at the path `/shared.continuous-backup`.


I'm not sure what this sentence is saying

matthallcb · 2026-07-03T08:04:17Z

+* `--continuous-backup-location`: The location where the backup service will store the continuous backup data.
+This value must a string containing either an absolute path to an NFS mount point mounted on every node or a cloud storage URI.
+* `--continuous-backup-cloud-storage-cred-id`: If you set `--continuous-backup-location` to a cloud storage URI, set this to the name of a credential in the Couchbase Server credential store.
+The Backup Service uses this credential to authenticate with the cloud provider.


Let's avoid saying backup service

matthallcb · 2026-07-03T08:04:43Z

+** `--continuous-backup-km-key-url`: The URI for the KMS key the Backup Service uses to manage the encryption key it uses to encrypt data encryption keys. 
+    This URI must start with `awskms`, `azurekeyvalue`, or `gcpkms`.
+** `--continuous-backup-km-cred=id`: the name of a credential in the Couchbase Server credential store that grants the Backup Service access to a KMS to manage its encryption keys.


You have to supply both

matthallcb · 2026-07-03T08:06:06Z

+--
+
+PITR recovery does not flush the bucket before a restore.
+By default, it does not overwrite existing documents already in the bucket.


We should probably mention --force-updates here which will disable conflict resolution, so documents in the backup take precedence over those on the cluster

matthallcb · 2026-07-03T08:06:53Z

+* To prevent consistency issues, stop continuous backup on the bucket you're restoring.
+You must stop continuous backup even if you're not restoring to the original bucket.
+Once the PITR finishes, you can restart continuous backup.
+See xref:manage:manage-backup-and-restore/manage-continuous-backup.adoc#stop-continuous-backup[Stop Continuous Backup] to learn how to stop continuous backup for a bucket.
+


Note for myself: I'm not sure if this is necessary, I need to check

ggray-cb added 7 commits June 24, 2026 13:26

Initial in-progress commit.

c5c08f5

Initial draft pf continuoud backup concepts page. Added note on chang…

1c47291

…e service page.

Draft of the manage continuous backup page.

d743b51

* In progress on managing PITR.

44e4906

* Added minitor continuous backup. * Updated metrics. * Finished draft of manage continuous backup.

Wrapped up draft of PITR page.

0e8a305

Added the port # for cbcontbk to the list of ports and processes in t…

31efbb9

…he install section.

Added link to introduction.

5eec3ce

ggray-cb requested a review from Copilot July 2, 2026 13:14

Copilot started reviewing on behalf of ggray-cb July 2, 2026 13:15 View session

Copilot AI reviewed Jul 2, 2026

View reviewed changes

ggray-cb and others added 20 commits July 2, 2026 09:40

Potential fix for pull request finding

a99d781

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Fixing anchor link

987febd

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Fixing link

ffde6f3

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Typo fix and fixing broken link

e811a87

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Fixing incorrect anchor

19bfd14

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Typo fix

f76f3fd

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Removing stray step

b489b9b

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Typo fix

0a6c053

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Fixing accidental Markdown

f038fb0

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Remove accidental Markdown

5bda019

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Remove duplicate word

c052a8a

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Fixing typo

b25f4ea

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Fixing command name

d23144a

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Fixing typo

fe8d8f4

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Yet more Markdown

f00b611

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Fixing anchor

c62fb79

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Fixing typo

45e4300

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Add missing word

fcd8aff

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Fixing typo

ea725c3

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Yet more markdown

b631d1b

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Standardizing terminology use. Fixing several

05cb3a9

incomplete sentences.

ggray-cb requested review from TimLFletcher, matthallcb, owend74 and shivaniguptasf July 2, 2026 15:16

matthallcb reviewed Jul 3, 2026

View reviewed changes

	For example, if you chose 10 minutes for your continuous backup interval, set the retention time to 20 minutes.
	For example, if you chose 10 minutes for your continuous backup interval, set the retention time to at least 20 minutes.

	Valid URIs start with `awskms`, `azurekeyvalue`, or `gcpkms`.
	Valid URIs start with `awskms`, `azurekeyvault`, or `gcpkms`.

Uh oh!

Conversation

ggray-cb commented Jul 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

ggray-cb commented Jul 2, 2026 •

edited

Loading