redis_enterprise_active_active_database_api.md

Redis Enterprise Active Active Database API

This document describes the parameters for the Redis Enterprise Active Active Database custom resource

Note this document is auto-generated from code comments. To contribute a change please change the code comments.

Table of Contents

• Objects
  • ParticipatingCluster
  • ParticipatingClusterStatus
  • RedisEnterpriseActiveActiveDatabase
  • RedisEnterpriseActiveActiveDatabaseList
  • RedisEnterpriseActiveActiveDatabaseSpec
  • RedisEnterpriseActiveActiveDatabaseStatus
  • SecretStatus
• Enums
  • ActiveActiveDatabaseSecretStatus
  • ActiveActiveDatabaseStatus
  • ReplicationStatus

Objects

ParticipatingCluster

Instance/cluster specifications and configurations.

Field	Description	Scheme	Default Value	Required
name	The name of the remote cluster CR to link.	string		true
externalReplicationPort	The desired replication endpoint's port number for users who utilize LoadBalancers for sync between AA replicas and need to provide the specific port number that the LoadBalancer listens to.	*int		false
namespace	Namespace in which the REAADB object will be deployed to within the corresponding participating cluster. The user must ensure that the Redis Enterprise operator is configured to watch this namespace in the corresponding cluster, and the required RBAC configuration is properly set up. See https://redis.io/docs/latest/operate/kubernetes/re-clusters/multi-namespace/ for more information how to set up multiple namespaces. If no namespace is specified, then the REAADB is deployed to the REC's namespace in the corresponding cluster.	string		false
Back to Table of Contents

ParticipatingClusterStatus

Status of participating cluster.

Field	Description	Scheme	Default Value	Required
name	The name of the remote cluster CR that is linked.	string		true
id	The corresponding ID of the instance in the active-active database.	*int64		false
replicationStatus	The replication status of the participating cluster	ReplicationStatus		false
Back to Table of Contents

RedisEnterpriseActiveActiveDatabase

RedisEnterpriseActiveActiveDatabase is the schema for the redisenterpriseactiveactivedatabase API

Field	Description	Scheme	Default Value	Required
metadata		metav1.ObjectMeta		false
spec		RedisEnterpriseActiveActiveDatabaseSpec		false
status		RedisEnterpriseActiveActiveDatabaseStatus		false
Back to Table of Contents

RedisEnterpriseActiveActiveDatabaseList

RedisEnterpriseActiveActiveDatabaseList contains a list of RedisEnterpriseActiveActiveDatabase

Field	Description	Scheme	Default Value	Required
metadata		metav1.ListMeta		false
items		[]RedisEnterpriseActiveActiveDatabase		true
Back to Table of Contents

RedisEnterpriseActiveActiveDatabaseSpec

RedisEnterpriseActiveActiveDatabaseSpec defines the desired state of RedisEnterpriseActiveActiveDatabase

Field	Description	Scheme	Default Value	Required
redisEnterpriseCluster	Connection to Redis Enterprise Cluster	*RedisEnterpriseConnection		false
participatingClusters	The list of instances/ clusters specifications and configurations.	[]*ParticipatingCluster		true
globalConfigurations	The Active-Active database global configurations, contains the global properties for each of the participating clusters/ instances databases within the Active-Active database.	*RedisEnterpriseDatabaseSpec		true
Back to Table of Contents

RedisEnterpriseActiveActiveDatabaseStatus

RedisEnterpriseActiveActiveDatabaseStatus defines the observed state of RedisEnterpriseActiveActiveDatabase

Field	Description	Scheme	Default Value	Required
specStatus	Whether the desired specification is valid	SpecStatusName		false
status	The status of the active active database. This status does not include the replication link (data-path) status For the replication link status please view the 'Replication Status' or the 'status.replicationStatus' on the custom resource.	ActiveActiveDatabaseStatus		false
participatingClusters	The list of instances/ clusters statuses.	[]*ParticipatingClusterStatus		false
globalConfigurations	The active-active default global configurations linked REDB	string		false
linkedRedbs	The linked REDBs.	[]string		false
guid	The active-active database corresponding GUID.	string		false
lastTaskUid	The last active-active database task UID.	string		false
redisEnterpriseCluster	The Redis Enterprise Cluster Object this Resource is associated with	string		false
secretsStatus	The status of the secrets	[]*SecretStatus		false
replicationStatus	The overall replication status	ReplicationStatus		false
clusterCertificatesGeneration	Versions of the cluster's Proxy and Syncer certificates. In Active-Active databases, these are used to detect updates to the certificates, and trigger synchronization across the participating clusters. .	*int64		false
Back to Table of Contents

SecretStatus

Status of secrets.

Field	Description	Scheme	Default Value	Required
name	The name of the secret.	string		true
status	The status of the secret.	ActiveActiveDatabaseSecretStatus		false
Back to Table of Contents

Enums

ActiveActiveDatabaseSecretStatus

Value	Description
"Invalid"
"Valid"
Back to Table of Contents

ActiveActiveDatabaseStatus

Value	Description
"pending"	Active-active database is pending creation.
"active"	Active-active database is ready to be used.
"active-change-pending"	Database is ready to be used, but a change is pending.
"delete-pending"	Active-active database will be deleted soon.
"creation-failed"	Active-active database creation has failed.
"error"	Active-active database is in recovery. ActiveActiveDatabaseStatusRecovery ActiveActiveDatabaseStatus = "recovery" Active-active database status error.
""	Active-active database status unknown.
Back to Table of Contents

ReplicationStatus

Value	Description
"up"
"down"
Back to Table of Contents