DOC-12561 Continuous backup and PITR#4137
Closed
ggray-cb wants to merge 14 commits into
Closed
Conversation
… Channel Length (#4107) * [DOC-13921]: XDCR: Tuners to Throttle DCP Control Flow & Async Events Channel Length Documented XDCR settings for throttling DCP control flow and asynchronous event channel length. Added new reference page and updated navigation. Signed-off-by: Ray Offiah <ray.offiah@couchbase.com> * Update modules/xdcr-reference/pages/xdcr-lowering-memory-footprint.adoc Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update modules/xdcr-reference/pages/xdcr-lowering-memory-footprint.adoc Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update modules/rest-api/pages/rest-xdcr-adv-settings.adoc Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * [DOC-13921]: XDCR: Tuners to Throttle DCP Control Flow & Async Events Channel Length Documented XDCR settings for throttling DCP control flow and asynchronous event channel length. Added new reference page and updated navigation. Signed-off-by: Ray Offiah <ray.offiah@couchbase.com> * [DOC-13921]: XDCR: Tuners to Throttle DCP Control Flow & Async Events Channel Length Fixes following review Signed-off-by: Ray Offiah <ray.offiah@couchbase.com> --------- Signed-off-by: Ray Offiah <ray.offiah@couchbase.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Adds documentation for the cm_node_unreachable_total metric. The following list summarizes the changes, with links to the preview site. You will need the Docs Team credentials on Confluence. * Added a What's New entry. * Added a new conceptual page: Unstable Nodes. * Added a new guide page: Monitor Node Stability. * Added a new entry in the Common Errors page. * Added a new section in Failover that describes unstable nodes. This is more to catch the "why isn't this node failing over?" sort of questions.
* Added minitor continuous backup. * Updated metrics. * Finished draft of manage continuous backup.
…he install section.
There was a problem hiding this comment.
Pull request overview
This PR updates the Server docs to the 8.1 documentation set and adds/updates content for continuous backup + PITR, new/updated REST APIs, metrics metadata, and operational guidance (node stability / XDCR tuning).
Changes:
- Bump documentation versioning to 8.1 and adjust preview build configs accordingly.
- Add new conceptual + operational docs for Continuous Backup/PITR and Unstable Nodes, and wire them into navigation.
- Expand REST API and metrics reference content (new endpoints/pages plus substantial metrics metadata updates).
Reviewed changes
Copilot reviewed 36 out of 39 changed files in this pull request and generated 26 comments.
Show a summary per file
| File | Description |
|---|---|
| preview/HEAD.yml | Updates preview build sources/branches for 8.1 and adjusts included repos. |
| preview/DOC-13717_REST_API_for_appTelemetry.yml | Removes an obsolete per-branch preview config. |
| preview/DOC-12561_Continuous_backup_PITR.yml | Adds a dedicated preview config for the Continuous Backup/PITR work. |
| modules/xdcr-reference/pages/xdcr-lowering-memory-footprint.adoc | Adds new XDCR guidance for lowering memory footprint via global settings. |
| modules/ROOT/nav.adoc | Wires new pages (continuous backup, unstable nodes, XDCR memory footprint, etc.) into the main nav. |
| modules/rest-api/partials/rest-memory-and-storage-table.adoc | Adds a REST table entry for Magma compression per-bucket API. |
| modules/rest-api/pages/rest-xdcr-adv-settings.adoc | Updates XDCR advanced settings docs (example payload + new settings described). |
| modules/rest-api/pages/rest-magma-compression-per-bucket.adoc | Adds a new REST API page describing Magma compression settings per bucket. |
| modules/metrics-reference/partials/metrics.hbs | Updates metrics template output to add anchors for metric keys. |
| modules/metrics-reference/attachments/n1ql_metrics_metadata.json | Adds/adjusts N1QL metrics metadata for newer versions. |
| modules/metrics-reference/attachments/kv_metrics_metadata.json | Large KV metrics metadata refresh (new metrics + corrections). |
| modules/metrics-reference/attachments/index_metrics_metadata.json | Adds new Index Service metrics metadata entries. |
| modules/metrics-reference/attachments/goxdcr_metrics_metadata.json | Adds new XDCR metrics and clarifies existing metric descriptions. |
| modules/metrics-reference/attachments/fts_metrics_metadata.json | Adds new FTS metrics and refines some help text. |
| modules/metrics-reference/attachments/cm_metrics_metadata.json | Adds new Cluster Manager metrics and expands encryption-at-rest metric labels. |
| modules/manage/pages/troubleshoot/common-errors.adoc | Adds troubleshooting guidance for unstable nodes based on log patterns/metrics. |
| modules/manage/pages/monitor/set-up-prometheus-for-monitoring.adoc | Adds page metadata (:page-topic-type:) to the Prometheus setup guide. |
| modules/manage/pages/monitor/monitor-node-stability.adoc | Adds a new guide for monitoring unstable nodes (Prometheus + REST stats API). |
| modules/manage/pages/manage-xdcr/xdcr-management-overview.adoc | Refactors and updates the XDCR management overview prose and notes. |
| modules/manage/pages/manage-backup-and-restore/monitor-continuous-backup.adoc | Adds a new guide for monitoring continuous backup status. |
| modules/manage/pages/manage-backup-and-restore/manage-pitr.adoc | Adds a new guide for performing point-in-time recovery using cbcontbk. |
| modules/manage/pages/manage-backup-and-restore/manage-continuous-backup.adoc | Adds a new guide for configuring continuous backup (UI/CLI/REST). |
| modules/manage/examples/continuous-backup.sh | Adds example commands used by the new continuous backup/PITR docs. |
| modules/manage/examples/continuous-backup.log | Adds example output used by the new continuous backup/PITR docs. |
| modules/learn/pages/services-and-indexes/services/continuous-backup.adoc | Adds a new conceptual overview page for continuous backup and PITR. |
| modules/learn/pages/services-and-indexes/services/backup-service.adoc | Adds a section describing how Backup Service relates to continuous backup. |
| modules/learn/pages/data/change-history.adoc | Adds an IMPORTANT note about change history requirements for continuous backup. |
| modules/learn/pages/clusters-and-availability/unstable-nodes.adoc | Adds a new concept page explaining unstable nodes and the key metric. |
| modules/learn/pages/clusters-and-availability/hard-failover.adoc | Adds a caution about unsafe failover when continuous backup is enabled. |
| modules/learn/pages/clusters-and-availability/failover.adoc | Adds a section on detecting unstable nodes and links to the new docs. |
| modules/introduction/partials/new-features-81.adoc | Adds an 8.1 “new features” partial (currently includes placeholders). |
| modules/introduction/partials/new-features-80.adoc | Removes the 8.0 “new features” partial. |
| modules/introduction/pages/whats-new.adoc | Updates “What’s New” page to 8.1 and includes the 8.1 partial. |
| modules/introduction/pages/editions.adoc | Expands/updates edition descriptions and adds usage-info footnote. |
| modules/install/pages/server-processes.adoc | Adds cbcontbk and modernizes path formatting. |
| modules/install/pages/install-ports.adoc | Adds the cbcontbk port and updates a cross-reference. |
| antora.yml | Bumps component version to 8.1 and marks the docs as prerelease. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| This backup can limit the loss of data updates that occur between full and incremental backups. | ||
| It also records the timestamps of when data was mutated. | ||
| These timestamps let you perform Point-In-Time Recovery (PITR) to restore the Magma bucket's data to the state it was in at a specific moment. | ||
| See xref:learn:services/continuous-backup.adoc[] for more information about using continuous backup. |
Comment on lines
+52
to
+55
| IMPORTANT: You must enable change history on any bucket you want to back up using continuous backup on. | ||
| Once you enable continuous backup, you cannot turn off change history for the bucket unless you turn off continuous backup first. | ||
| Using collection-level overrides of change history in a bucket where you have enabled continuous backup us unsupported. | ||
| See xref:learn:services/continuous-backup.adoc[] for more information. |
| See xref:manage-backup-and-restore.adoc[] to learn how to configure intermittent backups. | ||
|
|
||
| * You must have a shared location where continuous backup can store its backup data. | ||
| All node in the cluster must be able to reach this location. |
Comment on lines
+168
to
+171
| . Click *Advanced Bucket Settings*. | ||
| . Under | ||
| . Under Continuous Backup, select *Enable*. | ||
| . Enter the location to store the continuous backup data. |
Comment on lines
+264
to
+268
| ## Stop Continuous Backup | ||
|
|
||
| Once enabled, you can stop continuous backup for a bucket. | ||
| You must must continuous backups before you do a PITR to prevent a backup from occurring during the restore. | ||
| You may also want to stop it to preserve the PITR recovery window that's currently in the continuous backup location. |
Comment on lines
+84
to
+88
| "errors": { | ||
| "magmaEnableDataBlockAutotuning": "Value \"ten\" must be a boolean value (true/false, on/off)" | ||
| }, | ||
|
|
||
| } |
| "kv_ep_dcp_backfill_idle_protection_enabled": { | ||
| "added": "7.0.0", | ||
| "help": "When true, DCP backfills will be checked for progress. Any backfill which makes no progress for dcp_backfill_idle_limit_seconds will be subject to further checks. If the directory referenced by dbname is over dcp_backfill_idle_disk_threshold percent used and cancelling the backfill will free disk space, the scan cancels and the associated DCP stream will end with reason slow.", | ||
| "help": "When true, DCP backfills will be checked for progress. Any backfill which makes no progress for dcp_backfill_idle_limit_seconds will be subject to further checks. If the directory referenced by dbname is over dcp_backfill_idle_disk_threshold percent used and cancelling the backfill will free disk space, the scan cancels and the associated DCP stream will end with reason slow. This is ignored for emphemeral buckets", |
Comment on lines
+4
to
+6
| Couchbase Server 8.1 adds support for the following operating systems: | ||
|
|
||
| * TBD |
Comment on lines
+781
to
784
| "help": "Number of microseconds of most recent commit", | ||
| "stability": "committed", | ||
| "type": "gauge", | ||
| "unit": "seconds" |
Comment on lines
+788
to
791
| "help": "Cumulative microseconds spent committing", | ||
| "stability": "committed", | ||
| "type": "gauge", | ||
| "unit": "seconds" |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.