--id aws-devcontainer|aws-linux|aws-windows|azure-linux|do-linux|docker|gcp-devcontainer|gcp-linux|gcp-vm-container|gcp-windows|kubernetes|nomad-docker

{

"id": "aws-devcontainer",

"url": "",

"name": "AWS EC2 (Devcontainer)",

"description": "Provision AWS EC2 VMs with a devcontainer as Coder workspaces",

"icon": "/icon/aws.png",

"tags": [

"vm",

"linux",

"aws",

"persistent",

"devcontainer"

],

"markdown": "\n# Remote Development on AWS EC2 VMs using a Devcontainer\n\nProvision AWS EC2 VMs as [Coder workspaces](https://coder.com/docs/v2/latest) with this example template.\n\n\n\u003c!-- TODO: Add screenshot --\u003e\n\n## Prerequisites\n\n### Authentication\n\nBy default, this template authenticates to AWS using the provider's default [authentication methods](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#authentication-and-configuration).\n\nThe simplest way (without making changes to the template) is via environment variables (e.g. `AWS_ACCESS_KEY_ID`) or a [credentials file](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html#cli-configure-files-format). If you are running Coder on a VM, this file must be in `/home/coder/aws/credentials`.\n\nTo use another [authentication method](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#authentication), edit the template.\n\n## Required permissions / policy\n\nThe following sample policy allows Coder to create EC2 instances and modify\ninstances provisioned by Coder:\n\n```json\n{\n \"Version\": \"2012-10-17\",\n \"Statement\": [\n {\n \"Sid\": \"VisualEditor0\",\n \"Effect\": \"Allow\",\n \"Action\": [\n \"ec2:GetDefaultCreditSpecification\",\n \"ec2:DescribeIamInstanceProfileAssociations\",\n \"ec2:DescribeTags\",\n \"ec2:DescribeInstances\",\n \"ec2:DescribeInstanceTypes\",\n \"ec2:CreateTags\",\n \"ec2:RunInstances\",\n \"ec2:DescribeInstanceCreditSpecifications\",\n \"ec2:DescribeImages\",\n \"ec2:ModifyDefaultCreditSpecification\",\n \"ec2:DescribeVolumes\"\n ],\n \"Resource\": \"*\"\n },\n {\n \"Sid\": \"CoderResources\",\n \"Effect\": \"Allow\",\n \"Action\": [\n \"ec2:DescribeInstanceAttribute\",\n \"ec2:UnmonitorInstances\",\n \"ec2:TerminateInstances\",\n \"ec2:StartInstances\",\n \"ec2:StopInstances\",\n \"ec2:DeleteTags\",\n \"ec2:MonitorInstances\",\n \"ec2:CreateTags\",\n \"ec2:RunInstances\",\n \"ec2:ModifyInstanceAttribute\",\n \"ec2:ModifyInstanceCreditSpecification\"\n ],\n \"Resource\": \"arn:aws:ec2:*:*:instance/*\",\n \"Condition\": {\n \"StringEquals\": {\n \"aws:ResourceTag/Coder_Provisioned\": \"true\"\n }\n }\n }\n ]\n}\n```\n\n## Architecture\n\nThis template provisions the following resources:\n\n- AWS Instance\n\nCoder uses `aws_ec2_instance_state` to start and stop the VM. This example template is fully persistent, meaning the full filesystem is preserved when the workspace restarts. See this [community example](https://github.com/bpmct/coder-templates/tree/main/aws-linux-ephemeral) of an ephemeral AWS instance.\n\n\u003e **Note**\n\u003e This template is designed to be a starting point! Edit the Terraform to extend the template to support your use case.\n\n## code-server\n\n`code-server` is installed via the [`code-server`](https://registry.coder.com/modules/code-server) registry module. For a list of all modules and templates pplease check [Coder Registry](https://registry.coder.com).\n"

},

{

"id": "gcp-devcontainer",

"url": "",

"name": "Google Compute Engine (Devcontainer)",

"description": "Provision a Devcontainer on Google Compute Engine instances as Coder workspaces",

"icon": "/icon/gcp.png",

"tags": [

"vm",

"linux",

"gcp",

"devcontainer"

],

"markdown": "\n# Remote Development in a Devcontainer on Google Compute Engine\n\n\n\n## Prerequisites\n\n### Authentication\n\nThis template assumes that coderd is run in an environment that is authenticated\nwith Google Cloud. For example, run `gcloud auth application-default login` to\nimport credentials on the system and user running coderd. For other ways to\nauthenticate [consult the Terraform\ndocs](https://registry.terraform.io/providers/hashicorp/google/latest/docs/guides/getting_started#adding-credentials).\n\nCoder requires a Google Cloud Service Account to provision workspaces. To create\na service account:\n\n1. Navigate to the [CGP\n console](https://console.cloud.google.com/projectselector/iam-admin/serviceaccounts/create),\n and select your Cloud project (if you have more than one project associated\n with your account)\n\n1. Provide a service account name (this name is used to generate the service\n account ID)\n\n1. Click **Create and continue**, and choose the following IAM roles to grant to\n the service account:\n\n - Compute Admin\n - Service Account User\n\n Click **Continue**.\n\n1. Click on the created key, and navigate to the **Keys** tab.\n\n1. Click **Add key** \u003e **Create new key**.\n\n1. Generate a **JSON private key**, which will be what you provide to Coder\n during the setup process.\n\n## Architecture\n\nThis template provisions the following resources:\n\n- GCP VM (persistent)\n- GCP Disk (persistent, mounted to root)\n\nCoder persists the root volume. The full filesystem is preserved when the workspace restarts.\n\n\u003e **Note**\n\u003e This template is designed to be a starting point! Edit the Terraform to extend the template to support your use case.\n\n## code-server\n\n`code-server` is installed via the [`code-server`](https://registry.coder.com/modules/code-server) registry module. Please check [Coder Registry](https://registry.coder.com) for a list of all modules and templates.\n"

},

//go:embed templates/aws-devcontainer

//go:embed templates/gcp-devcontainer

display_name: Google Compute Engine (Devcontainer)

description: Provision a Devcontainer on Google Compute Engine instances as Coder workspaces

icon: ../../../site/static/icon/gcp.png

maintainer_github: coder

verified: true

tags: [vm, linux, gcp, devcontainer]


This template assumes that coderd is run in an environment that is authenticated

with Google Cloud. For example, run `gcloud auth application-default login` to

import credentials on the system and user running coderd. For other ways to

authenticate [consult the Terraform

docs](https://registry.terraform.io/providers/hashicorp/google/latest/docs/guides/getting_started#adding-credentials).

Coder requires a Google Cloud Service Account to provision workspaces. To create

a service account:

1. Navigate to the [CGP

console](https://console.cloud.google.com/projectselector/iam-admin/serviceaccounts/create),

and select your Cloud project (if you have more than one project associated

with your account)

1. Provide a service account name (this name is used to generate the service

account ID)

1. Click **Create and continue**, and choose the following IAM roles to grant to

the service account:

- Compute Admin

- Service Account User

Click **Continue**.

1. Click on the created key, and navigate to the **Keys** tab.

1. Click **Add key** > **Create new key**.

1. Generate a **JSON private key**, which will be what you provide to Coder

during the setup process.

This template provisions the following resources:

- GCP VM (persistent)

- GCP Disk (persistent, mounted to root)

Coder persists the root volume. The full filesystem is preserved when the workspace restarts.

`code-server` is installed via the [`code-server`](https://registry.coder.com/modules/code-server) registry module. Please check [Coder Registry](https://registry.coder.com) for a list of all modules and templates.

terraform {

required_providers {

coder = {

source = "coder/coder"

}

google = {

source = "hashicorp/google"

}

}

}

provider "coder" {

}

variable "project_id" {

description = "Which Google Compute Project should your workspace live in?"

}

data "coder_parameter" "zone" {

name = "zone"

display_name = "Zone"

description = "Which zone should your workspace live in?"

type = "string"

icon = "/emojis/1f30e.png"

default = "us-central1-a"

mutable = false

option {

name = "North America (Northeast)"

value = "northamerica-northeast1-a"

icon = "/emojis/1f1fa-1f1f8.png"

}

option {

name = "North America (Central)"

value = "us-central1-a"

icon = "/emojis/1f1fa-1f1f8.png"

}

option {

name = "North America (West)"

value = "us-west2-c"

icon = "/emojis/1f1fa-1f1f8.png"

}

option {

name = "Europe (West)"

value = "europe-west4-b"

icon = "/emojis/1f1ea-1f1fa.png"

}

option {

name = "South America (East)"

value = "southamerica-east1-a"

icon = "/emojis/1f1e7-1f1f7.png"

}

}

provider "google" {

zone = data.coder_parameter.zone.value

project = var.project_id

}

data "google_compute_default_service_account" "default" {

}

data "coder_workspace" "me" {

}

resource "google_compute_disk" "root" {

name = "coder-${data.coder_workspace.me.id}-root"

type = "pd-ssd"

image = "debian-cloud/debian-12"

lifecycle {

ignore_changes = [name, image]

}

}

data "coder_parameter" "repo_url" {

name = "repo_url"

display_name = "Repository URL"

default = "https://github.com/coder/envbuilder-starter-devcontainer"

description = "Repository URL"

mutable = true

}

resource "coder_agent" "dev" {

count = data.coder_workspace.me.start_count

arch = "amd64"

auth = "token"

os = "linux"

dir = "/workspaces/${trimsuffix(basename(data.coder_parameter.repo_url.value), ".git")}"

connection_timeout = 0

metadata {

key = "cpu"

display_name = "CPU Usage"

interval = 5

timeout = 5

script = "coder stat cpu"

}

metadata {

key = "memory"

display_name = "Memory Usage"

interval = 5

timeout = 5

script = "coder stat mem"

}

metadata {

key = "disk"

display_name = "Disk Usage"

interval = 5

timeout = 5

script = "coder stat disk"

}

}

module "code-server" {

count = data.coder_workspace.me.start_count

source = "https://registry.coder.com/modules/code-server"

agent_id = coder_agent.dev[0].id

}

resource "google_compute_instance" "vm" {

name = "coder-${lower(data.coder_workspace.me.owner)}-${lower(data.coder_workspace.me.name)}-root"

machine_type = "e2-medium"

# data.coder_workspace.me.owner == "default" is a workaround to suppress error in the terraform plan phase while creating a new workspace.

desired_status = (data.coder_workspace.me.owner == "default" || data.coder_workspace.me.start_count == 1) ? "RUNNING" : "TERMINATED"

network_interface {

network = "default"

access_config {

// Ephemeral public IP

}

}

boot_disk {

auto_delete = false

source = google_compute_disk.root.name

}

service_account {

email = data.google_compute_default_service_account.default.email

scopes = ["cloud-platform"]

}

metadata = {

# The startup script runs as root with no $HOME environment set up, so instead of directly

# running the agent init script, create a user (with a homedir, default shell and sudo

# permissions) and execute the init script as that user.

startup-script = <<-META

}

}

locals {

# Ensure Coder username is a valid Linux username

linux_user = lower(substr(data.coder_workspace.me.owner, 0, 32))

}

resource "coder_metadata" "workspace_info" {

count = data.coder_workspace.me.start_count

resource_id = google_compute_instance.vm.id

item {

key = "type"

value = google_compute_instance.vm.machine_type

}

item {

key = "zone"

value = data.coder_parameter.zone.value

}

}

resource "coder_metadata" "home_info" {

resource_id = google_compute_disk.root.id

item {

key = "size"

value = "${google_compute_disk.root.size} GiB"

}

}