mirror of
https://github.com/coder/coder.git
synced 2026-06-06 06:28:20 +00:00
Phorcys
069655ace9
This PR changes template names and docs to follow the `<provider>-<os/whatever>` format for all templates. I've decided not to split this into multiple PRs because I'd have to edit rebase the other PRs once one of them gets merged, this should be relatively low-impact anyways. This aligns with our goals to make templates more user-friendly. Closes #15754
58 lines
3.2 KiB
Markdown
58 lines
3.2 KiB
Markdown
---
|
|
display_name: Kubernetes (Devcontainer)
|
|
description: Provision envbuilder pods as Coder workspaces
|
|
icon: ../../../site/static/icon/k8s.png
|
|
maintainer_github: coder
|
|
verified: true
|
|
tags: [container, kubernetes, devcontainer]
|
|
---
|
|
|
|
# Remote Development on Kubernetes Pods (with Devcontainers)
|
|
|
|
Provision Devcontainers as [Coder workspaces](https://coder.com/docs/workspaces) on Kubernetes with this example template.
|
|
|
|
## Prerequisites
|
|
|
|
### Infrastructure
|
|
|
|
**Cluster**: This template requires an existing Kubernetes cluster.
|
|
|
|
**Container Image**: This template uses the [envbuilder image](https://github.com/coder/envbuilder) to build a Devcontainer from a `devcontainer.json`.
|
|
|
|
**(Optional) Cache Registry**: Envbuilder can utilize a Docker registry as a cache to speed up workspace builds. The [envbuilder Terraform provider](https://github.com/coder/terraform-provider-envbuilder) will check the contents of the cache to determine if a prebuilt image exists. In the case of some missing layers in the registry (partial cache miss), Envbuilder can still utilize some of the build cache from the registry.
|
|
|
|
### 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/templates/dev-containers).
|
|
|
|
This template provisions the following resources:
|
|
|
|
- Kubernetes deployment (ephemeral)
|
|
- Kubernetes persistent volume claim (persistent on `/workspaces`)
|
|
- Envbuilder cached image (optional, persistent).
|
|
|
|
This template will fetch a Git repo containing a `devcontainer.json` specified by the `repo` parameter, and builds it
|
|
with [`envbuilder`](https://github.com/coder/envbuilder).
|
|
The Git repository is cloned inside the `/workspaces` volume if not present.
|
|
Any local changes to the Devcontainer files inside the volume will be applied when you restart the workspace.
|
|
As you might suspect, any tools or files outside of `/workspaces` or not added as part of the Devcontainer specification are not persisted.
|
|
Edit the `devcontainer.json` instead!
|
|
|
|
> **Note**
|
|
> This template is designed to be a starting point! Edit the Terraform to extend the template to support your use case.
|
|
|
|
## Caching
|
|
|
|
To speed up your builds, you can use a container registry as a cache.
|
|
When creating the template, set the parameter `cache_repo`.
|
|
|
|
See the [Envbuilder Terraform Provider Examples](https://github.com/coder/terraform-provider-envbuilder/blob/main/examples/resources/envbuilder_cached_image/envbuilder_cached_image_resource.tf/) for a more complete example of how the provider works.
|
|
|
|
> [!NOTE] We recommend using a registry cache with authentication enabled.
|
|
> To allow Envbuilder to authenticate with the registry cache, specify the variable `cache_repo_dockerconfig_secret`
|
|
> with the name of a Kubernetes secret in the same namespace as Coder. The secret must contain the key `.dockerconfigjson`.
|