Skip to content

New backup annotations in CAO 2-9 #54

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

Merged
rao-shwe merged 1 commit into from
Dec 19, 2025
Merged

New backup annotations in CAO 2-9 #54

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
28 changes: 27 additions & 1 deletion modules/ROOT/pages/reference-annotations.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,4 +70,30 @@ When set to true, the pods will be initialised with the node name as the hostnam
== Cloud Native Gateway
=== OTLP Endpoint
==== `cao.couchbase.com/networking.cloudNativeGateway.otlp.endpoint`
Used to set a custom OTLP endpoint for on Cloud Native Gateway. This annotation is applied to the cluster, and takes a string value (e.g. "https://otel:1234"). The value is passed directly to the Cloud Native Gateway container.

Use this annotation to set a custom OTLP endpoint for the Cloud Native Gateway.
Apply the annotation to the cluster with a string value such as `https://otel:1234`.
The value is passed directly to the Cloud Native Gateway container.

== Backup
=== Additional Args
==== `cao.couchbase.com/full.additionalArgs`

Use this annotation to set additional arguments for `cbbackupmgr` in full backup jobs.
Provide a string that includes any values supported by xref:server:backup-restore/cbbackupmgr-backup.html[`cbbackupmgr`].

==== `cao.couchbase.com/incremental.additionalArgs`

Use this annotation to set additional arguments for `cbbackupmgr` in incremental backup jobs.
Provide a string that includes any values supported by xref:server:backup-restore/cbbackupmgr-backup.html[`cbbackupmgr`].

==== `cao.couchbase.com/merge.additionalArgs`

Use this annotation to set additional arguments for `cbbackupmgr` in merge backup jobs.
Provide a string that includes any values supported by xref:server:backup-restore/cbbackupmgr-backup.html[`cbbackupmgr`].

=== Additional Operator Backup Args
==== `cao.couchbase.com/additionalOperatorBackupArgs`

Use this annotation to set additional arguments for the backup container that are not used by `cbbackupmgr`, for example, `--force-delete-lockfile`.
Provide a string value with the flags to set.
2 changes: 1 addition & 1 deletion preview/HEAD.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ sources:
branches: [release/8.0]

docs-operator:
branches: [DOC-13857-tutorial-to-detect-avx2, release/2.8]
branches: [DOC-13865-new-backup-annotations-cao-2-9-0, release/2.8]