mirror of
https://github.com/coder/coder.git
synced 2026-06-04 21:48:22 +00:00
Muhammad Atif Ali
419eba5fb6
Closes #13434 Supersedes #14182 --------- Co-authored-by: Ethan <39577870+ethanndickson@users.noreply.github.com> Co-authored-by: Ethan Dickson <ethan@coder.com> Co-authored-by: Ben Potter <ben@coder.com> Co-authored-by: Stephen Kirby <58410745+stirby@users.noreply.github.com> Co-authored-by: Stephen Kirby <me@skirby.dev> Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com> Co-authored-by: Edward Angert <EdwardAngert@users.noreply.github.com>
104 lines
2.4 KiB
Markdown
104 lines
2.4 KiB
Markdown
---
|
|
display_name: Nomad
|
|
description: Provision Nomad Jobs as Coder workspaces
|
|
icon: ../../../site/static/icon/nomad.svg
|
|
maintainer_github: coder
|
|
verified: true
|
|
tags: [nomad, container]
|
|
---
|
|
|
|
# Remote Development on Nomad
|
|
|
|
Provision Nomad Jobs as [Coder workspaces](https://coder.com/docs/workspaces) with this example template. This example shows how to use Nomad service tasks to be used as a development environment using docker and host csi volumes.
|
|
|
|
<!-- TODO: Add screenshot -->
|
|
|
|
> **Note**
|
|
> This template is designed to be a starting point! Edit the Terraform to extend the template to support your use case.
|
|
|
|
## Prerequisites
|
|
|
|
- [Nomad](https://www.nomadproject.io/downloads)
|
|
- [Docker](https://docs.docker.com/get-docker/)
|
|
|
|
## Setup
|
|
|
|
### 1. Start the CSI Host Volume Plugin
|
|
|
|
The CSI Host Volume plugin is used to mount host volumes into Nomad tasks. This is useful for development environments where you want to mount persistent volumes into your container workspace.
|
|
|
|
1. Login to the Nomad server using SSH.
|
|
|
|
2. Append the following stanza to your Nomad server configuration file and restart the nomad service.
|
|
|
|
```tf
|
|
plugin "docker" {
|
|
config {
|
|
allow_privileged = true
|
|
}
|
|
}
|
|
```
|
|
|
|
```shell
|
|
sudo systemctl restart nomad
|
|
```
|
|
|
|
3. Create a file `hostpath.nomad` with following content:
|
|
|
|
```tf
|
|
job "hostpath-csi-plugin" {
|
|
datacenters = ["dc1"]
|
|
type = "system"
|
|
|
|
group "csi" {
|
|
task "plugin" {
|
|
driver = "docker"
|
|
|
|
config {
|
|
image = "registry.k8s.io/sig-storage/hostpathplugin:v1.10.0"
|
|
|
|
args = [
|
|
"--drivername=csi-hostpath",
|
|
"--v=5",
|
|
"--endpoint=${CSI_ENDPOINT}",
|
|
"--nodeid=node-${NOMAD_ALLOC_INDEX}",
|
|
]
|
|
|
|
privileged = true
|
|
}
|
|
|
|
csi_plugin {
|
|
id = "hostpath"
|
|
type = "monolith"
|
|
mount_dir = "/csi"
|
|
}
|
|
|
|
resources {
|
|
cpu = 256
|
|
memory = 128
|
|
}
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
4. Run the job:
|
|
|
|
```shell
|
|
nomad job run hostpath.nomad
|
|
```
|
|
|
|
### 2. Setup the Nomad Template
|
|
|
|
1. Create the template by running the following command:
|
|
|
|
```shell
|
|
coder template init nomad-docker
|
|
cd nomad-docker
|
|
coder template push
|
|
```
|
|
|
|
2. Set up Nomad server address and optional authentication:
|
|
|
|
3. Create a new workspace and start developing.
|