add devcontainer-k8s and move notes

bpmct · bpmct · commit 7efb54a82c6c · 2023-09-26T20:09:27.000Z
diff --git a/examples/templates/aws-linux/README.md b/examples/templates/aws-linux/README.md
@@ -79,17 +79,14 @@ instances provisioned by Coder:
 
 ## Architecture
 
-> **Note**
-> This template is designed to be a starting point! Edit the Terraform to extend the template to support your use case.
-
 This template provisions the following resources:
 
 - AWS Instance
 
 Coder 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.
 
-To get started, run `coder templates init`. When prompted, select this template.
-Follow the on-screen instructions to proceed.
+> **Note**
+> This template is designed to be a starting point! Edit the Terraform to extend the template to support your use case.
 
 ## code-server
 
diff --git a/examples/templates/aws-windows/README.md b/examples/templates/aws-windows/README.md
@@ -79,17 +79,14 @@ instances provisioned by Coder:
 
 ## Architecture
 
-> **Note**
-> This template is designed to be a starting point! Edit the Terraform to extend the template to support your use case.
-
 This template provisions the following resources:
 
 - AWS Instance
 
 Coder 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.
 
-To get started, run `coder templates init`. When prompted, select this template.
-Follow the on-screen instructions to proceed.
+> **Note**
+> This template is designed to be a starting point! Edit the Terraform to extend the template to support your use case.
 
 ## code-server
 
diff --git a/examples/templates/azure-linux/README.md b/examples/templates/azure-linux/README.md
@@ -24,16 +24,16 @@ authenticate, [consult the Terraform docs](https://registry.terraform.io/provide
 
 ## Architecture
 
-> **Note**
-> This template is designed to be a starting point! Edit the Terraform to extend the template to support your use case.
-
 This template provisions the following resources:
 
 - Azure VM (ephemeral, deleted on stop)
 - Managed disk (persistent, mounted to `/home/coder`)
 
 This means, when the workspace restarts, any tools or files outside of the home directory are not persisted. To pre-bake tools into the workspace (e.g. `python3`), modify the VM image, or use a [startup script](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/script). Alternatively, individual developers can [personalize](https://coder.com/docs/v2/latest/dotfiles) their workspaces with dotfiles.
 
+> **Note**
+> This template is designed to be a starting point! Edit the Terraform to extend the template to support your use case.
+
 ## code-server
 
 `code-server` is installed via the `startup_script` argument in the `coder_agent`
diff --git a/examples/templates/azure-windows/README.md b/examples/templates/azure-windows/README.md
@@ -24,12 +24,12 @@ authenticate, [consult the Terraform docs](https://registry.terraform.io/provide
 
 ## Architecture
 
-> **Note**
-> This template is designed to be a starting point! Edit the Terraform to extend the template to support your use case.
-
 This template provisions the following resources:
 
 - Azure VM (ephemeral, deleted on stop)
 - Managed disk (persistent, mounted to `F:`)
 
 This means, when the workspace restarts, any tools or files outside of the data directory are not persisted. To pre-bake tools into the workspace (e.g. `python3`), modify the VM image, or use a [startup script](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/script).
+
+> **Note**
+> This template is designed to be a starting point! Edit the Terraform to extend the template to support your use case.
diff --git a/examples/templates/devcontainer-kubernetes/README.md b/examples/templates/devcontainer-kubernetes/README.md
@@ -7,13 +7,34 @@ verified: true
 tags: [container, kubernetes, devcontainer]
 ---
 
-# devcontainer-kubernetes
+# Remote Development on Kubernetes Pods (with Devcontainers)
 
-Develop using [devcontainers](https://containers.dev) in Kubernetes.
+Provision Kubernetes Pods as [Coder workspaces](https://coder.com/docs/coder-v2/latest) with this example template.
 
-To get started, run `coder templates init`. When prompted, select this template.
-Follow the on-screen instructions to proceed.
+<!-- TODO: Add screenshot -->
 
-## How it works
+## Prerequisites
+
+### Infrastructure
+
+**Cluster**: This template requires an existing Kubernetes cluster
+
+**Container Image**: This template uses the [codercom/enterprise-base:ubuntu image](https://github.com/coder/enterprise-images/tree/main/images/base) with some dev tools preinstalled. To add additional tools, extend this image or build it yourself.
+
+### Authentication
+
+This template authenticates using a `~/.kube/config`, if present on the server, or via built-in authentication if the Coder provisioner is running on Kubernetes with an authorized ServiceAccount. To use another [authentication method](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs#authentication), edit the template.
+
+## Architecture
 
 Coder supports devcontainers with [envbuilder](https://github.com/coder/envbuilder), an open source project. Read more about this in [Coder's documentation](https://coder.com/docs/v2/latest/templates/devcontainers).
+
+This template provisions the following resources:
+
+- Kubernetes pod (ephemeral)
+- Kubernetes persistent volume claim (persistent on `/home/coder`)
+
+This means, when the workspace restarts, any tools or files outside of the home directory are not persisted. To pre-bake tools into the workspace (e.g. `python3`), modify the container image. Alternatively, individual developers can [personalize](https://coder.com/docs/v2/latest/dotfiles) their workspaces with dotfiles.
+
+> **Note**
+> This template is designed to be a starting point! Edit the Terraform to extend the template to support your use case.
diff --git a/examples/templates/docker/README.md b/examples/templates/docker/README.md
@@ -32,9 +32,6 @@ sudo -u coder docker ps
 
 ## Architecture
 
-> **Note**
-> This template is designed to be a starting point! Edit the Terraform to extend the template to support your use case.
-
 This template provisions the following resources:
 
 - Docker image (built by Docker socket and kept locally)
@@ -43,6 +40,9 @@ This template provisions the following resources:
 
 This means, when the workspace restarts, any tools or files outside of the home directory are not persisted. To pre-bake tools into the workspace (e.g. `python3`), modify the container image. Alternatively, individual developers can [personalize](https://coder.com/docs/v2/latest/dotfiles) their workspaces with dotfiles.
 
+> **Note**
+> This template is designed to be a starting point! Edit the Terraform to extend the template to support your use case.
+
 ### Editing the image
 
 Edit the `Dockerfile` and run `coder templates push` to update workspaces.
diff --git a/examples/templates/kubernetes/README.md b/examples/templates/kubernetes/README.md
@@ -27,12 +27,12 @@ This template authenticates using a `~/.kube/config`, if present on the server,
 
 ## Architecture
 
-> **Note**
-> This template is designed to be a starting point! Edit the Terraform to extend the template to support your use case.
-
 This template provisions the following resources:
 
 - Kubernetes pod (ephemeral)
 - Kubernetes persistent volume claim (persistent on `/home/coder`)
 
 This means, when the workspace restarts, any tools or files outside of the home directory are not persisted. To pre-bake tools into the workspace (e.g. `python3`), modify the container image. Alternatively, individual developers can [personalize](https://coder.com/docs/v2/latest/dotfiles) their workspaces with dotfiles.
+
+> **Note**
+> This template is designed to be a starting point! Edit the Terraform to extend the template to support your use case.
