Configure the GCP cloud provider

You can configure Google Cloud Platform (GCP) for YugabyteDB clusters using YugabyteDB Anywhere. If no cloud providers are configured yet, the main Dashboard page prompts you to configure at least one cloud provider.


To run YugabyteDB nodes on GCP, all you need to provide on the YugabyteDB Anywhere UI is your cloud provider credentials. YugabyteDB Anywhere uses those credentials to automatically provision and de-provision instances that run YugabyteDB. An instance for YugabyteDB includes a compute instance, as well as local or remote disk storage attached to the compute instance.

Configure GCP

You can configure GCP as follows:

  • Navigate to Configs > Google Cloud Platform.

  • Click Add Configuration to open the Cloud Provider Configuration page shown in the following illustration:

    GCP Configuration empty

  • Complete the fields, keeping in mind the following guidelines:

    • Supply a descriptive name that preferably contains Google or GCP, which is especially important if you are planning to configure other providers.

    • If your YugabyteDB Anywhere instance is not running inside GCP, you need to supply YugabyteDB Anywhere with credentials to the desired GCP project by uploading a configuration file. To do this, select Upload Service Account config in the Credential Type field and proceed to upload the JSON file that you obtained when you created your service account, as described in Prepare the Google Cloud Platform (GCP) environment.

      If your YugabyteDB Anywhere instance is running inside GCP, the preferred method for authentication to the GCP APIs is to add a service account role to the GCP instance running YugabyteDB Anywhere and then configure YugabyteDB Anywhere to use the instance's service account. To do this, select Use Service Account on instance in the Credential Type field.

    • If this is a new deployment, it is recommended that you use the VPC Setup field to create a new VPC specifically for YugabyteDB nodes. You have to ensure that the YugabyteDB Anywhere host machine can connect to your Google Cloud account where this new VPC will be created.

      Alternatively, you may choose to specify an existing VPC for YugabyteDB nodes, in which case you would need to map regions by providing the following:

      • A region name.
      • A subnet ID.
      • Optionally, a custom machine image. YugabyteDB Anywhere allows you to bring up universes on Ubuntu 18.04 host nodes, assuming you have Python 2 or later installed on the host, as well as the provider created with a custom AMI and custom SSH user.

      The third option that is available only when your YugabyteDB Anywhere host machine is also running on Google Cloud, is to use the same VPC on which the YugabyteDB Anywhere host machine runs. Note that choosing to use the same VPC as YugabyteDB Anywhere is an advanced option, which assumes that you are in complete control over this VPC and will be responsible for setting up the networking, SSH access, and firewall rules for it.

      Also note that creating a new VPC using YugabyteDB Anywhere is considered beta and, therefore, not recommended for production use cases. If there are any classless inter-domain routing (CIDR) conflicts, using this option can result in a silent failure. For example, the following will fail:

      • Configure more than one AWS cloud provider with different CIDR block prefixes and selecting the Create a new VPC option.
      • Creating a new VPC with an CIDR block that overlaps with any of the existing subnets.
    • NTP Setup lets you to customize the Network Time Protocol server, as follows:

      • Select Use provider’s NTP server to enable cluster nodes to connect to the GCP internal time servers. For more information, consult the GCP documentation such as Configure NTP on a VM.
    • Select Manually add NTP Servers to provide your own NTP servers and allow the cluster nodes to connect to those NTP servers.

      • Select Don't set up NTP to prevent YugabyteDB Anywhere from performing any NTP configuration on the cluster nodes. For data consistency, ensure that NTP is correctly configured on your machine image.
  • Click Save and wait for the configuration to complete.

    This process includes generating a new VPC, a network, subnetworks in all available regions, as well as a new firewall rule, VPC peering for network connectivity, and a custom SSH key pair for YugabyteDB Anywhere-to-YugabyteDB connectivity.

Upon completion, you should see the configuration similar to the following:

GCP Configuration success

Now you are ready to create a YugabyteDB universe on GCP.