Skip to content
This repository was archived by the owner on Aug 18, 2025. It is now read-only.

Add kube annotations to wac template docs #414

Merged
merged 3 commits into from
Jun 17, 2021
Merged

Add kube annotations to wac template docs #414

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
518cc99
Add kube annotations to wac template docs
Emyrk Jun 16, 2021
a1e4af2
Fix typo
Jun 17, 2021
eed927d
Merge branch 'release-1.20' into stevenmasley/annotations_1.20
Jun 17, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 30 additions & 12 deletions workspaces/workspaces-as-code/templates.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ state: beta

<!-- markdownlint-disable MD044 -->

> As of Coder version *1.19*, only workspace templates version *0.2* is
supported. To update your workspace, you **must** update your templates to
version *0.2*.
> As of Coder version _1.19_, only workspace templates version _0.2_ is
> supported. To update your workspace, you **must** update your templates to
> version _0.2_.

Workspaces as code (WAC) allows you to define and create new workspaces using
**workspace templates**.
Expand Down Expand Up @@ -44,7 +44,7 @@ workspace:
type: kubernetes
specs:
kubernetes:
image:
image:
value: index.docker.io/ubuntu:18.04
container-based-vm:
value: true
Expand All @@ -60,6 +60,10 @@ workspace:
value:
com.coder.custom.hello: "hello"
com.coder.custom.world: "world"
annotations:
value:
- key: annotation-key
value: annotation-value
configure:
start:
value:
Expand All @@ -71,7 +75,8 @@ workspace:
command: "mkdir -p /home/coder/go/src/github.com/my-org"
# Be careful with keyscans like this!
- name: "Add GitHub to known hosts"
command: "sudo ssh-keyscan -H github.com >> /home/coder/.ssh/known_hosts"
command:
"sudo ssh-keyscan -H github.com >> /home/coder/.ssh/known_hosts"
- name: "Clone Git Project"
command: "git clone git@github.com:my-org/my-project.git"
continue-on-error: true
Expand All @@ -83,7 +88,7 @@ workspace:
continue-on-error: true
env:
GOPATH: /home/coder/go

dev-urls:
value:
- name: MyWebsite
Expand All @@ -108,8 +113,8 @@ workspace:

### version

The version number of the config file being used. The currently supported version
is `0.2`.
The version number of the config file being used. The currently supported
version is `0.2`.

### workspace

Expand Down Expand Up @@ -154,6 +159,19 @@ labels:

`labels` is disabled by default and must be enabled by a site admin.

#### workspace.specs.kubernetes.annotations.value

The
[Kubernetes annotations](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/)
to be added to the workspace pod.

```yaml
annotations:
value:
- key: annotation-key
value: annotation-value
```

#### workspace.specs.kubernetes.gpu-count.value

The number of GPUs to allocate to the workspace.
Expand Down Expand Up @@ -277,10 +295,10 @@ start:

#### workspace.configure.start.value[*].continue-on-error

Any step that returns a non-zero exit code will fail. By default, a
failure prevents the subsequent steps from executing. If you would like to
change this behavior, this field (which accepts a Boolean value) will allow a
step to fail and *not* half subsequent steps.
Any step that returns a non-zero exit code will fail. By default, a failure
prevents the subsequent steps from executing. If you would like to change this
behavior, this field (which accepts a Boolean value) will allow a step to fail
and _not_ halt subsequent steps.

#### workspace.configure.start.value[*].env

Expand Down