redis.oracle.com/v1beta1
Back to API Reference
APIVersion: redis.oracle.com/v1beta1
This content is generated from the checked-in CRD schemas in config/crd/bases/. If a description is missing or incorrect, fix the source comments or generator inputs and rerun make generate manifests; do not hand-edit config/crd/bases/*.yaml.
Packages
| Package |
Support |
Latest release |
Resources |
| Redis |
preview |
v2.0.0-alpha |
RedisCluster |
Resources
RedisCluster
Manage OCI Redis clusters.
Plural: redisclustersScope: NamespacedAPIVersion: redis.oracle.com/v1beta1Sample: Sample (config/samples/redis_v1beta1_rediscluster.yaml)Packages: Redis (v2.0.0-alpha)
Spec
RedisClusterSpec defines the desired state of RedisCluster.
| Field |
Description |
Type |
Required |
Default |
Enum |
clusterMode |
Specifies whether the cluster is sharded or non-sharded. |
string |
No |
- |
- |
compartmentId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm#Oracle) of the compartment that contains the cluster. |
string |
Yes |
- |
- |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} |
map[string, map[string, string]] |
No |
- |
- |
displayName |
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. |
string |
Yes |
- |
- |
freeformTags |
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"} |
map[string, string] |
No |
- |
- |
nodeCount |
The number of nodes per shard in the cluster when clusterMode is SHARDED. This is the total number of nodes when clusterMode is NONSHARDED. |
integer |
Yes |
- |
- |
nodeMemoryInGBs |
The amount of memory allocated to the cluster's nodes, in gigabytes. |
number |
Yes |
- |
- |
nsgIds |
A list of Network Security Group (NSG) OCIDs (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) associated with this cluster. For more information, see Using an NSG for Clusters (https://docs.oracle.com/iaas/Content/ocicache/connecttocluster.htm#connecttocluster__networksecuritygroup). |
list[string] |
No |
- |
- |
ociCacheConfigSetId |
The ID of the corresponding OCI Cache Config Set for the cluster. |
string |
No |
- |
- |
securityAttributes |
Security attributes for redis cluster resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}} |
map[string, map[string, string]] |
No |
- |
- |
shardCount |
The number of shards in sharded cluster. Only applicable when clusterMode is SHARDED. |
integer |
No |
- |
- |
softwareVersion |
The OCI Cache engine version that the cluster is running. |
string |
Yes |
- |
- |
subnetId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm#Oracle) of the cluster's subnet. |
string |
Yes |
- |
- |
Status
RedisClusterStatus defines the observed state of RedisCluster.
| Field |
Description |
Type |
Required |
Default |
Enum |
clusterMode |
Specifies whether the cluster is sharded or non-sharded. |
string |
No |
- |
- |
compartmentId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm#Oracle) of the compartment that contains the cluster. |
string |
No |
- |
- |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} |
map[string, map[string, string]] |
No |
- |
- |
discoveryEndpointIpAddress |
The private IP address of the API endpoint for sharded cluster discovery. |
string |
No |
- |
- |
discoveryFqdn |
The fully qualified domain name (FQDN) of the API endpoint for sharded cluster discovery. |
string |
No |
- |
- |
displayName |
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. |
string |
No |
- |
- |
freeformTags |
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"} |
map[string, string] |
No |
- |
- |
id |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm#Oracle) of the cluster. |
string |
No |
- |
- |
lifecycleDetails |
A message describing the current state in more detail. For example, the message might provide actionable information for a resource in FAILED state. |
string |
No |
- |
- |
lifecycleState |
The current state of the cluster. |
string |
No |
- |
- |
nodeCollection |
RedisClusterNodeCollection defines nested fields for RedisCluster.NodeCollection. |
object |
No |
- |
- |
nodeCount |
The number of nodes per shard in the cluster when clusterMode is SHARDED. This is the total number of nodes when clusterMode is NONSHARDED. |
integer |
No |
- |
- |
nodeMemoryInGBs |
The amount of memory allocated to the cluster's nodes, in gigabytes. |
number |
No |
- |
- |
nsgIds |
A list of Network Security Group (NSG) OCIDs (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) associated with this cluster. For more information, see Using an NSG for Clusters (https://docs.oracle.com/iaas/Content/ocicache/connecttocluster.htm#connecttocluster__networksecuritygroup). |
list[string] |
No |
- |
- |
ociCacheConfigSetId |
The ID of the corresponding OCI Cache Config Set for the cluster. |
string |
No |
- |
- |
primaryEndpointIpAddress |
The private IP address of the API endpoint for the cluster's primary node. |
string |
No |
- |
- |
primaryFqdn |
The fully qualified domain name (FQDN) of the API endpoint for the cluster's primary node. |
string |
No |
- |
- |
replicasEndpointIpAddress |
The private IP address of the API endpoint for the cluster's replica nodes. |
string |
No |
- |
- |
replicasFqdn |
The fully qualified domain name (FQDN) of the API endpoint for the cluster's replica nodes. |
string |
No |
- |
- |
securityAttributes |
Security attributes for redis cluster resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}} |
map[string, map[string, string]] |
No |
- |
- |
shardCount |
The number of shards in a sharded cluster. Only applicable when clusterMode is SHARDED. |
integer |
No |
- |
- |
softwareVersion |
The OCI Cache engine version that the cluster is running. |
string |
No |
- |
- |
status |
- |
object |
Yes |
- |
- |
subnetId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm#Oracle) of the cluster's subnet. |
string |
No |
- |
- |
systemTags |
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"free-tier-retained": "true"}} |
map[string, map[string, string]] |
No |
- |
- |
timeCreated |
The date and time the cluster was created. An RFC3339 (https://datatracker.ietf.org/doc/html/rfc3339) formatted datetime string. |
string |
No |
- |
- |
timeUpdated |
The date and time the cluster was updated. An RFC3339 (https://datatracker.ietf.org/doc/html/rfc3339) formatted datetime string. |
string |
No |
- |
- |
Status.nodeCollection
Back to RedisCluster status
RedisClusterNodeCollection defines nested fields for RedisCluster.NodeCollection.
| Field |
Description |
Type |
Required |
Default |
Enum |
items |
Collection of node objects. |
list[object] |
No |
- |
- |
Status.nodeCollection.items[]
Back to RedisCluster status
RedisClusterNodeCollectionItem defines nested fields for RedisCluster.NodeCollection.Item.
| Field |
Description |
Type |
Required |
Default |
Enum |
displayName |
A user-friendly name of a cluster node. |
string |
No |
- |
- |
privateEndpointFqdn |
The fully qualified domain name (FQDN) of the API endpoint to access a specific node. |
string |
No |
- |
- |
privateEndpointIpAddress |
The private IP address of the API endpoint to access a specific node. |
string |
No |
- |
- |
Status.status
Back to RedisCluster status
| Field |
Description |
Type |
Required |
Default |
Enum |
async |
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. |
object |
No |
- |
- |
conditions |
- |
list[object] |
No |
- |
- |
createdAt |
- |
string (date-time) |
No |
- |
- |
deletedAt |
- |
string (date-time) |
No |
- |
- |
message |
- |
string |
No |
- |
- |
ocid |
- |
string |
No |
- |
- |
opcRequestId |
OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. |
string |
No |
- |
- |
reason |
- |
string |
No |
- |
- |
requestedAt |
- |
string (date-time) |
No |
- |
- |
updatedAt |
- |
string (date-time) |
No |
- |
- |
Status.status.async
Back to RedisCluster status
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.
| Field |
Description |
Type |
Required |
Default |
Enum |
current |
- |
object |
No |
- |
- |
Status.status.async.current
Back to RedisCluster status
| Field |
Description |
Type |
Required |
Default |
Enum |
message |
- |
string |
No |
- |
- |
normalizedClass |
- |
string |
Yes |
- |
attention, canceled, failed, pending, succeeded, unknown |
percentComplete |
- |
number |
No |
- |
- |
phase |
- |
string |
Yes |
- |
create, delete, update |
rawOperationType |
- |
string |
No |
- |
- |
rawStatus |
- |
string |
No |
- |
- |
source |
- |
string |
Yes |
- |
lifecycle, none, workrequest |
updatedAt |
- |
string (date-time) |
Yes |
- |
- |
workRequestId |
- |
string |
No |
- |
- |
Status.status.conditions[]
Back to RedisCluster status
| Field |
Description |
Type |
Required |
Default |
Enum |
lastTransitionTime |
- |
string (date-time) |
No |
- |
- |
message |
- |
string |
No |
- |
- |
reason |
- |
string |
No |
- |
- |
status |
- |
string |
Yes |
- |
- |
type |
- |
string |
Yes |
- |
- |