CouchbaseBackup Resource

    +

    CouchbaseBackup allows automatic backup of all data from a Couchbase cluster into persistent storage.

    couchbasebackups.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.

    couchbasebackups.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.

    couchbasebackups.metadata

    Constraints

    Required

    Type: object

    Description

    Standard object metadata as defined for all Kubernetes types.

    For additional details see the Kubernetes reference documentation.

    couchbasebackups.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.

    couchbasebackups.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.

    couchbasebackups.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.

    couchbasebackups.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.

    couchbasebackups.spec

    Constraints

    Required

    Type: object

    Description

    CouchbaseBackupSpec is allows the specification of how a Couchbase backup is configured, including when backups are performed, how long they are retained for, and where they are backed up to.

    couchbasebackups.spec.autoScaling

    Constraints

    Type: object

    Description

    AutoScaling allows the volume size to be dynamically increased. When specified, the backup volume will start with an initial size as defined by spec.size, and increase as required.

    couchbasebackups.spec.autoScaling.incrementPercent

    Constraints

    Type: integer

    Default: 20

    Minimum: 0

    Description

    IncrementPercent controls how much the volume is increased each time the threshold is exceeded, upto a maximum as defined by the limit. This field defaults to 20 if not specified.

    couchbasebackups.spec.autoScaling.limit

    Constraints

    Type: string

    Pattern (Regular Expression): ^(\+|-)?[0-9]+(\.[0-9]*)?)|(\.[0-9]+[KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]\*)?)|(\.[0-9]+))?$

    Description

    Limit imposes a hard limit on the size we can autoscale to. When not specified no bounds are imposed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#resource-units-in-kubernetes.

    couchbasebackups.spec.autoScaling.thresholdPercent

    Constraints

    Type: integer

    Default: 20

    Minimum: 0

    Maximum: 99

    Description

    ThresholdPercent determines the point at which a volume is autoscaled. This represents the percentage of free space remaining on the volume, when less than this threshold, it will trigger a volume expansion. For example, if the volume is 100Gi, and the threshold 20%, then a resize will be triggered when the used capcity exceeds 80Gi, and free space is less than 20Gi. This field defaults to 20 if not specified.

    couchbasebackups.spec.backoffLimit

    Constraints

    Type: integer

    Default: 2

    Description

    Number of times a backup job should try to execute. Once it hits the BackoffLimit it will not run until the next scheduled job.

    couchbasebackups.spec.backupRetention

    Constraints

    Type: string

    Default: 720h

    Description

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

    couchbasebackups.spec.failedJobsHistoryLimit

    Constraints

    Type: integer

    Default: 3

    Minimum: 0

    Description

    Amount of failed jobs to keep.

    couchbasebackups.spec.full

    Constraints

    Type: object

    Description

    Full is the schedule on when to take full backups. Used in Full/Incremental and FullOnly backup strategies.

    couchbasebackups.spec.full.schedule

    Constraints

    Required

    Type: string

    Description

    Schedule takes a cron schedule in string format.

    couchbasebackups.spec.incremental

    Constraints

    Type: object

    Description

    Incremental is the schedule on when to take incremental backups. Used in Full/Incremental backup strategies.

    couchbasebackups.spec.incremental.schedule

    Constraints

    Required

    Type: string

    Description

    Schedule takes a cron schedule in string format.

    couchbasebackups.spec.logRetention

    Constraints

    Type: string

    Default: 168h

    Description

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

    couchbasebackups.spec.s3bucket

    Constraints

    Type: string

    Description

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

    couchbasebackups.spec.size

    Constraints

    Type: string

    Default: 20Gi

    Pattern (Regular Expression): ^(\+|-)?[0-9]+(\.[0-9]*)?)|(\.[0-9]+[KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]\*)?)|(\.[0-9]+))?$

    Description

    Size allows the specification of a backup persistent volume, when using volume based backup. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#resource-units-in-kubernetes.

    couchbasebackups.spec.storageClassName

    Constraints

    Type: string

    Description

    Name of StorageClass to use.

    couchbasebackups.spec.strategy

    Constraints

    Required

    Type: string

    Default: full\_incremental

    Enumerations: full\_incremental, full\_only

    Description

    CB backup strategy - Full/Incremental, Full only. Default: Full/Incremental.

    couchbasebackups.spec.successfulJobsHistoryLimit

    Constraints

    Type: integer

    Default: 3

    Minimum: 0

    Description

    Amount of successful jobs to keep.

    couchbasebackups.spec.threads

    Constraints

    Type: integer

    Default: 1

    Minimum: 1

    Description

    How many threads to use during the backup.

    couchbasebackups.status

    Constraints

    Type: object

    Description

    CouchbaseBackupStatus provides status notifications about the Couchbase backup including when the last backup occurred, whether is succeeded or not, the run time of the backup and the size of the backup.

    couchbasebackups.status.archive

    Constraints

    Type: string

    Description

    Location of Backup Archive.

    couchbasebackups.status.backups

    Constraints

    Type: []object

    Description

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

    couchbasebackups.status.backups.full

    Constraints

    Type: string

    Description

    Full backup inside the repository.

    couchbasebackups.status.backups.incrementals

    Constraints

    Type: []string

    Description

    Incremental backups inside the repository.

    couchbasebackups.status.backups.name

    Constraints

    Required

    Type: string

    Description

    Name of the repository.

    couchbasebackups.status.capacityUsed

    Constraints

    Type: string

    Pattern (Regular Expression): ^(\+|-)?[0-9]+(\.[0-9]*)?)|(\.[0-9]+[KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]\*)?)|(\.[0-9]+))?$

    Description

    couchbasebackups.status.cronjob

    Constraints

    Type: string

    Description

    DEPRECATED - field may no longer be populated.

    Cronjob tells us which Cronjob the job belongs to.

    couchbasebackups.status.duration

    Constraints

    Type: string

    Description

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

    couchbasebackups.status.failed

    Constraints

    Required

    Type: boolean

    Description

    Failed indicates whether the most recent backup has failed.

    couchbasebackups.status.job

    Constraints

    Type: string

    Description

    DEPRECATED - field may no longer be populated.

    Job tells us which job is running/ran last.

    couchbasebackups.status.lastFailure

    Constraints

    Type: string

    Description

    LastFailure tells us the time the last failed backup failed.

    couchbasebackups.status.lastRun

    Constraints

    Type: string

    Description

    LastRun tells us the time the last backup job started.

    couchbasebackups.status.lastSuccess

    Constraints

    Type: string

    Description

    LastSuccess gives us the time the last successful backup finished.

    couchbasebackups.status.output

    Constraints

    Type: string

    Description

    Output reports useful information from the backup_script.

    couchbasebackups.status.pod

    Constraints

    Type: string

    Description

    Pod tells us which pod is running/ran last.

    couchbasebackups.status.repo

    Constraints

    Type: string

    Description

    Repo is where we are currently performing operations.

    couchbasebackups.status.running

    Constraints

    Required

    Type: boolean

    Description

    Running indicates whether a backup is currently being performed.