OpenMCF logoOpenMCF

Loading...

AliCloud Redis Instance

Deploys an Alibaba Cloud Redis (KVStore) instance for managed in-memory caching, session management, and real-time data processing. Supports both Redis and Memcache engines, with Redis as the default.

What Gets Created

When you deploy an AliCloudRedisInstance resource, OpenMCF provisions:

  • KVStore Instance -- an alicloud_kvstore_instance with the selected engine version, instance class, and network placement

Prerequisites

  • Alibaba Cloud credentials configured via environment variables or OpenMCF provider config
  • A VSwitch -- the Redis instance is placed in a VSwitch (create one with AliCloudVswitch)
  • The VSwitch's VPC and availability zone determine the instance's network placement

Quick Start

Create a file redis-instance.yaml:

apiVersion: ali-cloud.openmcf.org/v1
kind: AliCloudRedisInstance
metadata:
  name: my-redis
spec:
  region: cn-hangzhou
  instanceClass: redis.master.small.default
  password: "${REDIS_PASSWORD}"
  vswitchId:
    valueFrom:
      name: my-app-vswitch

Deploy:

openmcf apply -f redis-instance.yaml

This creates a Redis 7.0 instance with the default PostPaid billing and VPC password authentication.

Configuration Reference

Required Fields

FieldTypeDescriptionValidation
regionstringAlibaba Cloud region (e.g., cn-hangzhou)Required; non-empty
vswitchIdStringValueOrRefVSwitch ID. Can reference AliCloudVswitch via valueFrom.Required
instanceClassstringInstance specification (e.g., redis.master.small.default)Required; non-empty
passwordstringAuthentication password (8-32 chars)Required; 8-32 characters

Optional Fields

FieldTypeDefaultDescription
engineVersionstring7.0Redis version: 2.8, 4.0, 5.0, 6.0, 7.0
instanceTypestringRedisEngine: Redis or Memcache
dbInstanceNamestringmetadata.nameInstance display name (2-256 chars)
zoneIdstringPrimary availability zone
secondaryZoneIdstringStandby AZ for multi-zone HA
paymentTypestringPostPaidBilling: PostPaid or PrePaid
securityIpslistIP whitelist for access control
securityGroupIdstringSecurity group ID
resourceGroupIdstringResource group for organizational grouping
tagsmapKey-value tags
shardCountint32Data shards for cluster mode
readOnlyCountint32Read replicas in primary zone (1-9)
sslEnablestringSSL: Enable, Disable, Update
tdeStatusstringTDE encryption: Enabled
encryptionKeystringCustom KMS key for TDE
vpcAuthModestringOpenVPC auth: Open or Close
configmapRedis configuration parameters
instanceReleaseProtectionboolfalsePrevent accidental deletion
maintainStartTimestringMaintenance window start (e.g., 02:00Z)
maintainEndTimestringMaintenance window end (e.g., 06:00Z)
backupPeriodlistBackup days (e.g., Monday, Wednesday)
backupTimestringBackup time window (e.g., 02:00Z-03:00Z)
privateConnectionPrefixstringCustom private connection prefix
autoRenewboolfalseAuto-renewal for PrePaid
autoRenewPeriodint32Auto-renewal period in months (1-12)
periodstringSubscription months: 1-9, 12, 24, 36

Stack Outputs

After deployment, the following outputs are available in status.outputs:

OutputTypeDescription
instance_idstringRedis instance ID (e.g., r-xxxxx)
connection_domainstringIntranet (VPC-internal) connection domain
private_connection_portstringPrivate connection port (default: 6379)
private_ipstringPrivate IP address within the VSwitch

Related Components

  • AliCloudVswitch -- VSwitch where the Redis instance is placed
  • AliCloudVpc -- VPC that provides network isolation
  • AliCloudSecurityGroup -- Network security rules for instance access
  • AliCloudKmsKey -- Customer-managed key for TDE encryption
  • AliCloudPrivateDnsZone -- Private DNS resolution for the instance endpoint

Next article

AliCloud RocketMQ Instance

AliCloud RocketMQ Instance Deploys an Alibaba Cloud RocketMQ 5.x managed message broker with bundled topics and consumer groups. Supports edition-based throughput tiers (standard, professional, ultimate), deployment architectures (single node, cluster HA, serverless), and optional public internet access. What Gets Created When you deploy an AliCloudRocketmqInstance resource, OpenMCF provisions: RocketMQ 5.x Instance — a managed message broker placed in the specified VPC with configurable...
Read next article
Presets
3 ready-to-deploy configurationsView presets →