Modifying a Cloud Bigtable Instance

After you create a Cloud Bigtable instance, you can update it through GCP Console or the gcloud command-line tool.

There is no downtime when you make changes to your instance or cluster. However, if you change the number of nodes in your cluster, it typically takes a few minutes under load for Cloud Bigtable to balance performance across all of the nodes.

  • Details you can change: You can modify the instance display name (shown as DESCRIPTION in the command line), add or remove nodes, and upgrade the instance type from development to production (upgrades are permanent).

  • Details you cannot change: You cannot modify the instance ID, cluster ID, or storage type (SSD/HDD). You also cannot downgrade the instance type from production to development. To change any of these settings, you must create a new instance with the desired updates, copy your data from the old instance into the new one, and then delete the old instance.

Steps to modify your instance

Console

To modify a Cloud Bigtable instance:

  1. List instances in your project.
  2. Click the name of the instance you want to modify.
  3. Click Edit instance. The Edit instance page appears.
  4. Change the instance's settings as needed, then click Save to save your changes.

gcloud

To show information about existing Cloud Bigtable instances:

  1. Install the Cloud SDK if you haven't already.
  2. Use the beta bigtable instances list command to list existing clusters:

    gcloud beta bigtable instances list
    

To modify a Cloud Bigtable instance:

  1. Install the Cloud SDK if you haven't already.
  2. Use the beta bigtable instances update command to modify an instance:

    gcloud beta bigtable instances update INSTANCE --description=DESCRIPTION \
        [--instance-type=INSTANCE_TYPE]
    

    Where:

    • INSTANCE: Is the permanent identifier for your instance.
    • DESCRIPTION: Is a human-readable name that identifies your instance in the GCP Console (as "instance name").

    The command accepts the following optional flag:

    • --instance-type=INSTANCE_TYPE: Use the value PRODUCTION to upgrade a development instance to a production instance. Upgrades are permanent.

To modify a Cloud Bigtable cluster:

  1. Install the Cloud SDK if you haven't already.
  2. Use the beta bigtable clusters update command to modify a cluster:

    gcloud beta bigtable clusters update CLUSTER --instance=INSTANCE \
        --description=DESCRIPTION --num-nodes=NUM_NODES [--async]
    

    Where:

    • CLUSTER: Is the permanent identifier for your cluster.
    • INSTANCE: Is the permanent identifier for your instance.
    • DESCRIPTION: Is a human-readable name that identifies your instance in the GCP Console.
    • NUM_NODES: Is the number of nodes to provide in your cluster. There is a default limit of 30 Cloud Bigtable nodes per zone per Cloud Platform project. To request more nodes for a zone, use the Cloud Bigtable node request form.

    The command accepts the following optional flag:

    • --async: Return immediately without waiting for the operation to finish.

What's next

Learn how to add, update, and remove labels for an instance.

Send feedback about...

Cloud Bigtable Documentation