Create Instance

Following Redis versions are fully supported: 6.0 and 7.2; other versions are not supported by default.

Version suggestion

When used in a production environment, it is recommended to prioritize the 7.2 version over 6.0. 7.2 is the default version.

7.2 is still maintained by the community and fixes known issues in 6.0. The 6.0 version is no longer maintained by the community.
7.2 is fully compatible with 6.0.
7.2 has further improved the ACL features.
Cross-datacenter replication features introduced in v5.1.0 — including Active-Active mode — are available on 7.2 only.

Architecture suggestion

Single-node architecture has no replica nodes and lacks failover capabilities, so it should only be used in development and testing environments. You can choose between Sentinel architecture and Cluster architecture based on your business's data and concurrency needs.

Create Redis Instance

Procedure

Sentinel CLI

Cluster CLI

Standalone CLI

Web Console

Create a Redis 6.0 Sentinel mode instance using CLI:

$ cat << EOF | kubectl -n default create -f -
apiVersion: middleware.alauda.io/v1
kind: Redis
metadata:
  name: s6
spec:
  arch: sentinel
  customConfig:
    databases: "16"
    hz: "10"
    save: 60 10000 300 100 600 1
    timeout: "0"
  exporter:
    enabled: true
    resources:
      limits:
        cpu: 100m
        memory: 384Mi
      requests:
        cpu: 50m
        memory: 128Mi
  replicas:
    sentinel:
      master: 1
      slave: 1
  resources:
    limits:
      cpu: "1"
      memory: 2Gi
    requests:
      cpu: "1"
      memory: 2Gi
  sentinel:
    monitorConfig:
      down-after-milliseconds: "30000"
      failover-timeout: "180000"
      parallel-syncs: "1"
    replicas: 3
    resources:
      limits:
        cpu: 100m
        memory: 128Mi
      requests:
        cpu: 100m
        memory: 128Mi
  version: "6.0"
EOF

Refer to the Redis API documentation for field descriptions.

Sentinel password

A Sentinel instance has two independent default user passwords: spec.passwordSecret authenticates the Redis data nodes, and spec.sentinel.passwordSecret authenticates the Sentinel nodes. The example above sets neither, which leaves both open. The Web Console enables the Sentinel password by default; when creating an instance from the CLI, set it explicitly.

Each field references a Secret in the same namespace that holds the password under the password key, and the password must be 8 to 32 characters long.

$ kubectl -n default create secret generic s6-sentinel-password --from-literal=password='<sentinel-password>'

Then reference it from the instance:

spec:
  sentinel:
    passwordSecret: s6-sentinel-password

Clients connecting through Sentinel must supply this password separately from the Redis password — refer to Accessing Instances (Sentinel Mode).

Create a Redis 6.0 Cluster mode instance using CLI:

$ cat << EOF | kubectl -n default create -f -
apiVersion: middleware.alauda.io/v1
kind: Redis
metadata:
  name: c6
spec:
  affinityPolicy: AntiAffinityInSharding
  arch: cluster
  customConfig:
    hz: "10"
    save: 60 10000 300 100 600 1
    timeout: "0"
  exporter:
    enabled: true
    resources:
      limits:
        cpu: 100m
        memory: 384Mi
      requests:
        cpu: 50m
        memory: 128Mi
  expose:
    type: NodePort
  replicas:
    cluster:
      shard: 3
      slave: 1
  resources:
    limits:
      cpu: 200m
      memory: 200Mi
    requests:
      cpu: 200m
      memory: 200Mi
  version: "6.0"
EOF

Refer to the Redis API documentation for field descriptions.

Create a Redis 6.0 Standalone mode instance using CLI:

$ cat << EOF | kubectl -n default create -f -
apiVersion: middleware.alauda.io/v1
kind: Redis
metadata:
  name: standalone
spec:
  arch: standalone
  customConfig:
    databases: "16"
    hz: "10"
    save: 60 10000 300 100 600 1
    timeout: "0"
  exporter:
    enabled: true
    resources:
      limits:
        cpu: 100m
        memory: 384Mi
      requests:
        cpu: 50m
        memory: 128Mi
  replicas:
    sentinel:
      master: 1
  resources:
    limits:
      cpu: "1"
      memory: 1Gi
    requests:
      cpu: "1"
      memory: 1Gi
  version: "6.0"
EOF

Refer to the Redis API documentation for field descriptions.

Enter Alauda Application Services view.
In the left navigation bar of Alauda Application Services view, click Redis.
Click Namespace name.
Click Create Redis Instance.
Select an architecture type.

Refer to the instructions below to complete the relevant configurations.

Configuration	Configuration Item	Description
Parameter Configuration	Parameter Template	You can choose between system or custom parameter templates. For custom parameter templates please refer to Parameter Template Management.
Connection Configuration	Set Default Password	It is recommended to set a password for redis `default` user when startup instance. If no password is set, refer to User Management to reset the password or create extra accounts. For Sentinel architecture, this field lives on the Set Redis Password tab and applies to the Redis data nodes only.
	Set Sentinel Password	Shown for Sentinel architecture only, on a second tab next to Set Redis Password. The Sentinel nodes have a `default` user of their own, whose password is independent of the Redis data node password, so switch to the Set Sentinel Password tab and set it. Set Password is enabled there by default and both password fields are required while it stays enabled; if you click Create while they are empty, the tab label shows a warning icon and creation is blocked. Clients connecting through Sentinel must supply this password separately from the Redis password — refer to Accessing Instances (Sentinel Mode).
	Access Method	If applications and Redis instances resize in different workload clusters, use external access method. External access method supports `LoadBalancer` and `NodePort` where `LoadBalancer` is recommended for production environments. If applications and Redis instances resize in the same workload cluster, use Within the Cluster access method.
	Specify Host Port	When using NodePort for external access, you can specify the service nodeport numbers. Sentinel Mode: When updating the instance, ports cannot be swapped; if you need to swap ports, update to another unoccupied port first, then re-specify. Cluster Mode: When updating the instance, if you only need to replace one port, you can re-enter or modify the corresponding node port in YAML.
Scheduling Configuration	Anti-Affinity Policy	To meet the demands for high reliability and high availability under different business scenarios, the platform provides an anti-affinity policy for Cluster Mode, where Force anti-affinity is the default applied anti-affinity policy. Note: Once the instance is created, this configuration can no longer be modified.
	Node Labels	Filter available nodes in the current cluster through labels. Pods will be scheduled to available nodes. Note: Once the instance is created, this configuration can no longer be modified.
	Pod Toleration	If available nodes have taints, only Pods with tolerations set will tolerate these taints and may be scheduled to nodes that match the Pod toleration and node taint. The matching rules are as follows. Equal: When the key, value, and effect that the Pod tolerates match exactly with the node taint settings, the Pod will tolerate the node taint. Exists: When the key and effect that the Pod tolerates remain consistent with the node taint settings, the Pod will tolerate the node taint. Note: The effect determines whether Pods that do not tolerate the node taint will be assigned to the node with the taint. For example, if the effect is NoExecute, only Pods that tolerate the taint (including Pods in this Redis instance) will be scheduled, and already running Pods on the node that do not tolerate the taint will be evicted (Pods from other instances). For more information on matching rules, please refer to the Kubernetes community documentation.

The current Web Console does not support creating standalone (Redis single-node architecture).

Click Create.

Once the instance status changes to Running, the instance has been successfully created.

After the instance is created, you can use the following command to check the status of the instance:

$ kubectl -n default get redis
NAME         ARCH         VERSION   ACCESS     STATUS         MESSAGE   BUNDLE VERSION   AUTOUPGRADE   AGE
c6           cluster      6.0                  Initializing             5.1.0                         3m26s
c7           cluster      7.2       NodePort   Initializing             5.1.0                         98s
s6           sentinel     6.0                  Ready                    5.1.0                         25m
s7           sentinel     7.2       NodePort   Ready                    5.1.0                         2m15s
standalone   standalone   6.0                  Initializing             5.1.0                         6s

The meanings of the output table fields are as follows:

Field	Description
NAME	Instance name
ARCH	This value corresponds to the architecture of Redis. `cluster`: Cluster mode `sentinel`: Sentinel mode `standalone`: Single-node Redis This field indicates whether this CR resource manages a standalone, Sentinel, or Cluster mode of Redis.
VERSION	Currently supports the 2 versions: `6.0` and `7.2`
ACCESS	The access methods supported by the instance. : The instance provides services via ClusterIP `NodePort`: The instance provides services via NodePort `LoadBalancer`: The instance provides services via LoadBalancer
STATUS	The current status of the instance, which may include the following states: `Initializing`: The instance is initializing or updating `Rebalancing`: The cluster instance is scaling up or down `Error`: The instance has encountered a non-recoverable error `Paused`: The instance has been manually paused `Ready`: The instance is ready
MESSAGE	The reason for the instance being in its current status
BUNDLE VERSION	The version number of the operator managing the instance
AUTOUPGRADE	Whether automatic upgrades are enabled for the instance
AGE	How long ago the instance was created

#Create Instance

#TOC

#Create Redis Instance

#Procedure

Create Instance

TOC

Create Redis Instance

Procedure