Please use the form below to provide your feedback. Because your feedback is valuable to us, the information you submit in this form is recorded in our issue tracking system (JIRA), which is publicly available. You can track the status of your feedback using the ticket number displayed in the dialog once you submit the form.

A newer version of this documentation is available.

View Latest

CouchbaseBackupRestore Resource

      +

      CouchbaseBackupRestore allows the restoration of all Couchbase cluster data from a CouchbaseBackup resource.

      couchbasebackuprestores.apiVersion

      Constraints

      Type: string

      Description

      APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources.

      couchbasebackuprestores.kind

      Constraints

      Type: string

      Description

      Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds.

      couchbasebackuprestores.metadata

      Constraints

      Required

      Type: object

      Description

      Standard object metadata as defined for all Kubernetes types.

      For additional details see the Kubernetes reference documentation.

      couchbasebackuprestores.metadata.name

      Constraints

      Type: string

      Description

      The name of a resource. This must be unique for the kind of resource within the namespace.

      All resources must have a name. The name may be omitted and metadata.generateName used instead to generate a unique resource name.

      For additional details on resource names, see the Kubernetes reference documentation.

      couchbasebackuprestores.metadata.namespace

      Constraints

      Type: string

      Description

      The namespace the resource resides in. All resources reside in a namespace.

      The namespace is optional and may be specified in YAML configuration to override the namespace supplied by kubectl.

      For additional details on namespaces, see the Kubernetes reference documentation.

      couchbasebackuprestores.metadata.labels

      Constraints

      Type: map[string]string

      Description

      Labels allow resources to be labeled with key/value pairs of data. Labels are indexed and allow resources to be selected based upon specified labels.

      Labels are relevant for certain types when using label selection within your resources.

      For additional details on labels and selectors, see the Kubernetes reference documentation.

      couchbasebackuprestores.metadata.annotations

      Constraints

      Type: map[string]string

      Description

      Annotations allow resources to be annotated with key/value pairs of data. Annotations are arbitrary, and not indexed, so cannot be used to select resources, however may be used to add context or accounting to your resources.

      For additional details on annotations, see the Kubernetes reference documentation.

      couchbasebackuprestores.spec

      Constraints

      Required

      Type: object

      Description

      CouchbaseBackupRestoreSpec allows the specification of data restoration to be configured. This includes the backup and repository to restore data from, and the time range of data to be restored.

      couchbasebackuprestores.spec.backoffLimit

      Constraints

      Type: integer

      Default: 2

      Description

      Number of times the restore job should try to execute.

      couchbasebackuprestores.spec.backup

      Constraints

      Required

      Type: string

      Description

      The backup resource name associated with this restore, or the backup PVC we want to restore from.

      couchbasebackuprestores.spec.buckets

      Constraints

      Type: object

      Default: {}

      Description

      Specific buckets can be explicitly included or excluded in the restore, as well as bucket mappings.

      couchbasebackuprestores.spec.buckets.bucketMap

      Constraints

      Type: []object

      Description

      Maps a backup bucket to a destination bucket that has a different name than the bucket that was originally backed up. This parameter takes a list of mappings since multiple buckets may be restored at the same time. Each bucket mapping is separated by an "=" If we have two buckets, bucket-1 and bucket-2, and we want to restore them to renamed-1 and renamed-2 then we would denote the mapping as "bucket-1=renamed-1,bucket-2=renamed-2". This option will only restore data to the Data service and will not restore the metadata for any other service.

      couchbasebackuprestores.spec.buckets.bucketMap.destination

      Constraints

      Required

      Type: string

      Description

      Destination is the destination bucket name in the Couchbase cluster.

      couchbasebackuprestores.spec.buckets.bucketMap.source

      Constraints

      Required

      Type: string

      Description

      Source is the source bucket name in the backup.

      couchbasebackuprestores.spec.buckets.exclude

      Constraints

      Type: []string

      Description

      Exclude stops the restoration of the named buckets defined in this list. Bucket names refer to the Couchbase bucket name, which may be that of the bucket’s resource name, or the name defined in the bucket specification if overidden.

      couchbasebackuprestores.spec.buckets.include

      Constraints

      Type: []string

      Description

      Include restores only the named buckets defined in this list. Bucket names refer to the Couchbase bucket name, which may be that of the bucket’s resource name, or the name defined in the bucket specification if overidden.

      couchbasebackuprestores.spec.end

      Constraints

      Type: object

      Description

      End denotes the last backup to restore from. Omitting this field will only restore the backup referenced by start.

      couchbasebackuprestores.spec.end.int

      Constraints

      Type: integer

      Minimum: 1

      Description

      Int references a relative backup by index.

      couchbasebackuprestores.spec.end.str

      Constraints

      Type: string

      Description

      Str references an absolute backup by name.

      couchbasebackuprestores.spec.logRetention

      Constraints

      Type: string

      Default: 168h

      Description

      Number of hours to hold restore script logs for, everything older will be deleted. More info: https://golang.org/pkg/time/#ParseDuration.

      couchbasebackuprestores.spec.repo

      Constraints

      Type: string

      Description

      Repo is the backup folder to restore from.

      couchbasebackuprestores.spec.s3bucket

      Constraints

      Type: string

      Description

      Name of S3 bucket to restore from. If non-empty this overrides local backup.

      couchbasebackuprestores.spec.services

      Constraints

      Type: object

      Default: {}

      Description

      This list accepts a certain set of parameters that will disable that data and prevent it being restored.

      couchbasebackuprestores.spec.services.analytics

      Constraints

      Type: boolean

      Default: True

      Description

      Analytics restores analytics datasets from the backup. This field defaults to true.

      couchbasebackuprestores.spec.services.bucketConfig

      Constraints

      Type: boolean

      Description

      BucketConfig restores all bucket configuration settings. If you are restoring to cluster with managed buckets, then this option may conflict with existing bucket settings, and the results are undefined, so avoid use. This option is intended for use with unmanaged buckets. Note that bucket durability settings are not restored in versions less than and equal to 1.1.0, and will need to be manually applied. This field defaults to false.

      couchbasebackuprestores.spec.services.data

      Constraints

      Type: boolean

      Default: True

      Description

      Data restores document data from the backup. This field defaults to true.

      couchbasebackuprestores.spec.services.eventing

      Constraints

      Type: boolean

      Default: True

      Description

      Eventing restores eventing functions from the backup. This field defaults to true.

      couchbasebackuprestores.spec.services.ftAlias

      Constraints

      Type: boolean

      Default: True

      Description

      FTAlias restores full-text search aliases from the backup. This field defaults to true.

      couchbasebackuprestores.spec.services.ftIndex

      Constraints

      Type: boolean

      Default: True

      Description

      FTIndex restores full-text search indexes from the backup. This field defaults to true.

      couchbasebackuprestores.spec.services.gsiIndex

      Constraints

      Type: boolean

      Default: True

      Description

      GSIIndex restores document indexes from the backup. This field defaults to true.

      couchbasebackuprestores.spec.services.views

      Constraints

      Type: boolean

      Default: True

      Description

      Views restores views from the backup. This field defaults to true.

      couchbasebackuprestores.spec.start

      Constraints

      Required

      Type: object

      Description

      Start denotes the first backup to restore from.

      couchbasebackuprestores.spec.start.int

      Constraints

      Type: integer

      Minimum: 1

      Description

      Int references a relative backup by index.

      couchbasebackuprestores.spec.start.str

      Constraints

      Type: string

      Description

      Str references an absolute backup by name.

      couchbasebackuprestores.spec.threads

      Constraints

      Type: integer

      Default: 1

      Minimum: 1

      Description

      How many threads to use during the restore.

      couchbasebackuprestores.status

      Constraints

      Type: object

      Description

      CouchbaseBackupRestoreStatus provides status indications of a restore from backup. This includes whether or not the restore is running, whether the restore succeed or not, and the duration the restore took.

      couchbasebackuprestores.status.archive

      Constraints

      Type: string

      Description

      Location of Backup Archive.

      couchbasebackuprestores.status.backups

      Constraints

      Type: []object

      Description

      Backups gives us a full list of all backups and their respective repository locations.

      couchbasebackuprestores.status.backups.full

      Constraints

      Type: string

      Description

      Full backup inside the repository.

      couchbasebackuprestores.status.backups.incrementals

      Constraints

      Type: []string

      Description

      Incremental backups inside the repository.

      couchbasebackuprestores.status.backups.name

      Constraints

      Required

      Type: string

      Description

      Name of the repository.

      couchbasebackuprestores.status.duration

      Constraints

      Type: string

      Description

      Duration tells us how long the last restore took. More info: https://golang.org/pkg/time/#ParseDuration.

      couchbasebackuprestores.status.failed

      Constraints

      Required

      Type: boolean

      Description

      Failed indicates whether the most recent restore has failed.

      couchbasebackuprestores.status.job

      Constraints

      Type: string

      Description

      DEPRECATED - field may no longer be populated.

      Job tells us which job is running/ran last.

      couchbasebackuprestores.status.lastFailure

      Constraints

      Type: string

      Description

      LastFailure tells us the time the last failed restore failed.

      couchbasebackuprestores.status.lastRun

      Constraints

      Type: string

      Description

      LastRun tells us the time the last restore job started.

      couchbasebackuprestores.status.lastSuccess

      Constraints

      Type: string

      Description

      LastSuccess gives us the time the last successful restore finished.

      couchbasebackuprestores.status.output

      Constraints

      Type: string

      Description

      Output reports useful information from the backup process.

      couchbasebackuprestores.status.pod

      Constraints

      Type: string

      Description

      Pod tells us which pod is running/ran last.

      couchbasebackuprestores.status.repo

      Constraints

      Type: string

      Description

      Repo is where we are currently performing operations.

      couchbasebackuprestores.status.running

      Constraints

      Required

      Type: boolean

      Description

      Running indicates whether a restore is currently being performed.