CouchbaseScope Resource
CouchbaseScope represents a logical unit of data storage that sits between buckets and
collections e.g.
a bucket may contain multiple scopes, and a scope may contain multiple
collections.
At present, scopes are not nested, so provide only a single level of
abstraction.
Scopes provide a coarser grained basis for role-based access control (RBAC)
and cross-datacenter replication (XDCR) than collections, but finer that buckets.
In order to be considered by the Operator, a scope must be referenced by either a
CouchbaseBucket or CouchbaseEphemeralBucket resource.
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.):
apiVersion: v2
kind: CouchbaseScope
metadata:
name: ""
spec:
collections:
managed: false
preserveDefaultCollection: false
resources:
- kind: CouchbaseCollection
name: ""
selector: {}
defaultScope: false
name: ""couchbasescopes.apiVersion
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.
couchbasescopes.kind
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.
couchbasescopes.metadata
Description
Standard object metadata as defined for all Kubernetes types.
For additional details see the Kubernetes reference documentation.
couchbasescopes.metadata.name
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.
couchbasescopes.metadata.namespace
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.
couchbasescopes.metadata.labels
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.
couchbasescopes.metadata.annotations
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.
couchbasescopes.spec
couchbasescopes.spec.collections.preserveDefaultCollection
Description
PreserveDefaultCollection indicates whether the Operator should manage the
default collection within the default scope.
The default collection can
be deleted, but can not be recreated by Couchbase Server.
By setting this
field to true, the Operator will implicitly manage the default collection
within the default scope.
The default collection cannot be modified and
will have no document time-to-live (TTL).
When set to false, the operator
will not manage the default collection, which will be deleted and cannot be
used or recreated.
couchbasescopes.spec.collections.resources.kind
couchbasescopes.spec.collections.resources.name
couchbasescopes.spec.collections.selector
Description
Selector allows resources to be implicitly considered for inclusion in this scope or scopes. More info: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#labelselector-v1-meta.
couchbasescopes.spec.defaultScope
Description
DefaultScope indicates whether this resource represents the default scope
for a bucket.
When set to true, this allows the user to refer to and
manage collections within the default scope.
When not defined, the Operator
will implicitly manage the default scope as the default scope can not be
deleted from Couchbase Server.
The Operator defined default scope will
also have the persistDefaultCollection flag set to true.
Only one
default scope is permitted to be contained in a bucket.
couchbasescopes.spec.name
Constraints
Type: string
Minimum Length: 1
Maximum Length: 251
Pattern (Regular Expression): ^[a-zA-Z0-9\-][a-zA-Z0-9\-%_]{0,250}$
Description
Name specifies the name of the scope.
By default, the metadata.name is
used to define the scope name, however, due to the limited character set,
this field can be used to override the default and provide the full functionality.
Additionally the metadata.name field is a DNS label, and thus limited to 63
characters, this field must be used if the name is longer than this limit.
Scope names must be 1-251 characters in length, contain only [a-zA-Z0-9_-%]
and not start with either _ or %.