Compass Install

Sets up your GCP project for Compass data warehouse.

Before you start

You need the Owner role on the GCP project you are connecting to Compass, and the project must be linked to a billing account.

Run it

1. In the Google Cloud console, select your project in the project picker at the top of the page.

2. Open Cloud Shell with the Activate Cloud Shell button (>_) in the top bar.

3. Paste this command:

   rm -rf compass-install; \
   git clone https://github.com/further-external/compass-install.git && \
   bash compass-install/grant_compass_roles.sh

4. Follow instructions in the console.

It takes about 5 minutes. When it finishes you'll see Done. message.

What it does

1. Enables the Google Cloud APIs Compass uses.
2. Creates internal compass-data service account.
3. Creates the Docker repository in Artifact Registry for the Compass pipeline images.
4. Creates the Cloud Storage bucket for the Compass Terraform state.
5. Grants IAM roles to the Compass service accounts:

Service account	What it does	Roles
compass-data@	Internal service account. Runs the Compass data pipelines from Artifact Registry.	Editor BigQuery Admin Storage Object Admin Secret Manager Secret Accessor Private Logs Viewer
compass-infrastructure@	Creates and maintains the Compass resources in your project.	Editor BigQuery Admin Storage Admin Secret Manager Secret Accessor
compass-read@	Used by the Compass web app to read the data for dashboards and AI features.	BigQuery Data Viewer BigQuery Job User Storage Object Viewer Storage Bucket Viewer Gemini Data Analytics Data Agent User Gemini for Google Cloud User Agent Platform User Model Armor User
compass-write@	Used by the Compass web app to save data to BigQuery and Cloud Storage in your project.	BigQuery Data Editor BigQuery Job User Agent Platform User Storage Admin