Skip to content

Commit 5a4ca2f

Browse files
committed
edit devcontainers doc
1 parent fb92c9f commit 5a4ca2f

File tree

1 file changed

+43
-13
lines changed

1 file changed

+43
-13
lines changed

docs/admin/templates/extending-templates/devcontainers.md

Lines changed: 43 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ to install `devcontainers/cli` in your workspace:
4343
```terraform
4444
module "devcontainers-cli" {
4545
count = data.coder_workspace.me.start_count
46-
source = "dev.registry.coder.com/modules/devcontainers-cli/coder"
46+
source = "registry.coder.com/modules/devcontainers-cli/coder"
4747
agent_id = coder_agent.main.id
4848
}
4949
```
@@ -195,16 +195,15 @@ terraform {
195195
}
196196
}
197197
198-
provider "coder" {}
199198
data "coder_workspace" "me" {}
200199
data "coder_workspace_owner" "me" {}
201200
202201
resource "coder_agent" "main" {
203-
arch = "amd64"
204-
os = "linux"
202+
os = "linux"
203+
arch = "amd64"
205204
startup_script_behavior = "blocking"
206-
startup_script = "sudo service docker start"
207-
shutdown_script = "sudo service docker stop"
205+
startup_script = "sudo service docker start"
206+
shutdown_script = "sudo service docker stop"
208207
}
209208
210209
module "devcontainers-cli" {
@@ -213,25 +212,56 @@ module "devcontainers-cli" {
213212
agent_id = coder_agent.main.id
214213
}
215214
215+
module "git-clone" {
216+
count = data.coder_workspace.me.start_count
217+
source = "registry.coder.com/modules/git-clone/coder"
218+
agent_id = coder_agent.main.id
219+
url = "https://github.com/coder/coder.git"
220+
base_dir = "/home/coder"
221+
}
222+
216223
resource "coder_devcontainer" "my-repository" {
217224
count = data.coder_workspace.me.start_count
218-
agent_id = coder_agent.dev.id
219-
workspace_folder = "/home/coder/my-repository"
225+
agent_id = coder_agent.main.id
226+
workspace_folder = module.git-clone[0].repo_dir
220227
}
221228
222229
resource "docker_container" "workspace" {
223230
count = data.coder_workspace.me.start_count
224-
image = "codercom/oss-dogfood:latest"
231+
image = "codercom/enterprise-node:ubuntu"
232+
name = "coder-${data.coder_workspace_owner.me.name}-${lower(data.coder_workspace.me.name)}"
233+
runtime = "sysbox-runc"
234+
entrypoint = ["sh", "-c", coder_agent.main.init_script]
225235
env = [
226-
"CODER_AGENT_DEVCONTAINERS_ENABLE=true",
227-
# ... Other environment variables.
228-
]
229-
# ... Other container configuration.
236+
"CODER_AGENT_TOKEN=${coder_agent.main.token}",
237+
"CODER_AGENT_URL=${data.coder_workspace.me.access_url}"
238+
]
230239
}
231240
```
232241

242+
## Troubleshoot Common Issues
243+
244+
### Disable dev containers integration
245+
246+
To disable the dev containers integration in your workspace, set the `CODER_AGENT_DEVCONTAINERS_ENABLE=false`
247+
environment variable before starting the agent.
248+
249+
### Dev container does not start
250+
251+
1. Confirm that the Docker daemon is running inside the workspace:
252+
253+
```shell
254+
sudo service docker start && \
255+
docker ps
256+
```
257+
258+
1. Confirm the location of `devcontainer.json`.
259+
260+
1. Check the agent logs for errors.
261+
233262
## Next Steps
234263

264+
- [Advanced dev containers](./advanced-dev-containers.md)
235265
- [Dev Containers Integration](../../../user-guides/devcontainers/index.md)
236266
- [Working with Dev Containers](../../../user-guides/devcontainers/working-with-dev-containers.md)
237267
- [Troubleshooting Dev Containers](../../../user-guides/devcontainers/troubleshooting-dev-containers.md)

0 commit comments

Comments
 (0)