fix: Improve docker example first user experience (coder#4972)

mafredri · web-flow · commit 570a1ffc2b3f · 2022-11-10T12:55:39.000+02:00
The base ubuntu image lands the user as root, but the terraform tempalte
expected /home/coder to be used. This change adds a user with the same
name as the Coder users username and allows them to sudo.
diff --git a/examples/templates/docker/build/Dockerfile b/examples/templates/docker/build/Dockerfile
@@ -1,3 +1,18 @@
 FROM ubuntu
 
-RUN apt-get update && apt-get install -y curl wget git vim golang
+RUN apt-get update \
+	&& apt-get install -y \
+	curl \
+	git \
+	golang \
+	sudo \
+	vim \
+	wget \
+	&& rm -rf /var/lib/apt/lists/*
+
+ARG USER=coder
+RUN useradd --groups sudo --no-create-home ${USER} \
+	&& echo "${USER} ALL=(ALL) NOPASSWD:ALL" >/etc/sudoers.d/${USER} \
+	&& chmod 0440 /etc/sudoers.d/${USER}
+USER ${USER}
+WORKDIR /home/${USER}
diff --git a/examples/templates/docker/main.tf b/examples/templates/docker/main.tf
@@ -11,6 +11,10 @@ terraform {
   }
 }
 
+locals {
+  username = data.coder_workspace.me.owner
+}
+
 data "coder_provisioner" "me" {
 }
 
@@ -46,7 +50,7 @@ resource "coder_app" "code-server" {
   agent_id     = coder_agent.main.id
   slug         = "code-server"
   display_name = "code-server"
-  url          = "http://localhost:13337/?folder=/home/coder"
+  url          = "http://localhost:13337/?folder=/home/${local.username}"
   icon         = "/icon/code.svg"
   subdomain    = false
   share        = "owner"
@@ -91,6 +95,9 @@ resource "docker_image" "main" {
   name = "coder-${data.coder_workspace.me.id}"
   build {
     path = "./build"
+    build_arg = {
+      USER = local.username
+    }
   }
   triggers = {
     dir_sha1 = sha1(join("", [for f in fileset(path.module, "build/*") : filesha1(f)]))
@@ -112,7 +119,7 @@ resource "docker_container" "workspace" {
     ip   = "host-gateway"
   }
   volumes {
-    container_path = "/home/coder/"
+    container_path = "/home/${local.username}"
     volume_name    = docker_volume.home_volume.name
     read_only      = false
   }

Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,10 @@ terraform {`
`11`	`11`	`}`
`12`	`12`	`}`
`13`	`13`
	`14`	`+locals {`
	`15`	`+ username = data.coder_workspace.me.owner`
	`16`	`+}`
	`17`	`+`
`14`	`18`	`data "coder_provisioner" "me" {`
`15`	`19`	`}`
`16`	`20`
`@@ -46,7 +50,7 @@ resource "coder_app" "code-server" {`
`46`	`50`	`agent_id = coder_agent.main.id`
`47`	`51`	`slug = "code-server"`
`48`	`52`	`display_name = "code-server"`
`49`		`- url = "http://localhost:13337/?folder=/home/coder"`
	`53`	`+ url = "http://localhost:13337/?folder=/home/${local.username}"`
`50`	`54`	`icon = "/icon/code.svg"`
`51`	`55`	`subdomain = false`
`52`	`56`	`share = "owner"`
`@@ -91,6 +95,9 @@ resource "docker_image" "main" {`
`91`	`95`	`name = "coder-${data.coder_workspace.me.id}"`
`92`	`96`	`build {`
`93`	`97`	`path = "./build"`
	`98`	`+ build_arg = {`
	`99`	`+ USER = local.username`
	`100`	`+ }`
`94`	`101`	`}`
`95`	`102`	`triggers = {`
`96`	`103`	`dir_sha1 = sha1(join("", [for f in fileset(path.module, "build/*") : filesha1(f)]))`
`@@ -112,7 +119,7 @@ resource "docker_container" "workspace" {`
`112`	`119`	`ip = "host-gateway"`
`113`	`120`	`}`
`114`	`121`	`volumes {`
`115`		`- container_path = "/home/coder/"`
	`122`	`+ container_path = "/home/${local.username}"`
`116`	`123`	`volume_name = docker_volume.home_volume.name`
`117`	`124`	`read_only = false`
`118`	`125`	`}`