mirror of
https://github.com/coder/coder.git
synced 2026-06-05 05:58:20 +00:00
Muhammad Atif Ali
39 lines
1.7 KiB
Markdown
39 lines
1.7 KiB
Markdown
---
|
|
display_name: Kubernetes (Deployment)
|
|
description: Provision Kubernetes Deployments as Coder workspaces
|
|
icon: ../../../site/static/icon/k8s.png
|
|
maintainer_github: coder
|
|
verified: true
|
|
tags: [kubernetes, container]
|
|
---
|
|
|
|
# Remote Development on Kubernetes Pods
|
|
|
|
Provision Kubernetes Pods as [Coder workspaces](https://coder.com/docs/workspaces) with this example template.
|
|
|
|
<!-- TODO: Add screenshot -->
|
|
|
|
## 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
|
|
|
|
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/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.
|