Skip to content

K8S-4415 Added docs for new backup annotations #53

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

Closed
Lumin343 wants to merge 1 commit into from
Closed

K8S-4415 Added docs for new backup annotations #53

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
17 changes: 16 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,19 @@ 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.
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.

== Backup
=== Additional Args
==== `cao.couchbase.com/full.additionalArgs`
Used to set additional args for cbbackupmgr for full backup jobs. This takes a string with any value(s) supported by https://docs.couchbase.com/server/current/backup-restore/cbbackupmgr-backup.html[cbbackupmgr].

==== `cao.couchbase.com/incremental.additionalArgs`
Used to set additional args for cbbackupmgr for incremental backup jobs. This takes a string with any value(s) supported by https://docs.couchbase.com/server/current/backup-restore/cbbackupmgr-backup.html[cbbackupmgr].

==== `cao.couchbase.com/merge.additionalArgs`
Used to set additional args for cbbackupmgr for merge backup jobs. This takes a string with any value(s) supported by https://docs.couchbase.com/server/current/backup-restore/cbbackupmgr-backup.html[cbbackupmgr].

=== Additional Operator Backup Args
==== `cao.couchbase.com/additionalOperatorBackupArgs`
Used to set additional args for the backup container that are not used by cbbackupmgr (e.g. `--force-delete-lockfile`). This takes a string value with the flags that will be set.
Loading