Google Compute Engine (Devcontainer)

1terraform {
2  required_providers {
3    coder = {
4      source = "coder/coder"
5    }
6    google = {
7      source = "hashicorp/google"
8    }
9  }
10}
11
12provider "coder" {
13}
14
15variable "project_id" {
16  description = "Which Google Compute Project should your workspace live in?"
17}
18
19data "coder_parameter" "zone" {
20  name         = "zone"
21  display_name = "Zone"
22  description  = "Which zone should your workspace live in?"
23  type         = "string"
24  icon         = "/emojis/1f30e.png"
25  default      = "us-central1-a"
26  mutable      = false
27  option {
28    name  = "North America (Northeast)"
29    value = "northamerica-northeast1-a"
30    icon  = "/emojis/1f1fa-1f1f8.png"
31  }
32  option {
33    name  = "North America (Central)"
34    value = "us-central1-a"
35    icon  = "/emojis/1f1fa-1f1f8.png"
36  }
37  option {
38    name  = "North America (West)"
39    value = "us-west2-c"
40    icon  = "/emojis/1f1fa-1f1f8.png"
41  }
42  option {
43    name  = "Europe (West)"
44    value = "europe-west4-b"
45    icon  = "/emojis/1f1ea-1f1fa.png"
46  }
47  option {
48    name  = "South America (East)"
49    value = "southamerica-east1-a"
50    icon  = "/emojis/1f1e7-1f1f7.png"
51  }
52}
53
54provider "google" {
55  zone    = data.coder_parameter.zone.value
56  project = var.project_id
57}
58
59data "google_compute_default_service_account" "default" {
60}
61
62data "coder_workspace" "me" {
63}
64
65resource "google_compute_disk" "root" {
66  name  = "coder-${data.coder_workspace.me.id}-root"
67  type  = "pd-ssd"
68  image = "debian-cloud/debian-12"
69  lifecycle {
70    ignore_changes = [name, image]
71  }
72}
73
74data "coder_parameter" "repo_url" {
75  name         = "repo_url"
76  display_name = "Repository URL"
77  default      = "https://github.com/coder/envbuilder-starter-devcontainer"
78  description  = "Repository URL"
79  mutable      = true
80}
81
82resource "coder_agent" "dev" {
83  count              = data.coder_workspace.me.start_count
84  arch               = "amd64"
85  auth               = "token"
86  os                 = "linux"
87  dir                = "/workspaces/${trimsuffix(basename(data.coder_parameter.repo_url.value), ".git")}"
88  connection_timeout = 0
89
90  metadata {
91    key          = "cpu"
92    display_name = "CPU Usage"
93    interval     = 5
94    timeout      = 5
95    script       = "coder stat cpu"
96  }
97  metadata {
98    key          = "memory"
99    display_name = "Memory Usage"
100    interval     = 5
101    timeout      = 5
102    script       = "coder stat mem"
103  }
104  metadata {
105    key          = "disk"
106    display_name = "Disk Usage"
107    interval     = 5
108    timeout      = 5
109    script       = "coder stat disk"
110  }
111}
112
113module "code-server" {
114  count    = data.coder_workspace.me.start_count
115  source   = "https://registry.coder.com/modules/code-server"
116  agent_id = coder_agent.dev[0].id
117}
118
119resource "google_compute_instance" "vm" {
120  name         = "coder-${lower(data.coder_workspace.me.owner)}-${lower(data.coder_workspace.me.name)}-root"
121  machine_type = "e2-medium"
122  # data.coder_workspace.me.owner == "default"  is a workaround to suppress error in the terraform plan phase while creating a new workspace.
123  desired_status = (data.coder_workspace.me.owner == "default" || data.coder_workspace.me.start_count == 1) ? "RUNNING" : "TERMINATED"
124
125  network_interface {
126    network = "default"
127    access_config {
128      // Ephemeral public IP
129    }
130  }
131
132  boot_disk {
133    auto_delete = false
134    source      = google_compute_disk.root.name
135  }
136
137  service_account {
138    email  = data.google_compute_default_service_account.default.email
139    scopes = ["cloud-platform"]
140  }
141
142  metadata = {
143    # The startup script runs as root with no $HOME environment set up, so instead of directly
144    # running the agent init script, create a user (with a homedir, default shell and sudo
145    # permissions) and execute the init script as that user.
146    startup-script = <<-META
147    #!/usr/bin/env sh
148    set -eux
149
150    # If user does not exist, create it and set up passwordless sudo
151    if ! id -u "${local.linux_user}" >/dev/null 2>&1; then
152      useradd -m -s /bin/bash "${local.linux_user}"
153      echo "${local.linux_user} ALL=(ALL) NOPASSWD:ALL" > /etc/sudoers.d/coder-user
154    fi
155
156    # Check for Docker, install if not present
157    if ! command -v docker &> /dev/null
158    then
159      echo "Docker not found, installing..."
160      curl -fsSL https://get.docker.com -o get-docker.sh && sudo sh get-docker.sh 2>&1 >/dev/null
161      sudo usermod -aG docker ${local.linux_user}
162      newgrp docker
163    else
164      echo "Docker is already installed."
165    fi
166    # Start envbuilder
167    docker run --rm \
168      -h ${lower(data.coder_workspace.me.name)} \
169      -v /home/${local.linux_user}/envbuilder:/workspaces \
170      -e CODER_AGENT_TOKEN="${try(coder_agent.dev[0].token, "")}" \
171      -e CODER_AGENT_URL="${data.coder_workspace.me.access_url}" \
172      -e GIT_URL="${data.coder_parameter.repo_url.value}" \
173      -e INIT_SCRIPT="echo ${base64encode(try(coder_agent.dev[0].init_script, ""))} | base64 -d | sh" \
174      -e FALLBACK_IMAGE="codercom/enterprise-base:ubuntu" \
175      ghcr.io/coder/envbuilder
176    META
177  }
178}
179
180locals {
181  # Ensure Coder username is a valid Linux username
182  linux_user = lower(substr(data.coder_workspace.me.owner, 0, 32))
183}
184
185resource "coder_metadata" "workspace_info" {
186  count       = data.coder_workspace.me.start_count
187  resource_id = google_compute_instance.vm.id
188
189  item {
190    key   = "type"
191    value = google_compute_instance.vm.machine_type
192  }
193
194  item {
195    key   = "zone"
196    value = data.coder_parameter.zone.value
197  }
198}
199
200resource "coder_metadata" "home_info" {
201  resource_id = google_compute_disk.root.id
202
203  item {
204    key   = "size"
205    value = "${google_compute_disk.root.size} GiB"
206  }
207}
208