Redis Enterprise Remote Cluster API

This document describes the parameters for the Redis Enterprise Remote Cluster custom resource

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

Objects

RedisEntepriseRemoteCluster represents a remote participating cluster.

Field	Scheme	Required
metadata	metav1.ObjectMeta	false
spec	RedisEnterpriseRemoteClusterSpec	false
status	RedisEnterpriseRemoteClusterStatus	false
Back to Table of Contents

RedisEnterpriseRemoteClusterList contains a list of RedisEnterpriseRemoteCluster

Field	Scheme	Required
metadata	metav1.ListMeta	false
items	[]RedisEnterpriseRemoteCluster	true
Back to Table of Contents

Field	Description	Scheme	Required
recName	The name of the REC that the RERC is pointing at	string	true
recNamespace	The namespace of the REC that the RERC is pointing at	string	true
secretName	The name of the secret containing cluster credentials. Must be of the following format: "redis-enterprise-"	string	false
apiFqdnUrl	The URL of the cluster, will be used for the active-active database URL.	string	true
apiPort	The port number of the cluster's URL used for connectivity/sync	*int	false
dbFqdnSuffix	The database URL suffix, will be used for the active-active database replication endpoint and replication endpoint SNI.	string	false
Back to Table of Contents

Field	Description	Scheme	Required
local	Indicates whether this object represents a local or a remote cluster.	*bool	false
status	The status of the remote cluster.	RemoteClusterStatus	false
specStatus	Whether the desired specification is valid.	SpecStatusName	false
observedGeneration	observedGeneration is the most recent generation observed for this RERC. It corresponds to the RERC's generation, which is updated by the API Server.	int64	false
internalObservedSecretResourceVersion	The observed secret resource version. Used for internal purposes only.	string	false
Back to Table of Contents

TODO: Add a kubebuilder enum annotation here.