mirror of
https://github.com/coder/coder.git
synced 2026-09-24 15:04:27 +08:00
Makes it easier to pick the right workspace image, both in the template builder and in the docs. - Template builder: the Docker and Kubernetes bases now expose a `container_image` variable in the wizard (freeform text, defaults to `codercom/example-base:ubuntu`), and their prerequisites explain why image choice matters, with tradeoffs between `codercom/example-base:ubuntu` (minimal) and `codercom/example-universal:ubuntu` (catch-all), plus pointers to [coder/images](https://github.com/coder/images) and the image management docs. - Docs: reworked [image management](https://coder.com/docs/@ben%2Fdevrel-201-image-guidance-prereqs/admin/templates/managing-templates/image-management) into a clearer maturity ladder (minimal → golden → project-specific → developer customization), with pullable image references in every example, `codercom/oss-dogfood` as a project-specific example, and Dev Containers + [mise](https://mise.jdx.dev/) as ways to customize without new images. Companion PR for the starter templates: coder/registry#943 Part of DEVREL-201. 🤖 Generated with Coder Agents using Claude, on behalf of @bpmct (wizard variable by @jeremyruppel in #27024) --------- Co-authored-by: Jeremy Ruppel <jeremyruppel@users.noreply.github.com>
322 lines
8.6 KiB
Cheetah
322 lines
8.6 KiB
Cheetah
terraform {
|
|
required_providers {
|
|
coder = {
|
|
source = "coder/coder"
|
|
}
|
|
kubernetes = {
|
|
source = "hashicorp/kubernetes"
|
|
}
|
|
}
|
|
}
|
|
|
|
provider "coder" {
|
|
}
|
|
|
|
provider "kubernetes" {
|
|
# Authenticate via ~/.kube/config or a Coder-specific ServiceAccount, depending on admin preferences
|
|
config_path = {{ .Variables.use_kubeconfig }} == true ? "~/.kube/config" : null
|
|
}
|
|
|
|
data "coder_parameter" "cpu" {
|
|
name = "cpu"
|
|
display_name = "CPU"
|
|
description = "The number of CPU cores"
|
|
default = "2"
|
|
icon = "/icon/memory.svg"
|
|
mutable = true
|
|
option {
|
|
name = "2 Cores"
|
|
value = "2"
|
|
}
|
|
option {
|
|
name = "4 Cores"
|
|
value = "4"
|
|
}
|
|
option {
|
|
name = "6 Cores"
|
|
value = "6"
|
|
}
|
|
option {
|
|
name = "8 Cores"
|
|
value = "8"
|
|
}
|
|
}
|
|
|
|
data "coder_parameter" "memory" {
|
|
name = "memory"
|
|
display_name = "Memory"
|
|
description = "The amount of memory in GB"
|
|
default = "2"
|
|
icon = "/icon/memory.svg"
|
|
mutable = true
|
|
option {
|
|
name = "2 GB"
|
|
value = "2"
|
|
}
|
|
option {
|
|
name = "4 GB"
|
|
value = "4"
|
|
}
|
|
option {
|
|
name = "6 GB"
|
|
value = "6"
|
|
}
|
|
option {
|
|
name = "8 GB"
|
|
value = "8"
|
|
}
|
|
}
|
|
|
|
data "coder_parameter" "home_disk_size" {
|
|
name = "home_disk_size"
|
|
display_name = "Home disk size"
|
|
description = "The size of the home disk in GB"
|
|
default = "10"
|
|
type = "number"
|
|
icon = "/emojis/1f4be.png"
|
|
mutable = false
|
|
validation {
|
|
min = 1
|
|
max = 99999
|
|
}
|
|
}
|
|
|
|
data "coder_workspace" "me" {}
|
|
data "coder_workspace_owner" "me" {}
|
|
{{ if .ImageOptions }}
|
|
data "coder_parameter" "container_image" {
|
|
name = "container_image"
|
|
display_name = "Container Image"
|
|
default = "{{ .ContainerImage }}"
|
|
mutable = true
|
|
{{ range .ImageOptions }}
|
|
option {
|
|
name = "{{ .Name }}"
|
|
value = "{{ .Value }}"
|
|
}
|
|
{{ end }}
|
|
}
|
|
{{ end }}
|
|
resource "coder_agent" "main" {
|
|
os = "linux"
|
|
arch = "amd64"
|
|
startup_script = <<-EOT
|
|
set -e
|
|
|
|
# Add any commands that should be executed at workspace startup (e.g install requirements, start a program, etc) here
|
|
EOT
|
|
|
|
# The following metadata blocks are optional. They are used to display
|
|
# information about your workspace in the dashboard. You can remove them
|
|
# if you don't want to display any information.
|
|
# For basic resources, you can use the `coder stat` command.
|
|
# If you need more control, you can write your own script.
|
|
metadata {
|
|
display_name = "CPU Usage"
|
|
key = "0_cpu_usage"
|
|
script = "coder stat cpu"
|
|
interval = 10
|
|
timeout = 1
|
|
}
|
|
|
|
metadata {
|
|
display_name = "RAM Usage"
|
|
key = "1_ram_usage"
|
|
script = "coder stat mem"
|
|
interval = 10
|
|
timeout = 1
|
|
}
|
|
|
|
metadata {
|
|
display_name = "Home Disk"
|
|
key = "3_home_disk"
|
|
script = "coder stat disk --path $${HOME}"
|
|
interval = 60
|
|
timeout = 1
|
|
}
|
|
|
|
metadata {
|
|
display_name = "CPU Usage (Host)"
|
|
key = "4_cpu_usage_host"
|
|
script = "coder stat cpu --host"
|
|
interval = 10
|
|
timeout = 1
|
|
}
|
|
|
|
metadata {
|
|
display_name = "Memory Usage (Host)"
|
|
key = "5_mem_usage_host"
|
|
script = "coder stat mem --host"
|
|
interval = 10
|
|
timeout = 1
|
|
}
|
|
|
|
metadata {
|
|
display_name = "Load Average (Host)"
|
|
key = "6_load_host"
|
|
# get load avg scaled by number of cores
|
|
script = <<EOT
|
|
echo "`cat /proc/loadavg | awk '{ print $1 }'` `nproc`" | awk '{ printf "%0.2f", $1/$2 }'
|
|
EOT
|
|
interval = 60
|
|
timeout = 1
|
|
}
|
|
}
|
|
|
|
resource "kubernetes_persistent_volume_claim_v1" "home" {
|
|
metadata {
|
|
name = "coder-${data.coder_workspace.me.id}-home"
|
|
namespace = {{ .Variables.namespace }}
|
|
labels = {
|
|
"app.kubernetes.io/name" = "coder-pvc"
|
|
"app.kubernetes.io/instance" = "coder-pvc-${data.coder_workspace.me.id}"
|
|
"app.kubernetes.io/part-of" = "coder"
|
|
//Coder-specific labels.
|
|
"com.coder.resource" = "true"
|
|
"com.coder.workspace.id" = data.coder_workspace.me.id
|
|
"com.coder.workspace.name" = data.coder_workspace.me.name
|
|
"com.coder.user.id" = data.coder_workspace_owner.me.id
|
|
"com.coder.user.username" = data.coder_workspace_owner.me.name
|
|
}
|
|
annotations = {
|
|
"com.coder.user.email" = data.coder_workspace_owner.me.email
|
|
}
|
|
}
|
|
wait_until_bound = false
|
|
spec {
|
|
access_modes = ["ReadWriteOnce"]
|
|
resources {
|
|
requests = {
|
|
storage = "${data.coder_parameter.home_disk_size.value}Gi"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
resource "kubernetes_deployment_v1" "main" {
|
|
count = data.coder_workspace.me.start_count
|
|
depends_on = [
|
|
kubernetes_persistent_volume_claim_v1.home
|
|
]
|
|
wait_for_rollout = false
|
|
metadata {
|
|
name = "coder-${data.coder_workspace.me.id}"
|
|
namespace = {{ .Variables.namespace }}
|
|
labels = {
|
|
"app.kubernetes.io/name" = "coder-workspace"
|
|
"app.kubernetes.io/instance" = "coder-workspace-${data.coder_workspace.me.id}"
|
|
"app.kubernetes.io/part-of" = "coder"
|
|
"com.coder.resource" = "true"
|
|
"com.coder.workspace.id" = data.coder_workspace.me.id
|
|
"com.coder.workspace.name" = data.coder_workspace.me.name
|
|
"com.coder.user.id" = data.coder_workspace_owner.me.id
|
|
"com.coder.user.username" = data.coder_workspace_owner.me.name
|
|
}
|
|
annotations = {
|
|
"com.coder.user.email" = data.coder_workspace_owner.me.email
|
|
}
|
|
}
|
|
|
|
spec {
|
|
replicas = 1
|
|
selector {
|
|
match_labels = {
|
|
"app.kubernetes.io/name" = "coder-workspace"
|
|
"app.kubernetes.io/instance" = "coder-workspace-${data.coder_workspace.me.id}"
|
|
"app.kubernetes.io/part-of" = "coder"
|
|
"com.coder.resource" = "true"
|
|
"com.coder.workspace.id" = data.coder_workspace.me.id
|
|
"com.coder.workspace.name" = data.coder_workspace.me.name
|
|
"com.coder.user.id" = data.coder_workspace_owner.me.id
|
|
"com.coder.user.username" = data.coder_workspace_owner.me.name
|
|
}
|
|
}
|
|
strategy {
|
|
type = "Recreate"
|
|
}
|
|
|
|
template {
|
|
metadata {
|
|
labels = {
|
|
"app.kubernetes.io/name" = "coder-workspace"
|
|
"app.kubernetes.io/instance" = "coder-workspace-${data.coder_workspace.me.id}"
|
|
"app.kubernetes.io/part-of" = "coder"
|
|
"com.coder.resource" = "true"
|
|
"com.coder.workspace.id" = data.coder_workspace.me.id
|
|
"com.coder.workspace.name" = data.coder_workspace.me.name
|
|
"com.coder.user.id" = data.coder_workspace_owner.me.id
|
|
"com.coder.user.username" = data.coder_workspace_owner.me.name
|
|
}
|
|
}
|
|
spec {
|
|
security_context {
|
|
run_as_user = 1000
|
|
fs_group = 1000
|
|
run_as_non_root = true
|
|
}
|
|
|
|
container {
|
|
name = "dev"
|
|
{{- if .ImageOptions }}
|
|
image = data.coder_parameter.container_image.value
|
|
{{- else }}
|
|
image = {{ .Variables.container_image }}
|
|
{{- end }}
|
|
image_pull_policy = "Always"
|
|
command = ["sh", "-c", coder_agent.main.init_script]
|
|
security_context {
|
|
run_as_user = "1000"
|
|
}
|
|
env {
|
|
name = "CODER_AGENT_TOKEN"
|
|
value = coder_agent.main.token
|
|
}
|
|
resources {
|
|
requests = {
|
|
"cpu" = "250m"
|
|
"memory" = "512Mi"
|
|
}
|
|
limits = {
|
|
"cpu" = "${data.coder_parameter.cpu.value}"
|
|
"memory" = "${data.coder_parameter.memory.value}Gi"
|
|
}
|
|
}
|
|
volume_mount {
|
|
mount_path = "/home/coder"
|
|
name = "home"
|
|
read_only = false
|
|
}
|
|
}
|
|
|
|
volume {
|
|
name = "home"
|
|
persistent_volume_claim {
|
|
claim_name = kubernetes_persistent_volume_claim_v1.home.metadata.0.name
|
|
read_only = false
|
|
}
|
|
}
|
|
|
|
affinity {
|
|
// This affinity attempts to spread out all workspace pods evenly across
|
|
// nodes.
|
|
pod_anti_affinity {
|
|
preferred_during_scheduling_ignored_during_execution {
|
|
weight = 1
|
|
pod_affinity_term {
|
|
topology_key = "kubernetes.io/hostname"
|
|
label_selector {
|
|
match_expressions {
|
|
key = "app.kubernetes.io/name"
|
|
operator = "In"
|
|
values = ["coder-workspace"]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|