Oracle Cloud Infrastructure Documentation

Creating a OCI Cache Cluster

Create an OCI Cache cluster to apply memory-based storage solutions for applications.

Each non-sharded cluster is composed of one primary node and optionally one or more data nodes, based on the options that you specify when you create the cluster.

For reliability purposes, we recommend a minimum three node cluster configuration. Reliability isn't guaranteed for one to two node cluster configurations.

Each sharded cluster is composed of a minimum of three shards, with each shard composed of one primary node, and optionally one to four data nodes, based on the options you specify when you create the cluster. The maximum number of nodes per sharded cluster is 100, for more information, see OCI Cache Sharded Clusters.
Caution

Clusters can only be created in subnets that don't have IPv6 enabled. If you select an existing subnet with IPv6 enabled, cluster creation fails.

  • On the Clusters list page, select Create cluster. If you need help finding the list page, see Listing OCI Cache Clusters.

    Creating a OCI Cache cluster consists of the following pages:

    • 1. Configure cluster
    • 2. Configure nodes
    • 3. Configure networking
    • 4. Review and create

    Run each of the following workflows in order. You can return to a previous page by selecting Previous.

    1. Configure cluster

    The Configure cluster page is where you provide the basic information for the cluster.

    Enter the following information:

    • Name: Accept the prefilled name or enter a friendly name for the cluster.
    • Create in compartment: Select the compartment where the cluster resides from the list.
    • OCI Cache engine version: Select one of the following versions:
      • VALKEY_7_2
      • REDIS_7_0

    Tagging

    If you have permissions to create a resource, then you also have permissions to apply free-form tags to that resource. To apply a defined tag, you must have permissions to use the tag namespace. For more information about tagging, see Resource Tags. If you're not sure whether to apply tags, skip this option or ask an administrator. You can apply tags later.

    Select Next.

    2. Configure nodes

    The Configure nodes page is where you select the mode of cluster (non-sharded compared with sharded) and the settings for cluster's nodes.

    • Cluster mode: Select one of the following modes:
      • Non-sharded: Features a single primary node with up to four replicas for reliable performance and automatic backup.
      • Sharded: Enhances capacity and speeds up processing by distributing data across several shards, ideal for handling large or busy datasets.
    • Node count: (Non-sharded only) Specify a value between 1-5.
    • Shard count: (Sharded mode only) Specify an odd numbered value between 3-99.
    • Nodes per shard: (Sharded mode only) Specify a value between 1-5.
    • Memory (GB) per node: Specify a value between 2 and 500.

    At the bottom of the page is a running tally of the total node count, the total memory in gigabytes used, and the bandwidth in gigabytes per second per node. These numbers are updated as you change the settings in the page.

    Select Next.

    3. Configure networking

    The Configure networking page is where you configure how your cluster connects to the internet and other resources in the Console.

    VCN

    Select one of the following options:

    • Select existing virtual cloud network: Select a VCN in the current compartment from the list.
    • New virtual cloud network name: Enter the following information:
      • New virtual cloud network name: Accept the default name or enter a friendly name for the VCN.
      • Create in compartment: Select the compartment where the new VCN resides from the list.
    • Enter subnet OCID: Enter the OCID of the subnet you want. The VCN is automatically determined by the subnet you select.

    Subnet

    The subnet settings differ depending on what VCN option you select. You can't change the cluster's subnet after the cluster has been created.

    Select one of the following options:

    • Select existing subnet: Select a subnet in the current compartment from the list.
    • Create new public subnet: Enter the following information:
      • Create new public subnet: Accept the default name or enter a friendly name for the subnet.
      • Create in compartment: Select the compartment where the new subnet resides from the list.
      • CIDR block: Enter the CIDR block IP addresses, for example, 10.0.0.0/16, 209.128.0.0/10
    • Enter subnet OCID: Enter the OCID of the subnet you want.

    Network security group

    You have the option of adding one or more network security groups (NSGs) that are available for the VCN you selected. The NSG you select must contain a rule configured to allow traffic to the cluster's VNIC using specific protocols and ports. For more information, see Security Rule for Connecting to Clusters.

    Select Add network security group and select an available NSG in the current compartment from the list.

    Select Next.

    4. Review and create

    Review the contents of the Review and create page. Edit settings or return to previous screens to add information. When the settings are fully verified, select Create cluster.

    The cluster you created appears in the Clusters list page.

  • Use the oci redis redis-cluster redis-cluster create command and required parameters to create a cluster:

    oci redis redis-cluster redis-cluster create --compartment-id <compartment_OCID> --display-name <text> --node-count <node_count> --node-memory-in-gbs <memory in gigabytes> --software-version <text> --subnet-id <subnet_OCID> [OPTIONS]
    For information about using the CLI, see Command Line Interface (CLI). For a complete list of flags and options available for CLI commands, see the CLI Command Reference.
  • For information about using the API and signing requests, see REST APIs and Security Credentials. For information about SDKs, see Software Development Kits and Command Line Interface.

    Run the CreateRedisCluster operation to create a cluster.