RedisEnterpriseRole API Reference

Redis Enterprise for Kubernetes

apiVersion:

app.redislabs.com/v1alpha1

RedisEnterpriseRole is a scoped role definition. It grants users access to selected databases within a Redis Enterprise Cluster.

Name Type Description Required
apiVersion string app.redislabs.com/v1alpha1 true
kind string RedisEnterpriseRole true
metadata object Refer to the Kubernetes API documentation for the fields of the `metadata` field. true
spec object RedisEnterpriseRoleSpec defines the desired state of a RedisEnterpriseRole.
 false
status object RedisEnterpriseRoleStatus defines the observed state of a Redis Enterprise role object. This status type is used by both RedisEnterpriseClusterRole and RedisEnterpriseRole which share the same status structure.
 false

spec

↩ Parent

RedisEnterpriseRoleSpec defines the desired state of a RedisEnterpriseRole.

Name Type Description Required
scopes []object Scopes define the databases to which this role applies. Each scope references a RedisEnterpriseDatabase by name or selector (kind RedisEnterpriseDatabase or empty), or an internal Redis Enterprise database by name (kind 'bdb', name only). For 'bdb' scopes the role grants management access only; its ACL is not bound to that database's permissions.
 true
acl object ACL defines the data access permissions granted by this scoped role. References a RedisEnterpriseACL (kind RedisEnterpriseACL or empty) or an internal Redis Enterprise ACL by name (kind 'redis_acl').
 false
managementRole enum ManagementRole is the named set of Redis Enterprise management permissions assigned to this scoped role. RedisEnterpriseRole supports only database-scoped management roles. If omitted, the role uses the None management role.

Enum: DBMember, DBViewer, None
 false

spec.scopes[]

↩ Parent

A reference to another object(s), either directly by name, or via a label selector.

Name Type Description Required
kind enum Kind of the referent.

Enum: , RedisEnterpriseDatabase, bdb
 false
name string Name of the referent.
 false
selector object Selector based on label attached to the object.
 false

spec.scopes[].selector

↩ Parent

Selector based on label attached to the object.

Name Type Description Required
matchExpressions []object matchExpressions is a list of label selector requirements. The requirements are ANDed.
 false
matchLabels map[string]string matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
 false

spec.scopes[].selector.matchExpressions[]

↩ Parent

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name Type Description Required
key string key is the label key that the selector applies to.
 true
operator string operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
 true
values []string values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
 false

spec.acl

↩ Parent

ACL defines the data access permissions granted by this scoped role. References a RedisEnterpriseACL (kind RedisEnterpriseACL or empty) or an internal Redis Enterprise ACL by name (kind 'redis_acl').

Name Type Description Required
name string Name of the referent.
 true
kind enum Kind of the referent.

Enum: , RedisEnterpriseACL, redis_acl
 false

status

↩ Parent

RedisEnterpriseRoleStatus defines the observed state of a Redis Enterprise role object. This status type is used by both RedisEnterpriseClusterRole and RedisEnterpriseRole which share the same status structure.

Name Type Description Required
observedGeneration integer The most recent generation of this resource that was observed and acted upon by the controller.

Format: int64
 false
uid string The internal UID of the Role object defined in the Redis Enterprise Cluster.
 false
RATE THIS PAGE
Back to top ↑