coder/examples/templates/devcontainer-kubernetes
Frederik Dudzik 5780050493
chore(docs): fix broken links (#13056)
* fix broken links

* fmt
2024-04-24 11:21:22 +03:00
..
README.md chore(docs): fix broken links (#13056) 2024-04-24 11:21:22 +03:00
main.tf chore(examples): remove deprecated startup_script_timeout and shutdown_script_timeout (#12104) 2024-02-12 14:29:41 +00:00

README.md

display_name description icon maintainer_github verified tags
Devcontainers (Kubernetes) Provision envbuilder pods as Coder workspaces ../../../site/static/icon/k8s.png coder true
container
kubernetes
devcontainer

Remote Development on Kubernetes Pods (with Devcontainers)

Provision Kubernetes Pods as Coder workspaces with this example template.

Prerequisites

Infrastructure

Cluster: This template requires an existing Kubernetes cluster

Container Image: This template uses the codercom/enterprise-base:ubuntu image 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, edit the template.

Architecture

Coder supports devcontainers with envbuilder, an open source project. Read more about this in Coder's documentation.

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 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.