CouchbaseRoleBinding Resource

The Couchbase Autonomous Operator operates on CouchbaseCluster objects.

CouchbaseRoleBinding resources are analogous to Kubernetes RoleBinding resources.

The following YAML shows all possible fields that may be configured for a CouchbaseRoleBinding. This configuration may not be valid and is only for illustrative purposes.

All available CouchbaseRoleBinding configuration parameters

apiVersion: couchbase.com/v2
kind: CouchbaseRoleBinding
metadata:
  name: my-role-binding
spec:
  subjects:
  - kind: CouchbaseUser
    name: my-user
  roleRef:
    kind: CouchbaseGroup
    name: my-group

Top-Level Definitions

The following are relevant generic parameters that can be defined:

apiVersion: couchbase.com/v2
kind: CouchbaseRoleBinding
metadata:
  name: my-cluster

apiVersion

The apiVersion defines which version of the resource this configuration refers to.

Field rules: This field is required and must be set to couchbase.com/v2

kind

The kind defines the type of resource this configuration refers to.

Field rules: This field is required and must be set to CouchbaseRoleBinding

metadata.name

The metadata name defines the name of the resource. The name must be unique for the kind defined.

Field rules: This field is required and must be unique as described above.

spec

The following are parameters that may be set on the rolebinding:

spec:
  subjects:
  - kind: CouchbaseUser
    name: my-user
  roleRef:
    kind: CouchbaseGroup
    name: my-group

spec.subjects[]

This field is a list of subjects to a apply role to.

spec.subjects[].kind

This defines the the type of resource to apply the role to.

Field rules: This field is required and must be either CouchbaseUser or CouchbaseGroup.

spec.subjects[].name

This defines the the name of the resource to apply the role to.

Field rules: This field is required and must be the name of an existing CouchbaseUser or CouchbaseGroup.

spec.roleRef.kind

This field defines the type of resource to extract the roles from.

Field rules: This field is required and must be CouchbaseGroup.

spec.roleRef.name

This defines the the name of the resource to extract the roles from.

Field rules: This field is required and must be the name of an existing CouchbaseGroup.