dagster-contrib-gcp

Test

make test

Build

make build

Overview

This package provides integrations with Google Cloud Platform (GCP) services. It currently includes the following integrations:

Cloud Run

Cloud Run run launcher

Adds support for launching Dagster runs on Google Cloud Run. Usage is as follows:

1. Create a Cloud Run Job from your Dagster code location image to act as the run worker. If you require multiple environments/code locations, you can create multiple Cloud Run Jobs.
2. Add dagster-contrib-gcp to your Dagster webserver/daemon environment.
3. Add the following configuration to your Dagster instance YAML:

run_launcher:
  module: dagster_contrib_gcp.cloud_run.run_launcher
  class: CloudRunRunLauncher
  config:
    project:
      env: GOOGLE_CLOUD_PROJECT
    region:
      env: GOOGLE_CLOUD_REGION
    job_name_by_code_location:
      my-code-location-1: my-cloud-run-job-1
      # Optional Configuration
      my-code-location-2: 
        name: my-cloud-run-job-2
        project_id: 
          secret_name: SOME_GCP_SECRET
        region:
          env: A_DIFFERENT_GOOGLE_CLOUD_REGION

Code Location Configuration

The following configurations are supported per code-location:

# No customizations
my-code-location-1: my-cloud-run-job-1

# Environment Variable or Secrets Manager references
my-code-location-1: 
  name: my-cloud-run-job-1
  project_id:
    secret_name: A_GCP_SECRET_NAME
  region:
    env: SOME_ENVIRONMENT_VARIABLE

# Explicit in-line declaration
my-code-location-1: 
  name: my-cloud-run-job-1
  project_id: gcp_123
  region: us-central1

# Multi-container support - which container to override on run
my-code-location-1: 
  name: my-cloud-run-job-1
  project_id: gcp_123
  region: us-central1
  container_name: my-dagster-container-name

Additional steps may be required for configuring IAM permissions, etc. In particular:

• Ensure that the webserver/daemon environment has the necessary permissions to execute the Cloud Run jobs
• Ensure the webserver/daemon can access Secret Manager (if using code location configuration with Secret Manager)
• Ensure that the Cloud Run run worker jobs have the necessary permissions to execute your Dagster runs See the Cloud Run documentation for more information.