DOC-12561 Continuous backup and PITR

antora.yml

@@ -1,10 +1,10 @@
 name: server
-version: '8.0'
+version: '8.1'
 asciidoc:
   attributes:
     ui-name: Server Web Console
     product-name: Server
-# prerelease: Prerelease
+prerelease: Prerelease
 title: Couchbase Server
 start_page: introduction:intro.adoc
 nav:

modules/ROOT/nav.adoc

@@ -61,6 +61,7 @@ include::third-party:partial$nav.adoc[]
  ** xref:learn:services-and-indexes/services/analytics-service.adoc[Analytics Service]
  ** xref:learn:services-and-indexes/services/eventing-service.adoc[Eventing Service]
  ** xref:learn:services-and-indexes/services/backup-service.adoc[Backup Service]
+ *** xref:learn:services-and-indexes/services/continuous-backup.adoc[Continuous Backup & PITR]
 * xref:learn:clusters-and-availability/clusters-and-availability.adoc[Clusters and Availability]
  ** xref:learn:clusters-and-availability/cluster-manager.adoc[Cluster Manager]
  ** xref:learn:clusters-and-availability/metadata-management.adoc[Metadata Management]
@@ -76,6 +77,7 @@ include::third-party:partial$nav.adoc[]
    **** xref:learn:clusters-and-availability/graceful-failover.adoc[Graceful]
    **** xref:learn:clusters-and-availability/hard-failover.adoc[Hard]
    **** xref:learn:clusters-and-availability/automatic-failover.adoc[Automatic]
+  *** xref:learn:clusters-and-availability/unstable-nodes.adoc[]
   *** xref:learn:clusters-and-availability/recovery.adoc[Recovery]
   *** xref:learn:clusters-and-availability/node-to-node-encryption.adoc[Node-to-Node Encryption]
  ** xref:learn:clusters-and-availability/replication-architecture.adoc[Availability]
@@ -88,6 +90,7 @@ include::third-party:partial$nav.adoc[]
     **** xref:learn:clusters-and-availability/xdcr-conflict-logging-feature.adoc[XDCR Conflict Logging]
       ***** xref:learn:clusters-and-availability/xdcr-viewing-conflict-logs.adoc[Viewing Conflict Logs]
     **** xref:learn:clusters-and-availability/xdcr-active-active-sgw.adoc[XDCR Active-Active with Sync Gateway]
+    **** xref:xdcr-reference:xdcr-lowering-memory-footprint.adoc[]
   *** xref:learn:clusters-and-availability/groups.adoc[Server Group Awareness]
 * xref:learn:security/security-overview.adoc[Security]
  ** xref:learn:security/authentication.adoc[Authentication]
@@ -183,9 +186,13 @@ include::third-party:partial$nav.adoc[]
   *** xref:backup-restore:cbbackupmgr-cloud.adoc[Cloud Backup]
   *** xref:backup-restore:cbbackupmgr-network-filesystems.adoc[Network Filesystems]
   *** xref:backup-restore:cbbackupmgr-encryption.adoc[Encryption]
+ ** xref:manage:manage-backup-and-restore/manage-continuous-backup.adoc[]
+ ** xref:manage:manage-backup-and-restore/monitor-continuous-backup.adoc[]
+ ** xref:manage:manage-backup-and-restore/manage-pitr.adoc[]
 * xref:manage:monitor/monitor-intro.adoc[Monitor]
  ** xref:manage:monitor/xdcr-monitor-timestamp-conflict-resolution.adoc[Monitor Clock Drift]
- ** xref:manage:monitor/set-up-prometheus-for-monitoring.adoc[Configure Prometheus to Collect Couchbase Metrics]
+ ** xref:manage:monitor/set-up-prometheus-for-monitoring.adoc[]
+ ** xref:manage:monitor/monitor-node-stability.adoc[]
 * xref:manage:troubleshoot/troubleshoot.adoc[Troubleshoot]
  ** xref:manage:troubleshoot/common-errors.adoc[Common Errors]
  ** xref:manage:troubleshoot/core-files.adoc[Core Files]
@@ -430,6 +437,7 @@ include::cli:partial$cbcli/nav.adoc[]
    *** xref:rest-api:rest-compact-post.adoc[Performing Compaction Manually]
    *** xref:rest-api:rest-autocompact-global.adoc[Auto-Compaction: Global]
    *** xref:rest-api:rest-autocompact-per-bucket.adoc[Auto-Compaction: Per Bucket]
+   *** xref:rest-api:rest-magma-compression-per-bucket.adoc[Magma Compression]
 
    ** xref:rest-api:rest-rza.adoc[Server Groups API]
     *** xref:rest-api:rest-servergroup-get.adoc[Getting Group Information]

modules/install/pages/install-ports.adoc

@@ -70,7 +70,7 @@ The following table lists all port numbers, grouped by category of communication
 | Communication Path | Default Ports
 
 | _Node-local only_
-| *Unencrypted*: 9119, 9998, 11213, 21200, 21300
+| *Unencrypted*: 9119, 9125, 9998, 11213, 21200, 21300
 
 *Encrypted*: 21250 {fn-encrypted-traffic-port}, 21350 {fn-encrypted-communication-port}
 
@@ -99,7 +99,7 @@ a| *Unencrypted*: 8091-8096, 9102, 11210
 [NOTE]
 ====
 `cbbackupmgr`, the backup client, connects to the Couchbase Server using the ports listed above.
-You can find detailed information about the server ports in the xref:detailed-port-description[Detailed Port Description].
+You can find detailed information about the server ports in the <<detailed-port-description>>.
 Below is a summary of the services cbbackupmgr is accessing via the ports.
 
 [horizontal]
@@ -351,6 +351,14 @@ The following table contains a detailed description of each port used by Couchba
 | No
 | No
 
+| `cbcontbk`
+| 9125
+| Continuous backup 
+| No
+| No
+| No
+
+
 | `fts_grpc_port` / `fts_grpc_ssl_port`
 | 9130 / 19130
 a| Search Service gRPC port used for xref:learn:services-and-indexes/services/search-service.adoc[scatter-gather] operations between FTS nodes

modules/install/pages/server-processes.adoc

@@ -26,121 +26,126 @@ The following table lists the Couchbase processes that run on Linux platforms.
 
 | Process | Description | Service | Path
 
+| `cbcontbk`
+| The continuous backup agent.
+| Backup
+| `/opt/couchbase/bin`
+
 | `cbft`
 | Couchbase Full-Text Search (FTS) service
 | Search
-| _/opt/couchbase/bin/_
+| `/opt/couchbase/bin/`
 
 | `cbq-engine`
 | Couchbase Query service
 | Query
-| _/opt/couchbase/bin/_
+| `/opt/couchbase/bin/`
 
 | `goport` (5 copies)
 | Process that acts as a bridge between `ns_server` (Erlang) and the other server components (`cbq- engine`, `cbft`, etc.) which are written in Go
 | Query
-| _/opt/couchbase/bin/_
+| `/opt/couchbase/bin/`
 
 | `gosecrets`
 | Service that is used to encrypt the cluster configuration stored on disk
 | Data
-| _/opt/couchbase/bin/_
+| `/opt/couchbase/bin/`
 
 | `goxdcr`
 | Cross Data Center Replication (XDCR) - replicates data from one cluster to another
 | Data
-| _/opt/couchbase/bin/_
+| `/opt/couchbase/bin/`
 
 | `indexer`
 | Index service
 | Index
-| _/opt/couchbase/bin/_
+| `/opt/couchbase/bin/`
 
 | `memcached`
 | Data service responsible for storing user data
 | Data
-| _/opt/couchbase/bin/_
+| `/opt/couchbase/bin/`
 
 | `godu` (2 copies)
 | Utility in Go to get disk usage stats
 | Data
-| _/opt/couchbase/bin/priv/_
+| `/opt/couchbase/bin/priv/`
 
 | `projector`
 | Extracts secondary key from documents
 | Data
-| _/opt/couchbase/bin/_
+| `/opt/couchbase/bin/`
 
 | `saslauthd-port`
 | Erlang port process (wrapper) used to talk to the `saslauthd` daemon for authentication purposes
 | Data
-| _/opt/couchbase/bin/_
+| `/opt/couchbase/bin/`
 
 | `beam.smp` (3 copies)
 | Couchbase cluster manager run as Erlang virtual machines - `babysitter`, `ns_server`, and `ns_couchdb`
 | Data
-| _/opt/couchbase/lib/erlang/erts-9.3.3.9/bin/_
+| `/opt/couchbase/lib/erlang/erts-9.3.3.9/bin/`
 
 | `epmd`
 | Erlang-specific process which acts as a name server for Erlang distribution
 | Data
-| _/opt/couchbase/bin/_
+| `/opt/couchbase/bin/`
 
 | `cpu_sup` (2 copies)
 | Erlang-specific process used to collect CPU: 1 for `ns_server` VM and 1 for `ns_couchdb` VM
 | Data
-| _/opt/couchbase/lib/erlang/lib/os_mon-2.2.14/priv/bin/_
+| `/opt/couchbase/lib/erlang/lib/os_mon-2.2.14/priv/bin/`
 
 | `memsup` (2 copies)
 | Erlang-specific process used to collect memory usage: 1 for `ns_server` VM and 1 for `ns_couchdb` VM
 | Data
-| _/opt/couchbase/lib/erlang/lib/os_mon-2.2.14/priv/bin/_
+| `/opt/couchbase/lib/erlang/lib/os_mon-2.2.14/priv/bin/`
 
 | `inet_gethost` (2 copies)
 | Built-in Erlang port process that is used to perform name service lookup
 | Data
-| _/opt/couchbase/lib/erlang/erts-5.10.4.0.0.1/bin/_
+| `/opt/couchbase/lib/erlang/erts-5.10.4.0.0.1/bin/`
 
 | `portsigar`
 | Open source tool sigar that is used to collect system information
 | Data
-| _/opt/couchbase/bin/_
+| `/opt/couchbase/bin/`
 
 | `sh -s disksup` (2 copies)
 | Erlang-specific process that is used to supervise the available disk space: 1 for `ns_server` VM and 1 for `ns_couchdb` VM
 | Data
-| _/opt/couchbase/lib/erlang/lib/os_mon-2.2.14/ebin/_
+| `/opt/couchbase/lib/erlang/lib/os_mon-2.2.14/ebin/`
 
 | `sh -s ns_disksup`
 | Wrapper for `disksup` which also collects information about mounted drives
 | Data
-| _/opt/couchbase/lib/ns_server/erlang/lib/ns_server/ebin/_
+| `/opt/couchbase/lib/ns_server/erlang/lib/ns_server/ebin/`
 
 | `cbcollect_info`
 | Utility used to collect Couchbase server logs (will be seen only during log collection)
 | Data
-| _/opt/couchbase/bin/_
+| `/opt/couchbase/bin/`
 
 | `eventing-producer` (1 copy)
 | Eventing supervisor service (one instance per node)
 | Eventing
-| _/opt/couchbase/bin/_
+| `/opt/couchbase/bin/`
 
 | `eventing-consumer` (n copies)
 | Eventing worker (multiple instances per node).
 Instance count is configured in UI.
 | Eventing
-| _/opt/couchbase/bin/_
+| `/opt/couchbase/bin/`
 
 | `java` (Analytics Driver)
 | JVM running the Analytics NC and CC
 | Analytics
-| _/opt/couchbase/lib/cbas/runtime/bin_
+| `/opt/couchbase/lib/cbas/runtime/bin`
 
 | `cbas`
 | Go-wrapper that communicates with `ns_server` and manages the lifecycle of the Analytics Driver
 | Analytics
-| _/opt/couchbase/bin/_
+| `/opt/couchbase/bin/`
 |===
 
 == Windows
@@ -156,112 +161,112 @@ The following table lists the Couchbase processes that run on the Windows platfo
 | `backup.exe`
 | Backup application for Couchbase data
 | Backup
-| _C:\Program Files\Couchbase\Server\bin_
+| `C:\Program Files\Couchbase\Server\bin`
 
 | `cbas.exe`
 | Go-wrapper that communicates with `ns_server` and manages the lifecycle of the Analytics Driver
 | Analytics
-| _C:\Program Files\Couchbase\Server\bin_
+| `C:\Program Files\Couchbase\Server\bin`
 
 | `cbcollect_info.exe`
 | Utility used to collect Couchbase server logs (will be seen only during log collection)
 | Data
-| _C:\Program Files\Couchbase\Server\bin_
+| `C:\Program Files\Couchbase\Server\bin`
 
 | `cbft.exe`
 | Couchbase Full-Text Search (FTS) service
 | Search
-| _C:\Program Files\Couchbase\Server\bin_
+| `C:\Program Files\Couchbase\Server\bin`
 
 | `cbq-engine.exe`
 | Couchbase Query service
 | Query
-| _C:\Program Files\Couchbase\Server\bin_
+| `C:\Program Files\Couchbase\Server\bin`
 
 | `epmd.exe`
 | Erlang-specific process which acts as a name server for Erlang distribution
 | Data
-| _C:\Program Files\Couchbase\Server\erts-x.x.x.x\bin_
+| `C:\Program Files\Couchbase\Server\erts-x.x.x.x\bin`
 
 | `erl.exe`
 | Erlang process used by the name server.
 | Data
-| _C:\Program Files\Couchbase\Server\erts-x.x.x.x\bin_
+| `C:\Program Files\Couchbase\Server\erts-x.x.x.x\bin`
 
 | `erlsrv.exe`
 | Used to start the Erlang emulator as a Windows process.
 | Data
-| _C:\Program Files\Couchbase\Server\erts-x.x.x.x\bin_
+| `C:\Program Files\Couchbase\Server\erts-x.x.x.x\bin`
 
 | `eventing-consumer.exe` 
 | Eventing worker (multiple instances per node).
 Instance count is configured in UI.
 | Eventing
-| _C:\Program Files\Couchbase\Server\bin_
+| `C:\Program Files\Couchbase\Server\bin`
 
 | `eventing-producer.exe` 
 | Eventing supervisor service (one instance per node)
 | Eventing
-| _C:\Program Files\Couchbase\Server\bin_
+| `C:\Program Files\Couchbase\Server\bin`
 
 | `goport.exe` 
 | Process that acts as a bridge between `ns_server` (Erlang) and the other server components (`cbq- engine.exe`, `cbft.exe`, etc.)
 | Query
-| _C:\Program Files\Couchbase\Server\bin_
+| `C:\Program Files\Couchbase\Server\bin`
 
 | `gosecrets.exe`
 | Service that is used to encrypt the cluster configuration stored on disk
 | Data
-| _C:\Program Files\Couchbase\Server\bin_
+| `C:\Program Files\Couchbase\Server\bin`
 
 | `goxdcr.exe`
 | Cross Data Center Replication (XDCR) - replicates data from one cluster to another
 | Data
-| _C:\Program Files\Couchbase\Server\bin_
+| `C:\Program Files\Couchbase\Server\bin`
 
 | `indexer.exe`
 | Index service
 | Index
-| _C:\Program Files\Couchbase\Server\bin_
+| `C:\Program Files\Couchbase\Server\bin`
 
 | `godu.exe` 
 | Utility in Go to get disk usage stats
 | Data
-| _C:\Program Files\Couchbase\Server\bin\priv_
+| `C:\Program Files\Couchbase\Server\bin\priv`
 
 | `inet_gethost.exe`
 | Built-in Erlang port process that is used to perform name service lookup
 | Data
-| _C:\Program Files\Couchbase\Server\erts-x.x.x.x\bin_
+| `C:\Program Files\Couchbase\Server\erts-x.x.x.x\bin`
 
 
 | `java.exe` (Analytics Driver)
 | JVM running the Analytics NC and CC
 | Analytics
-| _C:\Program Files\Couchbase\Server\bin_
+| `C:\Program Files\Couchbase\Server\bin`
 
 | `memcached.exe`
 | Data service responsible for storing user data
 | Data
-| _C:\Program Files\Couchbase\Server\bin_
+| `C:\Program Files\Couchbase\Server\bin`
 
 | `projector.exe`
 | Extracts secondary key from documents
 | Data
-| _C:\Program Files\Couchbase\Server\bin_
+| `C:\Program Files\Couchbase\Server\bin`
 
 | `prometheus.exe`
 | Engine used Couchbase for creating metrics.
 | Data
-| _C:\Program Files\Couchbase\Server\bin_
+| `C:\Program Files\Couchbase\Server\bin`
 
 | `saslauthd-port.exe`
 | Erlang port process (wrapper) used to talk to the `saslauthd` daemon for authentication purposes
 | Data
-| _C:\Program Files\Couchbase\Server\bin_
+| `C:\Program Files\Couchbase\Server\bin`
 
 | `sigar_port.exe`
 | Open source tool sigar that is used to collect system information
 | Data
-| _C:\Program Files\Couchbase\Server\bin_
+| `C:\Program Files\Couchbase\Server\bin`
 |===