RedisEnterpriseActiveActiveDatabase API Reference
apiVersion:
app.redislabs.com/v1alpha1
RedisEnterpriseActiveActiveDatabase is the Schema for the redisenterpriseactiveactivedatabase API
Name | Type | Description | Required |
---|---|---|---|
apiVersion | string | app.redislabs.com/v1alpha1 | true |
kind | string | RedisEnterpriseActiveActiveDatabase | true |
metadata | object | Refer to the Kubernetes API documentation for the fields of the `metadata` field. | true |
spec | object |
RedisEnterpriseActiveActiveDatabaseSpec defines the desired state of RedisEnterpriseActiveActiveDatabase |
false |
status | object |
RedisEnterpriseActiveActiveDatabaseStatus defines the observed state of RedisEnterpriseActiveActiveDatabase |
false |
spec
RedisEnterpriseActiveActiveDatabaseSpec defines the desired state of RedisEnterpriseActiveActiveDatabase
Name | Type | Description | Required |
---|---|---|---|
participatingClusters | []object |
The list of instances/ clusters specifications and configurations. |
true |
globalConfigurations | object |
The Active-Active database global configurations, contains the global properties for each of the participating clusters/ instances databases within the Active-Active database. |
false |
redisEnterpriseCluster | object |
Connection to Redis Enterprise Cluster |
false |
spec.participatingClusters[]
Name | Type | Description | Required |
---|---|---|---|
name | string |
The name of the remote cluster CR to link. |
true |
spec.globalConfigurations
The Active-Active database global configurations, contains the global properties for each of the participating clusters/ instances databases within the Active-Active database.
Name | Type | Description | Required |
---|---|---|---|
activeActive | object |
Connection/ association to the Active-Active database. |
false |
alertSettings | object |
Settings for database alerts |
false |
backup | object |
Target for automatic database backups. |
false |
clientAuthenticationCertificates | []string |
The Secrets containing TLS Client Certificate to use for Authentication |
false |
dataInternodeEncryption | boolean |
Internode encryption (INE) setting. An optional boolean setting, overriding a similar cluster-wide policy. If set to False, INE is guaranteed to be turned off for this DB (regardless of cluster-wide policy). If set to True, INE will be turned on, unless the capability is not supported by the DB ( in such a case we will get an error and database creation will fail). If left unspecified, will be disabled if internode encryption is not supported by the DB (regardless of cluster default). Deleting this property after explicitly setting its value shall have no effect. |
false |
databasePort | integer |
Database port number. TCP port on which the database is available. Will be generated automatically if omitted. can not be changed after creation |
false |
databaseSecretName | string |
The name of the secret that holds the password to the database (redis databases only). If secret does not exist, it will be created. To define the password, create an opaque secret and set the name in the spec. The password will be taken from the value of the 'password' key. Use an empty string as value within the secret to disable authentication for the database. Notes - For Active-Active databases this secret will not be automatically created, and also, memcached databases must not be set with a value, and a secret/password will not be automatically created for them. Use the memcachedSaslSecretName field to set authentication parameters for memcached databases. |
false |
defaultUser | boolean |
Is connecting with a default user allowed? If disabled, the DatabaseSecret will not be created or updated |
false |
evictionPolicy | string |
Database eviction policy. see more https://docs.redislabs.com/latest/rs/administering/database-operations/eviction-policy/ |
false |
isRof | boolean |
Whether it is an RoF database or not. Applicable only for databases of type "REDIS". Assumed to be false if left blank. |
false |
memcachedSaslSecretName | string |
Credentials used for binary authentication in memcached databases. The credentials should be saved as an opaque secret and the name of that secret should be configured using this field. For username, use 'username' as the key and the actual username as the value. For password, use 'password' as the key and the actual password as the value. Note that connections are not encrypted. |
false |
memorySize | string |
memory size of database. use formats like 100MB, 0.1GB. minimum value in 100MB. When redis on flash (RoF) is enabled, this value refers to RAM+Flash memory, and it must not be below 1GB. |
false |
modulesList | []object |
List of modules associated with database. Note - For Active-Active databases this feature is currently in preview. For this feature to take effect for Active-Active databases, set a boolean environment variable with the name "ENABLE_ALPHA_FEATURES" to True. This variable can be set via the redis-enterprise-operator pod spec, or through the operator-environment-config Config Map. |
false |
ossCluster | boolean |
OSS Cluster mode option. Note that not all client libraries support OSS cluster mode. |
false |
persistence | enum |
Database on-disk persistence policy Enum: disabled, aofEverySecond, aofAlways, snapshotEvery1Hour, snapshotEvery6Hour, snapshotEvery12Hour |
false |
proxyPolicy | string |
The policy used for proxy binding to the endpoint. Supported proxy policies are: single/all-master-shards/all-nodes When left blank, the default value will be chosen according to the value of ossCluster - single if disabled, all-master-shards when enabled |
false |
rackAware | boolean |
Whether database should be rack aware. This improves availability - more information: https://docs.redislabs.com/latest/rs/concepts/high-availability/rack-zone-awareness/ |
false |
redisEnterpriseCluster | object |
Connection to Redis Enterprise Cluster |
false |
redisVersion | string |
Redis OSS version. Version can be specified via |
false |
replicaSources | []object |
What databases to replicate from |
false |
replication | boolean |
In-memory database replication. When enabled, database will have replica shard for every master - leading to higher availability. Defaults to false. |
false |
resp3 | boolean |
Whether this database supports RESP3 protocol. Note - Deleting this property after explicitly setting its value shall have no effect. Please view the corresponding field in RS doc for more info. |
false |
rofRamSize | string |
The size of the RAM portion of an RoF database. Similarly to "memorySize" use formats like 100MB, 0.1GB It must be at least 10% of combined memory size (RAM+Flash), as specified by "memorySize". |
false |
rolesPermissions | []object |
List of Redis Enteprise ACL and Role bindings to apply |
false |
shardCount | integer |
Number of database server-side shards |
false |
shardingEnabled | boolean |
Toggles database sharding for REAADBs (Active Active databases) and enabled by default. This field is blocked for REDB (non-Active Active databases) and sharding is toggled via the shardCount field - when shardCount is 1 this is disabled otherwise enabled. |
false |
shardsPlacement | string |
Control the density of shards - should they reside on as few or as many nodes as possible. Available options are "dense" or "sparse". If left unset, defaults to "dense". |
false |
tlsMode | enum |
Require SSL authenticated and encrypted connections to the database. enabled - all incoming connections to the Database must use SSL. disabled - no incoming connection to the Database should use SSL. replica_ssl - databases that replicate from this one need to use SSL. Enum: disabled, enabled, replica_ssl |
false |
type | enum |
The type of the database. Enum: redis, memcached |
false |
upgradeSpec | object |
Specifications for DB upgrade. |
false |
spec.globalConfigurations.activeActive
Connection/ association to the Active-Active database.
Name | Type | Description | Required |
---|---|---|---|
name | string |
The the corresponding Active-Active database name, Redis Enterprise Active Active Database custom resource name, this Resource is associated with. In case this resource is created manually at the active active database creation this field must be filled via the user, otherwise, the operator will assign this field automatically. Note: this feature is currently unsupported. |
true |
participatingClusterName | string |
The corresponding participating cluster name, Redis Enterprise Remote Cluster custom resource name, in the Active-Active database, In case this resource is created manually at the active active database creation this field must be filled via the user, otherwise, the operator will assign this field automatically. Note: this feature is currently unsupported. |
true |
spec.globalConfigurations.alertSettings
Settings for database alerts
Name | Type | Description | Required |
---|---|---|---|
bdb_backup_delayed | object |
Periodic backup has been delayed for longer than specified threshold value [minutes] |
false |
bdb_crdt_src_high_syncer_lag | object |
Active-active source - sync lag is higher than specified threshold value [seconds] |
false |
bdb_crdt_src_syncer_connection_error | object |
Active-active source - sync has connection error while trying to connect replica source |
false |
bdb_crdt_src_syncer_general_error | object |
Active-active source - sync encountered in general error |
false |
bdb_high_latency | object |
Latency is higher than specified threshold value [micro-sec] |
false |
bdb_high_throughput | object |
Throughput is higher than specified threshold value [requests / sec.] |
false |
bdb_long_running_action | object |
An alert for state-machines that are running for too long |
false |
bdb_low_throughput | object |
Throughput is lower than specified threshold value [requests / sec.] |
false |
bdb_ram_dataset_overhead | object |
Dataset RAM overhead of a shard has reached the threshold value [% of its RAM limit] |
false |
bdb_ram_values | object |
Percent of values kept in a shard's RAM is lower than [% of its key count] |
false |
bdb_replica_src_high_syncer_lag | object |
Replica-of source - sync lag is higher than specified threshold value [seconds] |
false |
bdb_replica_src_syncer_connection_error | object |
Replica-of source - sync has connection error while trying to connect replica source |
false |
bdb_shard_num_ram_values | object |
Number of values kept in a shard's RAM is lower than [values] |
false |
bdb_size | object |
Dataset size has reached the threshold value [% of the memory limit] |
false |
spec.globalConfigurations.alertSettings.bdb_backup_delayed
Periodic backup has been delayed for longer than specified threshold value [minutes]
Name | Type | Description | Required |
---|---|---|---|
enabled | boolean |
Alert enabled or disabled |
true |
threshold | string |
Threshold for alert going on/off |
true |
spec.globalConfigurations.alertSettings.bdb_crdt_src_high_syncer_lag
Active-active source - sync lag is higher than specified threshold value [seconds]
Name | Type | Description | Required |
---|---|---|---|
enabled | boolean |
Alert enabled or disabled |
true |
threshold | string |
Threshold for alert going on/off |
true |
spec.globalConfigurations.alertSettings.bdb_crdt_src_syncer_connection_error
Active-active source - sync has connection error while trying to connect replica source
Name | Type | Description | Required |
---|---|---|---|
enabled | boolean |
Alert enabled or disabled |
true |
threshold | string |
Threshold for alert going on/off |
true |
spec.globalConfigurations.alertSettings.bdb_crdt_src_syncer_general_error
Active-active source - sync encountered in general error
Name | Type | Description | Required |
---|---|---|---|
enabled | boolean |
Alert enabled or disabled |
true |
threshold | string |
Threshold for alert going on/off |
true |
spec.globalConfigurations.alertSettings.bdb_high_latency
Latency is higher than specified threshold value [micro-sec]
Name | Type | Description | Required |
---|---|---|---|
enabled | boolean |
Alert enabled or disabled |
true |
threshold | string |
Threshold for alert going on/off |
true |
spec.globalConfigurations.alertSettings.bdb_high_throughput
Throughput is higher than specified threshold value [requests / sec.]
Name | Type | Description | Required |
---|---|---|---|
enabled | boolean |
Alert enabled or disabled |
true |
threshold | string |
Threshold for alert going on/off |
true |
spec.globalConfigurations.alertSettings.bdb_long_running_action
An alert for state-machines that are running for too long
Name | Type | Description | Required |
---|---|---|---|
enabled | boolean |
Alert enabled or disabled |
true |
threshold | string |
Threshold for alert going on/off |
true |
spec.globalConfigurations.alertSettings.bdb_low_throughput
Throughput is lower than specified threshold value [requests / sec.]
Name | Type | Description | Required |
---|---|---|---|
enabled | boolean |
Alert enabled or disabled |
true |
threshold | string |
Threshold for alert going on/off |
true |
spec.globalConfigurations.alertSettings.bdb_ram_dataset_overhead
Dataset RAM overhead of a shard has reached the threshold value [% of its RAM limit]
Name | Type | Description | Required |
---|---|---|---|
enabled | boolean |
Alert enabled or disabled |
true |
threshold | string |
Threshold for alert going on/off |
true |
spec.globalConfigurations.alertSettings.bdb_ram_values
Percent of values kept in a shard's RAM is lower than [% of its key count]
Name | Type | Description | Required |
---|---|---|---|
enabled | boolean |
Alert enabled or disabled |
true |
threshold | string |
Threshold for alert going on/off |
true |
spec.globalConfigurations.alertSettings.bdb_replica_src_high_syncer_lag
Replica-of source - sync lag is higher than specified threshold value [seconds]
Name | Type | Description | Required |
---|---|---|---|
enabled | boolean |
Alert enabled or disabled |
true |
threshold | string |
Threshold for alert going on/off |
true |
spec.globalConfigurations.alertSettings.bdb_replica_src_syncer_connection_error
Replica-of source - sync has connection error while trying to connect replica source
Name | Type | Description | Required |
---|---|---|---|
enabled | boolean |
Alert enabled or disabled |
true |
threshold | string |
Threshold for alert going on/off |
true |
spec.globalConfigurations.alertSettings.bdb_shard_num_ram_values
Number of values kept in a shard's RAM is lower than [values]
Name | Type | Description | Required |
---|---|---|---|
enabled | boolean |
Alert enabled or disabled |
true |
threshold | string |
Threshold for alert going on/off |
true |
spec.globalConfigurations.alertSettings.bdb_size
Dataset size has reached the threshold value [% of the memory limit]
Name | Type | Description | Required |
---|---|---|---|
enabled | boolean |
Alert enabled or disabled |
true |
threshold | string |
Threshold for alert going on/off |
true |
spec.globalConfigurations.backup
Target for automatic database backups.
Name | Type | Description | Required |
---|---|---|---|
abs | object |
|
false |
ftp | object |
|
false |
gcs | object |
GoogleStorage |
false |
interval | integer |
Backup Interval in seconds |
false |
mount | object |
MountPointStorage |
false |
s3 | object |
|
false |
sftp | object |
|
false |
swift | object |
|
false |
spec.globalConfigurations.backup.abs
Name | Type | Description | Required |
---|---|---|---|
absSecretName | string |
The name of the secret that holds ABS credentials. The secret must contain the keys "AccountName" and "AccountKey", and these must hold the corresponding credentials |
true |
container | string |
Azure Blob Storage container name. |
true |
subdir | string |
Optional. Azure Blob Storage subdir under container. |
false |
spec.globalConfigurations.backup.ftp
Name | Type | Description | Required |
---|---|---|---|
url | string |
a URI of the "ftps://[USER[:PASSWORD]@]HOST[:PORT]/PATH[/]" format |
true |
spec.globalConfigurations.backup.gcs
GoogleStorage
Name | Type | Description | Required |
---|---|---|---|
bucketName | string |
Google Storage bucket name. |
true |
gcsSecretName | string |
The name of the secret that holds the Google Cloud Storage credentials. The secret must contain the keys "CLIENT_ID", "PRIVATE_KEY", "PRIVATE_KEY_ID", "CLIENT_EMAIL" and these must hold the corresponding credentials. The keys should correspond to the values in the key JSON. |
true |
subdir | string |
Optional. Google Storage subdir under bucket. |
false |
spec.globalConfigurations.backup.mount
MountPointStorage
Name | Type | Description | Required |
---|---|---|---|
path | string |
Path to the local mount point. You must create the mount point on all nodes, and the redislabs:redislabs user must have read and write permissions on the local mount point. |
true |
spec.globalConfigurations.backup.s3
Name | Type | Description | Required |
---|---|---|---|
awsSecretName | string |
The name of the secret that holds the AWS credentials. The secret must contain the keys "AWS_ACCESS_KEY_ID" and "AWS_SECRET_ACCESS_KEY", and these must hold the corresponding credentials. |
true |
bucketName | string |
Amazon S3 bucket name. |
true |
subdir | string |
Optional. Amazon S3 subdir under bucket. |
false |
spec.globalConfigurations.backup.sftp
Name | Type | Description | Required |
---|---|---|---|
sftpSecretName | string |
The name of the secret that holds SFTP credentials. The secret must contain the "Key" key, which is the SSH private key for connecting to the sftp server. |
true |
sftp_url | string |
SFTP url |
true |
spec.globalConfigurations.backup.swift
Name | Type | Description | Required |
---|---|---|---|
auth_url | string |
Swift service authentication URL. |
true |
container | string |
Swift object store container for storing the backup files. |
true |
swiftSecretName | string |
The name of the secret that holds Swift credentials. The secret must contain the keys "Key" and "User", and these must hold the corresponding credentials: service access key and service user name (pattern for the latter does not allow special characters &,<,>,") |
true |
prefix | string |
Optional. Prefix (path) of backup files in the swift container. |
false |
spec.globalConfigurations.modulesList[]
Redis Enterprise Module: https://redislabs.com/redis-enterprise/modules/
Name | Type | Description | Required |
---|---|---|---|
name | string |
The module's name e.g "ft" for redissearch |
true |
config | string |
Module command line arguments e.g. VKEY_MAX_ENTITY_COUNT 30 |
false |
uid | string |
Module's uid - do not set, for system use only nolint:staticcheck // custom json tag unknown to the linter |
false |
version | string |
Module's semantic version e.g "1.6.12" - optional only in REDB, must be set in REAADB |
false |
spec.globalConfigurations.redisEnterpriseCluster
Connection to Redis Enterprise Cluster
Name | Type | Description | Required |
---|---|---|---|
name | string |
The name of the Redis Enterprise Cluster where the database should be stored. |
true |
spec.globalConfigurations.replicaSources[]
Name | Type | Description | Required |
---|---|---|---|
replicaSourceName | string |
The name of the resource from which the source database URI is derived. The type of resource must match the type specified in the ReplicaSourceType field. |
true |
replicaSourceType | string |
The type of resource from which the source database URI is derived. If set to 'SECRET', the source database URI is derived from the secret named in the ReplicaSourceName field. The secret must have a key named 'uri' that defines the URI of the source database in the form of 'redis://...'. The type of secret (kubernetes, vault, ...) is determined by the secret mechanism used by the underlying REC object. If set to 'REDB', the source database URI is derived from the RedisEnterpriseDatabase resource named in the ReplicaSourceName field. |
true |
clientKeySecret | string |
Secret that defines the client certificate and key used by the syncer in the target database cluster. The secret must have 2 keys in its map: "cert" which is the PEM encoded certificate, and "key" which is the PEM encoded private key. |
false |
compression | integer |
GZIP compression level (0-6) to use for replication. |
false |
serverCertSecret | string |
Secret that defines the server certificate used by the proxy in the source database cluster. The secret must have 1 key in its map: "cert" which is the PEM encoded certificate. |
false |
tlsSniName | string |
TLS SNI name to use for the replication link. |
false |
spec.globalConfigurations.rolesPermissions[]
Redis Enterprise Role and ACL Binding
Name | Type | Description | Required |
---|---|---|---|
acl | string |
Acl Name of RolePermissionType (note: use exact name of the ACL from the Redis Enterprise ACL list, case sensitive) |
true |
role | string |
Role Name of RolePermissionType (note: use exact name of the role from the Redis Enterprise role list, case sensitive) |
true |
type | string |
Type of Redis Enterprise Database Role Permission |
true |
spec.globalConfigurations.upgradeSpec
Specifications for DB upgrade.
Name | Type | Description | Required |
---|---|---|---|
upgradeModulesToLatest | boolean |
Upgrades the modules to the latest version that supportes the DB version during a DB upgrade action, to upgrade the DB version view the 'redisVersion' field. Note - This field is currently not supported for Active-Active databases. |
true |
spec.redisEnterpriseCluster
Connection to Redis Enterprise Cluster
Name | Type | Description | Required |
---|---|---|---|
name | string |
The name of the Redis Enterprise Cluster where the database should be stored. |
true |
status
RedisEnterpriseActiveActiveDatabaseStatus defines the observed state of RedisEnterpriseActiveActiveDatabase
Name | Type | Description | Required |
---|---|---|---|
guid | string |
The active-active database corresponding GUID. |
false |
lastTaskUid | string |
The last active-active database task UID. |
false |
linkedRedbs | []string |
The linked REDBs. |
false |
participatingClusters | []object |
The list of instances/ clusters statuses. |
false |
redisEnterpriseCluster | string |
The Redis Enterprise Cluster Object this Resource is associated with |
false |
replicationStatus | enum |
The overall replication status Enum: up, down |
false |
secretsStatus | []object |
The status of the secrets |
false |
specStatus | string |
Whether the desired specification is valid |
false |
status | string |
The status of the active active database. |
false |
status.participatingClusters[]
Status of participating cluster.
Name | Type | Description | Required |
---|---|---|---|
name | string |
The name of the remote cluster CR that is linked. |
true |
id | integer |
The corresponding ID of the instance in the active-active database. Format: int64 |
false |
replicationStatus | enum |
The replication status of the participating cluster Enum: up, down |
false |
status.secretsStatus[]
Status of secrets.
Name | Type | Description | Required |
---|---|---|---|
name | string |
The name of the secret. |
true |
status | enum |
The status of the secret. Enum: Valid, Invalid |
false |