Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
c5c08f5
Initial in-progress commit.
ggray-cb Jun 24, 2026
1c47291
Initial draft pf continuoud backup concepts page. Added note on chang…
ggray-cb Jun 25, 2026
d743b51
Draft of the manage continuous backup page.
ggray-cb Jun 29, 2026
44e4906
* In progress on managing PITR.
ggray-cb Jun 30, 2026
0e8a305
Wrapped up draft of PITR page.
ggray-cb Jul 1, 2026
31efbb9
Added the port # for cbcontbk to the list of ports and processes in t…
ggray-cb Jul 1, 2026
5eec3ce
Added link to introduction.
ggray-cb Jul 1, 2026
a99d781
Potential fix for pull request finding
ggray-cb Jul 2, 2026
987febd
Fixing anchor link
ggray-cb Jul 2, 2026
ffde6f3
Fixing link
ggray-cb Jul 2, 2026
e811a87
Typo fix and fixing broken link
ggray-cb Jul 2, 2026
19bfd14
Fixing incorrect anchor
ggray-cb Jul 2, 2026
f76f3fd
Typo fix
ggray-cb Jul 2, 2026
b489b9b
Removing stray step
ggray-cb Jul 2, 2026
0a6c053
Typo fix
ggray-cb Jul 2, 2026
f038fb0
Fixing accidental Markdown
ggray-cb Jul 2, 2026
5bda019
Remove accidental Markdown
ggray-cb Jul 2, 2026
c052a8a
Remove duplicate word
ggray-cb Jul 2, 2026
b25f4ea
Fixing typo
ggray-cb Jul 2, 2026
d23144a
Fixing command name
ggray-cb Jul 2, 2026
fe8d8f4
Fixing typo
ggray-cb Jul 2, 2026
f00b611
Yet more Markdown
ggray-cb Jul 2, 2026
c62fb79
Fixing anchor
ggray-cb Jul 2, 2026
45e4300
Fixing typo
ggray-cb Jul 2, 2026
fcd8aff
Add missing word
ggray-cb Jul 2, 2026
ea725c3
Fixing typo
ggray-cb Jul 2, 2026
b631d1b
Yet more markdown
ggray-cb Jul 2, 2026
05cb3a9
Standardizing terminology use. Fixing several
ggray-cb Jul 2, 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
4 changes: 4 additions & 0 deletions modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down Expand Up @@ -185,6 +186,9 @@ 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[]
Expand Down
12 changes: 10 additions & 2 deletions modules/install/pages/install-ports.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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}

Expand Down Expand Up @@ -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]
Expand Down Expand Up @@ -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
Expand Down
95 changes: 50 additions & 45 deletions modules/install/pages/server-processes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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`
|===
10 changes: 10 additions & 0 deletions modules/introduction/partials/new-features-81.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -61,3 +61,13 @@ TBD.
Couchbase Server 8.1 introduces several new features for the xref:search:search.adoc[Search Service].

TBD.

=== Backup Service

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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


Couchbase Server 8.1 introduces several new features for the xref:backup:backup.adoc[Backup Service].

* The new continuous backup feature supplements traditional periodic backups by frequently backing up changes to Magma buckets.
This backup can limit the loss of data updates that occur between full and incremental backups.
In addition to backing up data, it also backs up timestamps of when the data was updated.
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-and-indexes/services/continuous-backup.adoc[] for more information.
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,10 @@ Note that this restriction also protects the cluster in situations where multipl
[#performing-an-unsafe-failover]
=== Performing an Unsafe Failover

CAUTION: If you have 1 or more buckets using continuous backup, you must stop the Couchbase Server process on the node before performing an unsafe failover on it.
Not stopping the Couchbase Server process could result in data inconsistencies that can cause issues with the continuous backup.
See xref:learn:services-and-indexes/services/continuous-backup.adoc[] for more information.

In Couchbase Server 7.0 or a later version, metadata is managed by a _consensus protocol_; which achieves strong consistency by _synchronously_ replicating metadata to a majority of the nodes before considering it committed.
(This is described in xref:learn:clusters-and-availability/metadata-management.adoc[Metadata Management].)
The metadata so managed includes _topology information_.
Expand Down
5 changes: 5 additions & 0 deletions modules/learn/pages/data/change-history.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,11 @@ See xref:rest-api:rest-bucket-create.adoc[Creating and Editing Buckets].
* The CLI, using `couchbase-cli bucket-create` (to create a bucket) or `couchbase-cli bucket-edit` (to edit a bucket); specifying one or both of the parameters `history-retention-bytes` and `history-retention-seconds`.
See xref:cli:cbcli/couchbase-cli-bucket-create.adoc[bucket-create] and xref:cli:cbcli/couchbase-cli-bucket-edit.adoc[bucket-edit].

IMPORTANT: You must enable change history on any bucket you want to back up using continuous backup.
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 is unsupported.
See xref:learn:services-and-indexes/services/continuous-backup.adoc[] for more information.

[#default-collection-setting]
=== Default Collection-Setting

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,14 @@ To use it on a regular schedule, you must rely on an external scheduling system

See xref:backup-restore:enterprise-backup-restore.adoc[cbbackupmgr] for more information about using the command-line tool.

== The Backup Service and Continuous Backup

In addition to the periodic backups provided by the Backup Service, you can also use the continuous backup agent to frequently back up changes to Magma buckets.
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-and-indexes/services/continuous-backup.adoc[] for more information about using continuous backup.

[#backup-service-architecture]
== Backup Service Architecture

Expand Down
Loading