CouchbaseReplication Resource

      +

      The CouchbaseReplication resource represents a Couchbase-to-Couchbase, XDCR replication stream from a source bucket to a destination bucket. This provides off-site backup, migration, and disaster recovery.

      The following is an example resource, depicting the overall structure and any defaults (consult the field reference for valid values for "empty" values, such as empty strings etc.):

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

      couchbasereplications.explicitMapping

      Constraints

      Type: object

      Description

      The explicit mappings to use for replication which are optional. For Scopes and Collection replication support we can specify a set of implicit and explicit mappings to use. If none is specified then it is assumed to be existing bucket level replication. https://docs.couchbase.com/server/current/learn/clusters-and-availability/xdcr-with-scopes-and-collections.html#explicit-mapping.

      couchbasereplications.explicitMapping.allowRules

      Constraints

      Type: []object

      Description

      The list of explicit replications to carry out including any nested implicit replications: specifying a scope implicitly replicates all collections within it. There should be no duplicates, including more-specific duplicates, e.g. if you specify replication of a scope then you can only deny replication of collections within it.

      couchbasereplications.explicitMapping.allowRules.sourceKeyspace

      Constraints

      Required

      Type: object

      Description

      The source keyspace: where to replicate from. Source and target must match whether they have a collection or not, i.e. you cannot replicate from a scope to a collection.

      couchbasereplications.explicitMapping.allowRules.sourceKeyspace.collection

      Constraints

      Type: string

      Minimum Length: 1

      Maximum Length: 251

      Pattern (Regular Expression): ^(default|[a-zA-Z0-9\-][a-zA-Z0-9\-%]\{0,250})$

      Description

      The optional collection within the scope. May be empty to just work at scope level.

      couchbasereplications.explicitMapping.allowRules.sourceKeyspace.scope

      Constraints

      Required

      Type: string

      Minimum Length: 1

      Maximum Length: 251

      Pattern (Regular Expression): ^(default|[a-zA-Z0-9\-][a-zA-Z0-9\-%]\{0,250})$

      Description

      The scope to use.

      couchbasereplications.explicitMapping.allowRules.targetKeyspace

      Constraints

      Required

      Type: object

      Description

      The target keyspace: where to replicate to. Source and target must match whether they have a collection or not, i.e. you cannot replicate from a scope to a collection.

      couchbasereplications.explicitMapping.allowRules.targetKeyspace.collection

      Constraints

      Type: string

      Minimum Length: 1

      Maximum Length: 251

      Pattern (Regular Expression): ^(default|[a-zA-Z0-9\-][a-zA-Z0-9\-%]\{0,250})$

      Description

      The optional collection within the scope. May be empty to just work at scope level.

      couchbasereplications.explicitMapping.allowRules.targetKeyspace.scope

      Constraints

      Required

      Type: string

      Minimum Length: 1

      Maximum Length: 251

      Pattern (Regular Expression): ^(default|[a-zA-Z0-9\-][a-zA-Z0-9\-%]\{0,250})$

      Description

      The scope to use.

      couchbasereplications.explicitMapping.denyRules

      Constraints

      Type: []object

      Description

      The list of explicit replications to prevent including any nested implicit denials: specifying a scope implicitly denies all collections within it. There should be no duplicates, including more-specific duplicates, e.g. if you specify denial of replication of a scope then you can only specify replication of collections within it.

      couchbasereplications.explicitMapping.denyRules.sourceKeyspace

      Constraints

      Required

      Type: object

      Description

      The source keyspace: where to block replication from.

      couchbasereplications.explicitMapping.denyRules.sourceKeyspace.collection

      Constraints

      Type: string

      Minimum Length: 1

      Maximum Length: 251

      Pattern (Regular Expression): ^(default|[a-zA-Z0-9\-][a-zA-Z0-9\-%]\{0,250})$

      Description

      The optional collection within the scope. May be empty to just work at scope level.

      couchbasereplications.explicitMapping.denyRules.sourceKeyspace.scope

      Constraints

      Required

      Type: string

      Minimum Length: 1

      Maximum Length: 251

      Pattern (Regular Expression): ^(default|[a-zA-Z0-9\-][a-zA-Z0-9\-%]\{0,250})$

      Description

      The scope to use.

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

      couchbasereplications.metadata

      Constraints

      Required

      Type: object

      Description

      Standard object metadata as defined for all Kubernetes types.

      For additional details see the Kubernetes reference documentation.

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

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

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

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

      couchbasereplications.spec

      Constraints

      Required

      Type: object

      Description

      CouchbaseReplicationSpec allows configuration of an XDCR replication.

      couchbasereplications.spec.bucket

      Constraints

      Required

      Type: string

      Maximum Length: 100

      Pattern (Regular Expression): ^[a-zA-Z0-9-_%\.]\{1,100}$

      Description

      Bucket is the source bucket to replicate from. This refers to the Couchbase bucket name, not the resource name of the bucket. A bucket with this name must be defined on this cluster. Legal bucket names have a maximum length of 100 characters and may be composed of any character from "a-z", "A-Z", "0-9" and "-_%\.".

      couchbasereplications.spec.compressionType

      Constraints

      Type: string

      Default: Auto

      Enumerations: None, Auto

      Description

      CompressionType is the type of compression to apply to the replication. When None, no compression will be applied to documents as they are transferred between clusters. When Auto, Couchbase server will automatically compress documents as they are transferred to reduce bandwidth requirements. This field must be one of "None" or "Auto", defaulting to "Auto".

      couchbasereplications.spec.filterExpression

      Constraints

      Type: string

      Description

      FilterExpression allows certain documents to be filtered out of the replication.

      couchbasereplications.spec.paused

      Constraints

      Type: boolean

      Description

      Paused allows a replication to be stopped and restarted without having to restart the replication from the beginning.

      couchbasereplications.spec.remoteBucket

      Constraints

      Required

      Type: string

      Maximum Length: 100

      Pattern (Regular Expression): ^[a-zA-Z0-9-_%\.]\{1,100}$

      Description

      RemoteBucket is the remote bucket name to synchronize to. This refers to the Couchbase bucket name, not the resource name of the bucket. Legal bucket names have a maximum length of 100 characters and may be composed of any character from "a-z", "A-Z", "0-9" and "-_%\.".