8000 edits; prep advanced doc · coder/coder@18998b7 · GitHub
[go: up one dir, main page]
Skip to content

Commit 18998b7

Browse files
EdwardAngertEdwardAngert
committed
edits; prep advanced doc
1 parent df07196 commit 18998b7

File tree

2 files changed

+33
-33
lines changed

2 files changed

+33
-33
lines changed

‎docs/admin/templates/extending-templates/advanced-dev-containers.md

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -11,24 +11,24 @@ Run multiple dev containers in a single workspace for microservices or multi-com
1111
1212
resource "coder_devcontainer" "frontend" {
1313
count = data.coder_workspace.me.start_count
14-
agent_id = coder_agent.dev.id
15-
workspace_folder = "/home/coder/frontend"
14+
agent_id = coder_agent.main.id
15+
workspace_folder = "/home/coder/frontend/${module.git_clone_frontend[0].folder_name}"
1616
}
1717
1818
# Backend dev container
1919
2020
resource "coder_devcontainer" "backend" {
2121
count = data.coder_workspace.me.start_count
22-
agent_id = coder_agent.dev.id
23-
workspace_folder = "/home/coder/backend"
22+
agent_id = coder_agent.main.id
23+
workspace_folder = "/home/coder/backend/${module.git_clone_frontend[0].folder_name}"
2424
}
2525
2626
# Database dev container
2727
2828
resource "coder_devcontainer" "database" {
2929
count = data.coder_workspace.me.start_count
30-
agent_id = coder_agent.dev.id
31-
workspace_folder = "/home/coder/database"
30+
agent_id = coder_agent.main.id
31+
workspace_folder = "/home/coder/database/${module.git_clone_frontend[0].folder_name}"
3232
}
3333
3434
# Clone multiple repositories
@@ -38,19 +38,19 @@ module "git-clone-frontend" {
3838
source = "registry.coder.com/modules/git-clone/coder"
3939
version = "~> 1.0"
4040
41-
agent_id = coder_agent.dev.id
41+
agent_id = coder_agent.main.id
4242
url = "https://github.com/your-org/frontend.git"
43-
path = "/home/coder/frontend"
43+
base_dir = "/home/coder/frontend/${module.git_clone_frontend[0].folder_name}"
4444
}
4545
4646
module "git-clone-backend" {
4747
count = data.coder_workspace.me.start_count
4848
source = "registry.coder.com/modules/git-clone/coder"
4949
version = "~> 1.0"
5050
51-
agent_id = coder_agent.dev.id
51+
agent_id = coder_agent.main.id
5252
url = "https://github.com/your-org/backend.git"
53-
path = "/home/coder/backend"
53+
base_dir = "/home/coder/backend/${module.git_clone_frontend[0].folder_name}"
5454
}
5555
```
5656

@@ -97,14 +97,14 @@ data "coder_parameter" "enable_backend" {
9797
9898
resource "coder_devcontainer" "frontend" {
9999
count = data.coder_parameter.enable_frontend.value ? data.coder_workspace.me.start_count : 0
100-
agent_id = coder_agent.dev.id
101-
workspace_folder = "/home/coder/frontend"
100+
agent_id = coder_agent.main.id
101+
workspace_folder = "/home/coder/frontend/${module.git_clone_frontend[0].folder_name}"
102102
}
103103
104104
resource "coder_devcontainer" "backend" {
105105
count = data.coder_parameter.enable_backend.value ? data.coder_workspace.me.start_count : 0
106-
agent_id = coder_agent.dev.id
107-
workspace_folder = "/home/coder/backend"
106+
agent_id = coder_agent.main.id
107+
workspace_folder = "/home/coder/backend/${module.git_clone_frontend[0].folder_name}"
108108
}
109109
```
110110

@@ -147,9 +147,9 @@ module "git-clone" {
147147
source = "registry.coder.com/modules/git-clone/coder"
148148
version = "~> 1.0"
149149
150-
agent_id = coder_agent.dev.id
150+
agent_id = coder_agent.main.id
151151
url = data.coder_parameter.project.value
152-
path = "/home/coder/project"
152+
base_dir = "/home/coder/project"
153153
}
154154
```
155155

@@ -204,9 +204,9 @@ module "git-clone-team-repos" {
204204
source = "registry.coder.com/modules/git-clone/coder"
205205
version = "~> 1.0"
206206
207-
agent_id = coder_agent.dev.id
207+
agent_id = coder_agent.main.id
208208
url = local.team_repos[data.coder_parameter.team.value][count.index % length(local.team_repos[data.coder_parameter.team.value])]
209-
path = "/home/coder/repos/$sename(local.team_repos[data.coder_parameter.team.value][count.index % length(local.team_repos[data.coder_parameter.team.value])])}"
209+
base_dir = "/home/coder/repos/$sename(local.team_repos[data.coder_parameter.team.value][count.index % length(local.team_repos[data.coder_parameter.team.value])])}"
210210
}
211211
```
212212

@@ -230,7 +230,7 @@ resource "docker_container" "workspace" {
230230
memory_swap = 8192 # 8GB including swap
231231
}
232232
233-
resource "coder_agent" "dev" {
233+
resource "coder_agent" "main" {
234234
235235
# ... other configuration
236236
@@ -258,7 +258,7 @@ resource "coder_agent" "dev" {
258258

259259
```terraform
260260
resource "docker_network" "dev_network" {
261-
name = "coder-$ta.coder_workspace.me.id}-dev"
261+
name = "coder-${data.coder_workspace.me.id}-dev
262262
}
263263
264264
resource "docker_container" "workspace" {
@@ -276,14 +276,14 @@ resource "docker_container" "workspace" {
276276

277277
```terraform
278278
resource "docker_volume" "node_modules" {
279-
name = "coder-$ta.coder_workspace.me.id}-node-modules"
279+
name = "coder-${data.coder_workspace.me.id}-node-modules"
280280
lifecycle {
281281
ignore_changes = all
282282
}
283283
}
284284
285285
resource "docker_volume" "go_cache" {
286-
name = "coder-$ta.coder_workspace.me.id}-go-cache"
286+
name = "coder-${data.coder_workspace.me.id}-go-cache"
287287
lifecycle {
288288
ignore_changes = all
289289
}
@@ -370,7 +370,7 @@ data "coder_parameter" "enable_devcontainer" {
370370
# Create persistent volume for home directory
371371
372372
resource "docker_volume" "home_volume" {
373-
name = "coder-$ta.coder_workspace.me.id}-home"
373+
name = "coder-${data.coder_workspace.me.id}-home"
374374
lifecycle {
375375
ignore_changes = all
376376
}
@@ -381,7 +381,7 @@ resource "docker_volume" "home_volume" {
381381
resource "docker_container" "workspace" {
382382
count = data.coder_workspace.me.start_count
383383
image = "codercom/enterprise-base:ubuntu"
384-
name = "coder-$ta.coder_workspace_owner.me.name}-${lower(data.coder_workspace.me.name)}"
384+
name = "coder-${data.coder_workspace.me.name}-${lower(data.coder_workspace.me.name)}"
385385
386386
# Hostname makes the shell more user friendly
387387
@@ -420,7 +420,7 @@ resource "docker_container" "workspace" {
420420
421421
# Coder agent
422422
423-
resource "coder_agent" "dev" {
423+
resource "coder_agent" "main" {
424424
arch = data.coder_provisioner.me.arch
425425
os = "linux"
426426
dir = "/home/coder"
@@ -457,7 +457,7 @@ resource "coder_agent" "dev" {
457457
module "devcontainers-cli" {
458458
count = data.coder_workspace.me.start_count
459459
source = "dev.registry.coder.com/modules/devcontainers-cli/coder"
460-
agent_id = coder_agent.dev.id
460+
agent_id = coder_agent.main.id
461461
}
462462
463463
# Clone repository
@@ -467,16 +467,16 @@ module "git-clone" {
467467
source = "registry.coder.com/modules/git-clone/coder"
468468
version = "~> 1.0"
469469
470-
agent_id = coder_agent.dev.id
470+
agent_id = coder_agent.main.id
471471
url = data.coder_parameter.repo_url.value
472-
path = "/home/coder/project"
472+
base_dir = "/home/coder/project"
473473
}
474474
475475
# Auto-start dev container
476476
477477
resource "coder_devcontainer" "project" {
478478
count = data.coder_parameter.enable_devcontainer.value ? data.coder_workspace.me.start_count : 0
479-
agent_id = coder_agent.dev.id
479+
agent_id = coder_agent.main.id
480480
workspace_folder = "/home/coder/project"
481481
}
482482
@@ -486,7 +486,7 @@ module "code-server" {
486486
count = data.coder_workspace.me.start_count
487487
source = "registry.coder.com/modules/code-server/coder"
488488
version = "~> 1.0"
489-
agent_id = coder_agent.dev.id
489+
agent_id = coder_agent.main.id
490490
order = 1
491491
}
492492
```
@@ -502,7 +502,7 @@ documentation for issues that affect dev containers within user workspaces.
502502
### Debug startup issues
503503

504504
```terraform
505-
resource "coder_agent" "dev" {
505+
resource "coder_agent" "main" {
506506
507507
# ... other configuration
508508
@@ -538,7 +538,7 @@ resource "coder_agent" "dev" {
538538
### Add health checks and monitoring
539539

540540
```terraform
541-
resource "coder_agent" "dev" {
541+
resource "coder_agent" "main" {
542542
543543
# ... other configuration
544544

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ When integrated with Coder templates, they provide:
4141
}
4242
```
4343
44-
1. Add `depends_on` to the `devcontainers-cli` module block:
44+
1. In the `devcontainers-cli` module block, add:
4545
4646
```terraform
4747
depends_on = [module.nodejs]

0 commit comments

Comments
 (0)
0