# terraform-google-executors

**Repository Path**: mirrors_sourcegraph/terraform-google-executors

## Basic Information

- **Project Name**: terraform-google-executors
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-10-22
- **Last Updated**: 2025-12-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Terraform module for Sourcegraph executors (GCP)

This repository provides a [Terraform module](https://learn.hashicorp.com/tutorials/terraform/module-use?in=terraform/modules) to provision [Sourcegraph executor](https://sourcegraph.com/docs/admin/executors) compute resources on Google Cloud. If you are installing executors for the first time, [follow our complete setup guide](https://sourcegraph.com/docs/admin/executors/deploy_executors).

![Infrastructure overview](https://raw.githubusercontent.com/sourcegraph/terraform-google-executors/master/images/infrastructure.png)

This repository provides four submodules:

1. The [executors module](https://registry.terraform.io/modules/sourcegraph/executors/google/6.11.0/submodules/executors) provisions compute resources for executors.
2. The [docker-mirror module](https://registry.terraform.io/modules/sourcegraph/executors/google/6.11.0/submodules/docker-mirror) provisions a Docker registry pull-through cache.
3. The [networking module](https://registry.terraform.io/modules/sourcegraph/executors/google/6.11.0/submodules/networking) provisions a network to be shared by the executor and Docker registry resources.
4. The [credentials module](https://registry.terraform.io/modules/sourcegraph/executors/google/6.11.0/submodules/credentials) provisions credentials required by the Sourcegraph instance to enable observability and auto-scaling of executors.

The [multiple-executors example](https://github.com/sourcegraph/terraform-google-executors/blob/v6.11.0/examples/multiple-executors) uses the submodule directly to provision multiple executor resource groups performing different types of work. Follow this example if you are:
1. Provisioning executors for use with multiple features (e.g., both [auto-indexing](https://sourcegraph.com/docs/code_intelligence/explanations/auto_indexing) and [server-side batch changes](https://sourcegraph.com/docs/batch_changes/explanations/server_side)), or
2. Provisioning resources for multiple Sourcegraph instances (e.g., test, prod)

This repository also provides a [root module](https://registry.terraform.io/modules/sourcegraph/executors/google/6.11.0) combining the executors, network, and docker-mirror resources into an easier to use package.

The [single-executor example](https://github.com/sourcegraph/terraform-google-executors/blob/v6.11.0/examples/single-executor) uses the root module to provision a single executor type. Follow this example if you are deploying to a single Sourcegraph instance and using a single executors-backed feature.

## Requirements

- [Terraform](https://www.terraform.io/) 
  - 4.1.x and below: `~> 1.1.x`
  - 4.2.x and above: `>= 1.1.0, < 2.0.0`
- [hashicorp/google](https://registry.terraform.io/providers/hashicorp/google) 
  - `>= 3.26, < 5.0`

## Setup

Please follow our [setup guide](https://sourcegraph.com/docs/admin/executors/deploy_executors_terraform) on how to deploy
executors using Terraform.

## Compatibility with Sourcegraph

The **major** and **minor** versions both need to match the Sourcegraph version the executors are talking to. Patch version **don't** need to match and it's generally advised to use the latest available.
For example:

| **Sourcegraph version** | **Terraform module version** |
|-------------------------|------------------------------|
| 3.37.0                  | 3.37.\*                      |
| 3.37.3                  | 3.37.\*                      |
| 3.38.0                  | 3.38.\*                      |