Overview

Custom Data Commons is deployed in Google Cloud Platform (GCP). This manual describes how to install a custom Data Commons instance in an existing GCP project (with id PROJECT_ID).

Steps

  1. From Google Cloud Console, open Cloud Shell by clicking on the icon, like below:

    fa

  2. Set the environment variables PROJECT_ID and CONTACT_EMAIL in the terminal:

    export PROJECT_ID=<project_id>
export CONTACT_EMAIL=<email_address>

    fa

    Note: If this step fails, please contact us at with form with the errors.

  3. [Optional] The default domain of the instance is <PROJECT_ID>-datacommons.com. If you want to use an existing custom domain, set the environment variable:

    export CUSTOM_DC_DOMAIN=<existing_domain>

    Later on, you need to create a new DNS record by linking the domain with the IP address (from GCP project) from your domain provider.

  4. Please run the following installation command inside the terminal. This may take up to 20 minutes to complete.

    curl -fsSL https://raw.githubusercontent.com/datacommonsorg/website/custom-dc-v0.3.2/scripts/install_custom_dc.sh -o install_custom_dc.sh && \
chmod u+x install_custom_dc.sh && \
./install_custom_dc.sh

  5. Please fill out this form to get an API key for data access. Store the API key in Cloud Secret Manager with name mixer-api-key.

  6. [Optional] Get a Google Maps API key (instruction). Store the API key in Cloud Secret Manager with name maps-api-key. This is used for place search in visualization tools.

  7. You should get an email by Google domains that has the section pictured below. Please click on “Verify email now”.

    fa

    Note: You may not get the verification email if you have verified Cloud Domains or Google Domains in the past. If you do not get the verification within 10 minutes, check GCP UI to see if the Cloud Domain is active. If it is active, then please skip this step. Below is what active Cloud Domains looks like.

    fa

  8. Deploy a default Data Commons Instance:

    First clone the Github repo

    git clone https://github.com/datacommonsorg/website.git

    Then update fields project in custom_dc_template.yaml with the actual GCP project ID.

    Deploy to GKE by running:

    ./scripts/deploy_gke_helm.sh -e custom_dc_template -l us-central1-a

    Go to GCP console to make sure pods are running successfully.