CouchbaseUser Resource
CouchbaseUser allows the automation of Couchbase user management.
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: CouchbaseUser
metadata:
name: ""
spec:
authDomain: ""
authSecret: ""
fullName: ""
locked: false
name: ""
password:
expiresAfter: ""
expiresAt: ""
requireInitialChange: falsecouchbaseusers.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.
couchbaseusers.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.
couchbaseusers.metadata
Description
Standard object metadata as defined for all Kubernetes types.
For additional details see the Kubernetes reference documentation.
couchbaseusers.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.
couchbaseusers.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.
couchbaseusers.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.
couchbaseusers.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.
couchbaseusers.spec
couchbaseusers.spec.authSecret
Description
Name of the Kubernetes Secret that provides the user’s initial password for the Couchbase domain. Once the user is created, changes to this field will be ignored. The initial password must comply with all password policies defined for Couchbase clusters that have RBAC management enabled and for which the user matches the RBAC resource selector.
couchbaseusers.spec.password.expiresAfter
Description
ExpiresAfter allows setting a fixed duration after a user changes their password when they will be required to change their password again. Consider that this duration will be checked against the users last password change date, not the current date and time and could therefore result in the user being required to change their password immediately. This field is only available for Couchbase Server 8.0.0+. More info: https://golang.org/pkg/time/#ParseDuration.
couchbaseusers.spec.password.expiresAt
Description
ExpiresAt allows setting a timestamp when a user’s password will expire. After that timestamp has passed, the user will be required to change their password. If set to a timestamp in the past, the user’s password must have been changed since then or they will be required to change their password. This field is only available for Couchbase Server 8.0.0+.