chore: README updates

ericpaulsen · ericpaulsen · commit 8d6f88dc9515 · 2022-08-22T17:53:14.000-05:00
diff --git a/examples/templates/kubernetes-pod/README.md b/examples/templates/kubernetes-pod/README.md
@@ -72,7 +72,18 @@ roleRef:
 
 Then start the Coder host with `serviceAccountName: coder` in the pod spec.
 
+## Namespace
+
+The target namespace in which the pod will be deployed is defined via the `coder_workspace`
+variable. The namespace must exist prior to creating workspaces.
+
 ## Persistence
 
 The `/home/coder` directory in this example is persisted via the attached PersistentVolumeClaim.
 Any data saved outside of this directory will be wiped when the workspace stops.
+
+## code-server
+
+`code-server` is installed via the `startup_script` argument in the `coder_agent`
+resource block. The `coder_app` resource is defined to access `code-server` through
+the dashboard UI over `localhost:13337`.
diff --git a/examples/templates/kubernetes-pod/main.tf b/examples/templates/kubernetes-pod/main.tf
@@ -25,11 +25,11 @@ variable "use_kubeconfig" {
   EOF
 }
 
-variable "workspaces_namespace" {
+variable "coder_namespace" {
   type        = string
   sensitive   = true
   description = "The namespace to create workspaces in (must exist prior to creating workspaces)"
-  default     = "coder-workspace"
+  default     = "coder-namespace"
 }
 
 variable "disk_size" {
@@ -70,7 +70,7 @@ resource "kubernetes_pod" "main" {
   count = data.coder_workspace.me.start_count
   metadata {
     name      = "coder-${data.coder_workspace.me.owner}-${data.coder_workspace.me.name}"
-    namespace = var.workspaces_namespace
+    namespace = var.coder_namespace
   }
   spec {
     security_context {
@@ -105,7 +105,7 @@ resource "kubernetes_pod" "main" {
 resource "kubernetes_persistent_volume_claim" "home-directory" {
   metadata {
     name      = "home-coder-java-${data.coder_workspace.me.owner}-${data.coder_workspace.me.name}"
-    namespace = var.workspaces_namespace
+    namespace = var.coder_namespace
   }
   spec {
     access_modes = ["ReadWriteOnce"]
