Getting Started

This page walks you through the setup steps required to use Cloud Genomics.

(If you've completed the Quickstart, you've already done some of these steps. Review this page to make sure you're ready to use Cloud Genomics).

Before you begin

  1. Sign in to your Google Account.

    If you don't already have one, sign up for a new account.

  2. Select or create a GCP project.

    Go to the Project selector page

  3. Make sure that billing is enabled for your Google Cloud Platform project.

    Learn how to enable billing

  4. Enable the Cloud Genomics API.

    Enable the API

When you first enable the Pipelines API for a project, a new service account for the project is automatically assigned a role (genomics.serviceAgent) that enables starting and stopping Compute Engine instances inside your project.

If you later remove this default role from the relevant project service account, or remove the service account entirely, you might encounter errors. In particular, attempts to run pipelines using the API will result in permission errors. The API will also be unable to shut down running instances when pipelines complete and you will continue to be billed for these resources. For details on how to fix this issue, see Troubleshooting.

Set up Cloud SDK and gcloud

Install Cloud SDK to use the tools and libraries in Cloud Genomics, Compute Engine, Cloud Storage, and BigQuery. The SDK includes the gcloud, gsutil, and bq command-line tools.

  1. Download and install Cloud SDK.

  2. Initialize Cloud SDK.

  3. After you've initialized the SDK, install the Cloud Genomics commands:

    gcloud components update alpha
    

    If you're using a Compute Engine VM with the default installation of gcloud, you won't be able to update the components. To enable Cloud Genomics on a Compute Engine VM, reinstall gcloud by running the following commands:

    sudo apt-get remove google-cloud-sdk
        curl https://sdk.cloud.google.com | bash
        exec -l $SHELL
        gcloud init
    

Download credentials for API access

If you are using a code sample from the Cloud Genomics GitHub repository or a tool other than the gcloud command-line tool that accesses the Pipelines API directly, complete the following steps to download a client_secrets.json file for your project.

  1. Sign in to your Google Account.

    If you don't already have one, sign up for a new account.

  2. Select or create a GCP project.

    Go to the Project selector page

  3. Make sure that billing is enabled for your Google Cloud Platform project.

    Learn how to enable billing

  4. Enable the Cloud Genomics and Cloud Storage JSON APIs.

    Enable the APIs

  5. Open the Credentials page in the API console.
  6. Click Create credentials > Oauth Client ID.
  7. Set the application type to Other and complete the form.

After creating your credentials, download the client_secret.json file by going to the Credentials page in the GCP Console and clicking Download JSON file_download to the right of the client ID. Securely store the file in a location that only your application can access.

The first time you query the API you will be authenticated using the values in the client secrets file you downloaded. After this initial authentication, the Cloud Genomics tools save a token to use during subsequent API requests.

What's next

Was this page helpful? Let us know how we did:

Send feedback about...

Cloud Genomics