Workspaces as code (WAC) allows you to define and create new environments using workspace templates.
Workspace templates are written as YAML and have a
Coder looks for your workspace template at the following path:
The following is a sample workspace template that makes use of all available fields. Depending on your use case, you may not need all of the options available.
For detailed information on the fields available, see the subsequent sections of this article
version: 0.1 workspace: type: kubernetes spec: image: index.docker.io/ubuntu:18.04 container-based-vm: true cpu: 4 memory: 16 disk: 128 gpuCount: 1 labels: com.coder.custom.hello: "hello" com.coder.custom.world: "world" tolerations: - key: my-key operator: Equal value: my-value effect: NoExecute tolerationSeconds: 3600 configure: start: - name: "install curl" run: | apt update apt install -y curl - name: "install Go binary" run: "go install" directory: /home/coder/go/src/github.com/my-project shell: "bash" env: GOPATH: /home/coder/go
The version number of the config file being used. The current version is
Required. The section containing all configuration information related to the environment.
Required. Determines the type of workspace to be created. Currently, the
only accepted value is
Required. This section contains configuration information specific to the
Required. The image to use for the environment. The image should include the
registry and (optionally) the tag, i.e.
docker.io/ubuntu:18.04. If you omit
the tag, Coder uses the default value of
You must have imported the image into Coder, otherwise the environment will fail to build.
The Kubernetes labels to be added to the environment pod.
workspace: labels: com.coder.custom.hello: hello com.coder.custom.world: world
This section defines the Kubernetes tolerations to be added to the pod hosting the environment.
workspace: tolerations: - key: my-key operator: equals value: my-value effect: NoExecute tolerationSeconds: 3600
The number of GPUs to allocate to the environment.
Determines whether the environment should be created as a
container-based virtual machine (CVM). Default is
Required. The number of cores to allocate to the environment.
Required. The amount of memory (in GB) to allocate to the environment.
Required. The amount of disk space (in GB) to allocate to the environment.
This section lists the commands that run within the environment after Coder builds the environment. See Configure for more information.
The list of commands to run when Coder starts an environment.
Required. Runs the provided command within the environment (Coder supports the use of both single-line and multi-line commands).
- name: Install curl run: apt install -y curl
- name: Update and install curl run: | apt update apt install -y curl
The name of the command being run.
The shell Coder should use to run the command.
start: - name: First step shell: /bin/bash
The working directory from which Coder should run the command.
start: - name: First step directory: /home/coder
The map of environment variables to set for the command.
start: - name: First step env: HOME: /home/coder GOPATH: /home/coder/go