8000 remove coder_agent_devcontainers_enable requirement · coder/coder@ec77a25 · GitHub
[go: up one dir, main page]

Skip to content

Commit ec77a25

Browse files
committed
remove coder_agent_devcontainers_enable requirement
1 parent be23e85 commit ec77a25

File tree

1 file changed

+12
-19
lines changed

1 file changed

+12
-19
lines changed

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

Lines changed: 12 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -49,21 +49,6 @@ When integrated with Coder templates, they provide:
4949
5050
</details>
5151
52-
## Enable Dev Containers Integration
53-
54-
To enable the dev containers integration in your workspace, add the `CODER_AGENT_DEVCONTAINERS_ENABLE` environment variable to your existing `coder_agent` block:
55-
56-
```terraform
57-
env = {
58-
CODER_AGENT_DEVCONTAINERS_ENABLE = "true"
59-
# existing variables ...
60-
}
61-
```
62-
63-
This environment variable is required for the Coder agent to detect and manage dev containers.
64-
Without it, the agent will not attempt to start or connect to dev containers even if the
65-
`coder_devcontainer` resource is defined.
66-
6752
## Install the Dev Containers CLI
6853
6954
Use the
@@ -193,7 +178,6 @@ data "coder_workspace_owner" "me" {}
193178
resource "coder_agent" "main" {
194179
os = "linux"
195180
arch = "amd64"
196-
env = { CODER_AGENT_DEVCONTAINERS_ENABLE = "true" }
197181
198182
startup_script_behavior = "blocking"
199183
startup_script = "sudo service docker start"
@@ -247,7 +231,6 @@ data "coder_workspace_owner" "me" {}
247231
resource "coder_agent" "main" {
248232
os = "linux"
249233
arch = "amd64"
250-
env = { CODER_AGENT_DEVCONTAINERS_ENABLE = "true" }
251234
252235
startup_script_behavior = "blocking"
253236
startup_script = "sudo service docker start"
@@ -298,11 +281,21 @@ resource "kubernetes_pod" "workspace" {
298281

299282
## Troubleshoot common issues
300283

284+
### Disable Dev Containers Integration
285+
286+
To disable the dev containers integration in your workspace, add the `CODER_AGENT_DEVCONTAINERS_ENABLE` environment variable to your existing `coder_agent` block:
287+
288+
```terraform
289+
env = {
290+
CODER_AGENT_DEVCONTAINERS_ENABLE = "false"
291+
# existing variables ...
292+
}
293+
```
294+
301295
### Dev container does not start
302296

303-
1. `CODER_AGENT_DEVCONTAINERS_ENABLE=true` missing.
304297
1. Docker daemon not running inside the workspace.
305-
1. `devcontainer.json` missing or mislocated.
298+
1. `devcontainer.json` missing or is in the wrong place.
306299
1. Build errors: check agent logs.
307300

308301
### Permission errors

0 commit comments

Comments
 (0)
0