coder-k8s

command module

v0.1.0 Latest Latest Go to latest Published: Feb 13, 2026 License: Apache-2.0 Imports: 13 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/coder/coder-k8s

Links

Open Source Insights

README ¶

coder-k8s

[!WARNING] Highly Experimental / Alpha Software This repository is a hackathon contribution and remains a highly experimental, alpha-stage project. Do not use this in production or expose it to end users.

coder-k8s is a Kubernetes control-plane project for managing Coder-related resources with native Kubernetes APIs.

Documentation

Start with the published docs: https://coder.github.io/coder-k8s/

Helpful entry points:

Getting started: https://coder.github.io/coder-k8s/tutorials/getting-started/
Deploy the controller: https://coder.github.io/coder-k8s/how-to/deploy-controller/
Deploy the workspace/template API server: https://coder.github.io/coder-k8s/how-to/deploy-aggregated-apiserver/
API reference: https://coder.github.io/coder-k8s/reference/api/codercontrolplane/

Prefer reading docs in-repo? See docs/ and run make docs-serve.

What this project provides

A controller-runtime operator for coder.com/v1alpha1 resources:
- CoderControlPlane
- CoderProvisioner
- CoderWorkspaceProxy
A workspace/template API server for aggregation.coder.com/v1alpha1 resources:
- CoderWorkspace
- CoderTemplate
An MCP HTTP server for operational tooling.
A single binary that can run in all-in-one mode or split app modes.

Application modes

Mode	Description	Typical usage
`all` (default)	Runs controller + workspace/template API + MCP HTTP together	Single deployment for evaluation environments
`controller`	Runs only Kubernetes reconcilers	Controller-only deployments
`aggregated-apiserver`	Runs only the workspace/template API server	Split deployments with dedicated API serving
`mcp-http`	Runs only MCP HTTP server	MCP-focused integrations

Quick start (brief, in-cluster)

For a full setup guide, use the docs links above. For a quick smoke deploy:

kubectl create namespace coder-system
kubectl apply -f config/crd/bases/
kubectl apply -f config/rbac/
kubectl apply -f deploy/deployment.yaml
kubectl apply -f deploy/apiserver-service.yaml
kubectl apply -f deploy/apiserver-apiservice.yaml
kubectl apply -f deploy/mcp-service.yaml
kubectl rollout status deployment/coder-k8s -n coder-system

Examples

examples/cloudnativepg/ — Deploy a CoderControlPlane with a CloudNativePG-managed PostgreSQL backend.
examples/argocd/ — Bootstrap CloudNativePG + coder-k8s + PostgreSQL + CoderControlPlane from one Argo CD ApplicationSet.
examples/coder-templates/ — Reusable CoderTemplate manifests for workspace/template API testing.

Contributing

For local development workflows, validation commands, and PR guidance, see CONTRIBUTING.md.

License

Apache-2.0. See LICENSE.

Documentation ¶

Overview ¶

Package main provides the entrypoint for the coder-k8s binary.

Source Files ¶

View all Source files

Directories ¶

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

Path	Synopsis
api
aggregation/v1alpha1 Package v1alpha1 contains API schema definitions for the aggregation.coder.com API group.	Package v1alpha1 contains API schema definitions for the aggregation.coder.com API group.
v1alpha1 Package v1alpha1 contains API schema definitions for the coder.com API group.	Package v1alpha1 contains API schema definitions for the coder.com API group.
hack
gen-coder-docs-skill command Package main implements a CLI tool that generates the coder-docs Mux agent skill by syncing a text-only snapshot of the coder/coder documentation and injecting a navigation tree into SKILL.md.	Package main implements a CLI tool that generates the coder-docs Mux agent skill by syncing a text-only snapshot of the coder/coder documentation and injecting a navigation tree into SKILL.md.
internal
aggregated/coder Package coder provides shared Coder backend helpers for the aggregated API server.	Package coder provides shared Coder backend helpers for the aggregated API server.
aggregated/convert Package convert maps codersdk models to aggregated API resources and request payloads.	Package convert maps codersdk models to aggregated API resources and request payloads.
aggregated/storage Package storage implements codersdk-backed REST storage for the aggregated API server's CoderWorkspace and CoderTemplate resources.	Package storage implements codersdk-backed REST storage for the aggregated API server's CoderWorkspace and CoderTemplate resources.
app/allapp Package allapp composes controller, aggregated API server, and MCP app modes in one process.	Package allapp composes controller, aggregated API server, and MCP app modes in one process.
app/apiserverapp Package apiserverapp provides the aggregated API server application mode for coder-k8s.	Package apiserverapp provides the aggregated API server application mode for coder-k8s.
app/controllerapp Package controllerapp provides the controller-runtime application mode for coder-k8s.	Package controllerapp provides the controller-runtime application mode for coder-k8s.
app/mcpapp Package mcpapp provides MCP server application modes for coder-k8s.	Package mcpapp provides MCP server application modes for coder-k8s.
app/sharedscheme Package sharedscheme provides reusable runtime scheme construction across app modes.	Package sharedscheme provides reusable runtime scheme construction across app modes.
coderbootstrap Package coderbootstrap contains optional bootstrap integrations with the Coder API.	Package coderbootstrap contains optional bootstrap integrations with the Coder API.
controller Package controller contains Kubernetes controllers for coder-k8s resources.	Package controller contains Kubernetes controllers for coder-k8s resources.
deps Package deps keeps baseline Kubernetes dependencies in go.mod for bootstrap.	Package deps keeps baseline Kubernetes dependencies in go.mod for bootstrap.