Skip to content

AlicloudRedisInstance Custom Resource ​

WARNING

This is a beta feature available only per request for SAP-internal teams.

The alicloudredisinstance.cloud-resources.kyma-project.io is a namespace-scoped custom resource (CR). It describes the Alibaba Cloud ApsaraDB for Redis (Tair) instance. Once the instance is provisioned, a Kubernetes Secret with endpoint and credential details is created in the same namespace. By default, the Secret has the same name as the AlicloudRedisInstance.

The instance requires an IP range, allocated from an IpRange CR. If you don't reference one, the default IpRange is used. If the default IpRange doesn't exist, it is created. Create a non-default IpRange only when you need to control network segments to avoid range conflicts.

When creating AlicloudRedisInstance, only the redisTier field is mandatory. It selects both the service tier (Standard or Premium) and the memory capacity. Optionally, you can set engineVersion and authSecret.

In-transit Encryption ​

In-transit encryption is always enabled. Communication with the Redis instance requires a certificate. You can find it in the Secret at the .data.CaCert.pem path.

Authentication is always enabled. A generated password is provided in the Secret at the .data.authString path.

Persistence ​

Persistence is not supported. Data is not written to durable storage (for example, data at rest).

Redis Tiers ​

Standard Tier ​

In the Standard service tier, the instance runs as a master with a replica for automatic failover. It does not have a read-only replica.

RedisTierCapacity (GiB)AliCloud Instance Class
S11tair.rdb.1g
S22tair.rdb.2g
S34tair.rdb.4g
S48tair.rdb.8g
S516tair.rdb.16g

Premium Tier ​

In the Premium service tier, the instance comes with a read-only replica in addition to the master and its failover replica. Thus, it can serve read traffic from the replica.

RedisTierCapacity (GiB)AliCloud Instance Class
P14tair.rdb.4g
P28tair.rdb.8g
P316tair.rdb.16g
P432tair.rdb.32g
P564tair.rdb.64g

Specification ​

This table lists the parameters of AlicloudRedisInstance, together with their descriptions:

ParameterTypeRequiredDescription
ipRangeobjectNoIpRange reference. If omitted, the default IpRange is used. If the default IpRange does not exist, it will be created. Immutable.
ipRange.namestringYesName of the existing IpRange to use.
redisTierstringYesThe Redis tier of the instance. Supported values are S1, S2, S3, S4, S5 for the Standard offering, and P1, P2, P3, P4, P5 for the Premium offering. The service tier (S or P) is immutable. You can only change the capacity within a service tier.
engineVersionstringNoThe version of the Redis engine. Supported values are 5.0, 6.0, and 7.0. Defaults to 7.0. Immutable; to change it, delete and recreate the instance.
authSecretobjectNoAuth Secret options.
authSecret.namestringNoAuth Secret name.
authSecret.labelsobjectNoAuth Secret labels. Keys and values must be strings.
authSecret.annotationsobjectNoAuth Secret annotations. Keys and values must be strings.
authSecret.extraDataobjectNoUse this option to define additional data fields that appear in the Secret. You can use the predefined data fields as templates with the{{.fieldName}} syntax (for example, {{.host}} or {{.port}}). Available field names are listed in the Auth Secret Details section below. Unrecognized field names are copied as-is into the Secret. Keys and values must be strings.

Auth Secret Details ​

The following table lists the parameters of the auth Secret:

ParameterTypeDescription
.metadata.namestringName of the auth Secret. It shares the name with the AlicloudRedisInstance unless authSecret.name is set.
.metadata.labelsobjectSpecified custom labels (if any).
.metadata.annotationsobjectSpecified custom annotations (if any).
.data.hoststringPrimary connection host.
.data.portstringPrimary connection port.
.data.primaryEndpointstringPrimary connection endpoint. Provided in <host>:<port> format.
.data.authStringstringAuth string used to authenticate with the instance.
.data.CaCert.pemstringCA Certificate that must be used for TLS.

Sample Custom Resource ​

yaml
apiVersion: cloud-resources.kyma-project.io/v1beta1
kind: AlicloudRedisInstance
metadata:
  name: alicloudredisinstance-sample
spec:
  redisTier: "P1"
  engineVersion: "7.0"