GCP Deployment Guide

​

Overview

Glean provides our customers the ability to deploy Glean software inside their own Google Cloud Platform (GCP) project. This deployment requires your GCP admin to:

1. Create a new GCP project.
2. Associate a valid billing account.
3. Enable applicable GCP APIs.
4. Request the required quota increases from GCP.
5. Create a Service Account with Project Owner role and associate a JSON account key.
6. Notify Glean of the GCP zone selected, the Project Name, Project ID, Project Number, and the service account JSON key.

After completing the above, Glean’s systems will automatically build and deploy the required compute, workflows, and software into your GCP project.

At this stage, Glean will advise you that your tenant is ready; allowing your admins to proceed with the setup process in our Getting Started guide.

This document will cover the steps required by your GCP admins to prepare a GCP project that is ready for your Glean build.

---

​

1. Select a GCP Region

You must first select a supported GCP region for Glean to build your environment in.

• More information: Supported GCP Regions

You must notify Glean of the GCP zone selected, e.g. asia-northeast1-a

​

2. Create the GCP Project

1. Go to the Manage resources page in the GCP console and click Create Project.

2. In the New Project window that appears, add a project name, organization, and location.

   • For the project name, the preferred format is glean-{customer name} or glean-{customer name}-{prod/sandbox}
   • E.g. glean-company or glean-company-prod

3. Make sure that your project is created under the same organization as your Google Workplace account, and not “No Organization”.

4. Save the Project ID (which is directly below the Project name) and Project Number.

5. Click Create.

6. Notify Glean of the following information:

   a. Project name, eg glean-company → This was set in Step 2 above.

   b. Project ID, eg glean-company → This was saved in Step 4 above.

   c. Project number, eg 715000000000 → This was saved in Step 4 above.

   d. Region and Zone where you want to deploy Glean, e.g. us-central1-a

​

3. Configure Billing

1. Go to Billing in the GCP console.

2. Click Link a billing account to set up billing for this project.

​

4. Enable APIs

Glean requires that the following GCP APIs are enabled for the deployment to succeed. Substitute your Project ID to the end of the URL for each API below to enable the API on the project.

API Name	URL
Cloud Resource Manager API (cloudresourcemanager.googleapis.com)	https://console.cloud.google.com/apis/api/cloudresourcemanager.googleapis.com/overview?project=[PROJECT_ID]
Service Usage API (serviceusage.googleapis.com)	https://console.developers.google.com/apis/api/serviceusage.googleapis.com/overview?project=[PROJECT_ID]
Compute Engine API (compute.googleapis.com)	https://console.developers.google.com/apis/api/compute.googleapis.com/overview?project=[PROJECT_ID]
Cloud SQL Admin API (sqladmin.googleapis.com)	https://console.developers.google.com/apis/api/sqladmin.googleapis.com/overview?project=[PROJECT_ID]

​

5. Request Quota Changes

Search for [Quotas] in the search box of the GCP Console and navigate to All Quotas, under IAM & Admin.

For each of the quotas in the table below, request a quota change by completing the following:

1. Click on the required quota.
2. Select Edit Quotas
3. Enter the value specified by Glean for the quota.
4. Click Submit Request.

​

6. Create a Service Account

The service account is used to allow Glean’s systems to access the project and perform the build. You will create the service account and provide Glean with the private JSON key required to use it.

1. Go to the Service Accounts page in the GCP console and click Select a Project.

2. Click Create Service Account. Enter the service account name (glean-admin), ID, and description (optional), then click Create.

3. Click the Select a role dropdown to make your service account an Owner of the project. Click Continue.

4. Ignore the Grant users access to this service account option. It is not required.

5. Click Create Key. In the panel that appears, select the key type JSON, then Create. This will save a private JSON key to your computer.

​

7. Upload the Service Account Key to the Glean Admin UI

1. If you haven’t already, follow the instructions from the Access the Admin UI section of the Getting Started guide.

   • Browse to https://app.glean.com/admin
   • Enter your email to receive a link via email to sign in.

2. On the page titled Create a Google Cloud Platform project, click the box under Step 2 to upload the private JSON key to Glean.

3. Click Save. Glean will now use the JSON key to validate that all the steps above have been performed correctly.

​

Troubleshooting

For Error Codes and troubleshooting steps, please see the Troubleshooting section.

​

FAQ