Create a read pool instance

This page describes how to create a read pool instance in an AlloyDB cluster.

Prerequisites

  • The Cloud project you are using must have been enabled to access AlloyDB.
  • You must have one of these IAM roles in the Cloud project you are using:
    • roles/alloydb.admin (the AlloyDB Admin predefined IAM role)
    • roles/owner (the Owner basic IAM role)
    • roles/editor (the Editor basic IAM role)

    If you don't have any of these roles, contact your Organization Administrator to request access.

Procedure

Console

  1. In the Google Cloud console, go to the Clusters page.

    Go to Clusters

  2. Click a cluster in the Resource Name column.
  3. In the Overview page, go to the Instances in your cluster section, and click Add read pool.
  4. Configure your read pool instance:
    1. In the Read pool instance ID field, enter an ID for the read pool instance.
    2. In the Node count field, enter a node count.

      The number of nodes in a read pool instance determines the instance's overall computing capacity.

    3. Select a machine type.
    4. Optional: Set custom flags to your instance. For each flag:
      1. Click Add flag.
      2. Select a flag from the New database flag list.
      3. Provide a value for the flag.
      4. Click Done.
    5. Click Add read pool.

gcloud

To use the gcloud CLI, you can install and initialize the Google Cloud CLI (version 383.0.1 or later), or you can use Cloud Shell.

Use the instances create command to create a read pool instance.

gcloud beta alloydb instances create INSTANCE_ID \
    --instance-type=READ_POOL \
    --cpu-count=CPU_COUNT \
    --read-pool-node-count=NODE_COUNT \
    --region=REGION_ID \
    --cluster=CLUSTER_ID \
    --project=PROJECT_ID
  • INSTANCE_ID: The ID of the instance you are creating. It must begin with a lowercase letter and can contain lowercase letters, numbers, and hyphens.
  • CPU_COUNT: The VCPUs you want for the nodes in the instance. Valid values are 4 (4 vCPUs, 32 GB RAM), 8 (8 vCPUs, 64 GB RAM), 16 (16 vCPUs, 128 GB RAM), 32 (32 vCPUs, 256 GB RAM), and 64 (64 vCPUs, 512 GB RAM).
  • NODE_COUNT: The number of nodes in the instance. Specify a number 1 through 20, inclusive. Note that you cannot have more than 20 nodes across all read pool instances in a cluster.
  • REGION_ID: The region where you want the instance placed.
  • CLUSTER_ID: The ID of the cluster where you want the instance placed.
  • PROJECT_ID: The ID of the project where the cluster is placed.