RedisEnterpriseUser API Reference

Redis Enterprise for Kubernetes

apiVersion:

app.redislabs.com/v1alpha1

RedisEnterpriseUser represents a user definition within a Redis Enterprise Cluster.

Name Type Description Required
apiVersion string app.redislabs.com/v1alpha1 true
kind string RedisEnterpriseUser true
metadata object Refer to the Kubernetes API documentation for the fields of the `metadata` field. true
spec object RedisEnterpriseUserSpec defines the desired state of a RedisEnterpriseUser.
 false
status object RedisEnterpriseUserStatus defines the observed state of a RedisEnterpriseUser.
 false

spec

↩ Parent

RedisEnterpriseUserSpec defines the desired state of a RedisEnterpriseUser.

Name Type Description Required
alerts object Email alerts settings for this user. User alerts settings are effective only when cluster alerts settings are configured.
 false
authMethod enum AuthMethod selects how the user authenticates to Redis Enterprise. 'Basic' (the default) authenticates with Basic Auth, using a password sourced from passwordSecrets. 'Certificate' authenticates with a client certificate whose subject matches certificateSubjectLine; such users carry no password (passwordSecrets must be empty). Certificate users additionally require certificate-based authentication to be configured at the cluster level.

Enum: Basic, Certificate
Default: Basic
 false
certificateSubjectLine string CertificateSubjectLine is the certificate subject line (RFC2253) used to match the client certificate for certificate-auth users. Required when authMethod is 'Certificate'; must not be set otherwise.
 false
email string The email address for the user. Optional (Redis Enterprise accepts an empty email). For password users, changing the email after creation is permitted only while spec.passwordSecrets contains exactly one entry: to change the email of a user with two password secrets (Rotatable rotation in progress), first reduce passwordSecrets to a single entry, change the email, then add the second secret back. Certificate-auth users carry no password, so this restriction does not apply to them.
 false
passwordMode enum Defines how passwords are managed for this user. Single: Only a single password secret can be specified at a time. Passwords changes can be done by mutating the secret in-place, or by replacing the secret reference to point to another secret. Rotatable: Allows for one or two password secrets to be specified simultaneously. The secrets are required to be immutable, and the operator automatically sets their 'immutable: true' attribute (K8s secrets only) if not already set. Vault secrets are assumed to be used as immutable and are not made immutable automatically. Password changes are typically done by adding a new password secret, and later removing the old one when it's no longer needed. When empty, Single behavior is used. Must not be set for certificate-auth users (authMethod: Certificate), which carry no password.

Enum: Single, Rotatable
 false
passwordSecrets []object List of one or more secrets holding the user's password. Each secret must have a key named 'password' with the user's desired password. If multiple secrets are specified, then the passwords from all of them can be used for authenticating as the user. When the user signin status is 'Locked', the user won't be able to authenticate with Redis Enterprise API or UI, and must be unlocked by another user with Admin-role access. To unlock the user, first set a new password via the 'passwordSecrets' field, and then follow the password reset instructions in the following link: https://redis.io/docs/latest/operate/rs/security/access-control/manage-users/login-lockout/#unlock-locked-user-accounts
 false
username string The username associated with the user. The username must be unique within the Redis Enterprise cluster, and include only ASCII characters except &,<,>,". If not specified, a default username is assigned and can be discovered via the status section of the RedisEnterpriseUser.
 false

spec.alerts

↩ Parent

Email alerts settings for this user. User alerts settings are effective only when cluster alerts settings are configured.

Name Type Description Required
enabled boolean Master toggle for email alerts.
 true
clusterAlerts object UserClusterAlertSettings specifies cluster alerts settings for a user.
 false
databaseAlerts object UserDatabaseAlertSettings specifies database alerts settings for a user.
 false

spec.alerts.clusterAlerts

↩ Parent

UserClusterAlertSettings specifies cluster alerts settings for a user.

Name Type Description Required
enabled boolean Determines whether cluster alerts are enabled for the user.
 true

spec.alerts.databaseAlerts

↩ Parent

UserDatabaseAlertSettings specifies database alerts settings for a user.

Name Type Description Required
databases []object The databases for which alerts are enabled for this user. If not specified, defaults to all databases.
 false

spec.alerts.databaseAlerts.databases[]

↩ Parent

A reference to another object.

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

spec.passwordSecrets[]

↩ Parent

A reference to a Secret object.

Name Type Description Required
name string Name of the Secret.
 true

status

↩ Parent

RedisEnterpriseUserStatus defines the observed state of a RedisEnterpriseUser.

Name Type Description Required
conditions []object Conditions represent the latest available observations of the user's state.
 false
observedGeneration integer The most recent generation of this resource that was observed and acted upon by the controller.

Format: int64
 false
passwordIssueDate string The date in which the password was set.
 false
passwordSecrets []object List of secrets holding the user's password, with their versions.
 false
roles []object List of roles assigned to the user.
 false
rolesDisplay string Formatted string representation of the roles assigned to the user.
 false
signinStatus string Sign-in status for the user. When set to 'Locked', the user won't be able to authenticate with Redis Enterprise API or UI, and must be unlocked by another user with Admin-role access. To unlock the user, set a new password via the 'passwordSecrets' field, and then follow the password reset instructions in the following link: https://redis.io/docs/latest/operate/rs/security/access-control/manage-users/login-lockout/#unlock-locked-user-accounts
 false
uid string The internal UID of the User object defined in the Redis Enterprise Cluster.
 false
username string The effective username assigned for the user.
 false

status.conditions[]

↩ Parent

Condition contains details for one aspect of the current state of this API Resource.

Name Type Description Required
lastTransitionTime string lastTransitionTime is the last time the condition transitioned from one status to another.

Format: date-time
 true
status enum status of the condition, one of True, False, Unknown.

Enum: True, False, Unknown
 true
type string type of condition in CamelCase or in foo.example.com/CamelCase.
 true
message string message is a human readable message indicating details about the transition.
 false
observedGeneration integer observedGeneration represents the .metadata.generation that the condition was set based upon.

Format: int64
Minimum: 0
 false
reason string reason contains a programmatic identifier indicating the reason for the condition's last transition.
 false

status.passwordSecrets[]

↩ Parent

A versioned reference to a Secret object.

Name Type Description Required
name string Name of the Secret.
 false
version string Version of the Secret.
 false

status.roles[]

↩ Parent

A reference to another object.

Name Type Description Required
kind string Kind of the referent.
 false
name string Name of the referent.
 false
RATE THIS PAGE
Back to top ↑