coder/examples/templates/kubernetes
Colin Adler 817cc78b94
fix(examples): remove dead code comment (#12194)
2024-02-17 17:38:19 +00:00
..
README.md docs: fix example template README 404s and semantics (#11903) 2024-01-29 21:34:12 +00:00
main.tf fix(examples): remove dead code comment (#12194) 2024-02-17 17:38:19 +00:00

README.md

display_name description icon maintainer_github verified tags
Kubernetes (Deployment) Provision Kubernetes Deployments as Coder workspaces ../../../site/static/icon/k8s.png coder true
kubernetes
container

Remote Development on Kubernetes Pods

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

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.