updates after testing with new provider version

johnstcn · johnstcn · commit 3f37703c732e · 2024-08-13T15:21:33.000+01:00
diff --git a/examples/templates/devcontainer-docker/README.md b/examples/templates/devcontainer-docker/README.md
@@ -34,11 +34,12 @@ Coder supports Devcontainers via [envbuilder](https://github.com/coder/envbuilde
 
 This template provisions the following resources:
 
+- Envbuilder cached image (conditional, persistent)
 - Docker image (persistent)
 - Docker container (ephemeral)
 - Docker volume (persistent on `/workspaces`)
 
-with [`envbuilder`](https://github.com/coder/envbuilder).
+with [`envbuilder`](https://github.com/coder/envbuilder) and [`terraform-provider-envbuilder`](https://github.com/coder/terraform-provider-envbuilder).
 The Git repository is cloned inside the `/workspaces` volume if not present.
 Any local changes to the Devcontainer files inside the volume will be applied when you restart the workspace.
 Keep in mind that any tools or files outside of `/workspaces` or not added as part of the Devcontainer specification are not persisted.
@@ -51,10 +52,11 @@ Edit the `devcontainer.json` instead!
 
 See the [Envbuilder documentation](https://github.com/coder/envbuilder/blob/main/docs/docker.md) for information on running Docker containers inside a devcontainer built by Envbuilder.
 
+
 ## Caching
 
 To speed up your builds, you can use a container registry as a cache.
-When creating the template, set the parameter `cache_repo`.
+When creating the template, set the parameter `cache_repo` to a valid Docker repository.
 
 For example, you can run a local registry:
 
@@ -69,6 +71,8 @@ docker run --detach \
 
 Then, when creating the template, enter `localhost:5000/devcontainer-cache` for the parameter `cache_repo`.
 
+See the [Envbuilder Terraform Provider Examples](https://github.com/coder/terraform-provider-envbuilder/blob/main/examples/resources/envbuilder_cached_image/envbuilder_cached_image_resource.tf/) for a more complete example of how the provider works.
+
 > [!NOTE] We recommend using a registry cache with authentication enabled.
 > To allow Envbuilder to authenticate with the registry cache, specify the variable `cache_repo_docker_config_path`
 > with the path to a Docker config `.json` on disk containing valid credentials for the registry.
diff --git a/examples/templates/devcontainer-docker/main.tf b/examples/templates/devcontainer-docker/main.tf
@@ -93,14 +93,13 @@ EOF
 
 variable "cache_repo" {
   default     = ""
-  description = "Use a container registry as a cache to speed up builds."
-  sensitive   = true
+  description = "(Optional) Use a container registry as a cache to speed up builds."
   type        = string
 }
 
 variable "cache_repo_docker_config_path" {
   default     = ""
-  description = "Path to a docker config.json containing credentials to the provided cache repo, if required."
+  description = "(Optional) Path to a docker config.json containing credentials to the provided cache repo, if required."
   sensitive   = true
   type        = string
 }
@@ -152,15 +151,15 @@ resource "docker_volume" "workspaces" {
 # Check for the presence of a prebuilt image in the cache repo
 # that we can use instead.
 resource "envbuilder_cached_image" "cached" {
-  count         = data.coder_workspace.me.start_count
+  count         = var.cache_repo == "" ? 0 : data.coder_workspace.me.start_count
   builder_image = local.devcontainer_builder_image
   git_url       = local.repo_url
   cache_repo    = var.cache_repo
 }
 
 resource "docker_container" "workspace" {
   count = data.coder_workspace.me.start_count
-  image = envbuilder_cached_image.cached.0.image
+  image = var.cache_repo == "" ? local.devcontainer_builder_image : envbuilder_cached_image.cached.0.image
   # Uses lower() to avoid Docker restriction on container names.
   name = "coder-${data.coder_workspace_owner.me.name}-${lower(data.coder_workspace.me.name)}"
   # Hostname makes the shell more user friendly: coder@my-workspace:~$
@@ -174,10 +173,10 @@ resource "docker_container" "workspace" {
     "ENVBUILDER_FALLBACK_IMAGE=${data.coder_parameter.fallback_image.value}",
     "ENVBUILDER_CACHE_REPO=${var.cache_repo}",
     "ENVBUILDER_DOCKER_CONFIG_BASE64=${try(data.local_sensitive_file.cache_repo_dockerconfigjson[0].content_base64, "")}",
-    "ENVBUILDER_PUSH_IMAGE=${var.cache_repo != "" ? "true" : ""}",
-    #"ENVBUILDER_INSECURE=true", # Uncomment if testing with a local registry.
+    "ENVBUILDER_PUSH_IMAGE=${var.cache_repo == "" ? "" : "true"}",
+    #"ENVBUILDER_INSECURE=true", # Uncomment if testing with a registry running on `localhost`.
   ]
-  # network_mode = "host" # Uncomment if testing with a local registry.
+  # network_mode = "host" # Uncomment if testing with a registry running on `localhost`.
   host {
     host = "host.docker.internal"
     ip   = "host-gateway"
@@ -314,3 +313,20 @@ resource "coder_app" "code-server" {
     threshold = 6
   }
 }
+
+resource "coder_metadata" "container_info" {
+  count       = data.coder_workspace.me.start_count
+  resource_id = docker_container.workspace.0.id
+  item {
+    key   = "workspace image"
+    value = var.cache_repo == "" ? local.devcontainer_builder_image : envbuilder_cached_image.cached.0.image
+  }
+  item {
+    key   = "git url"
+    value = local.repo_url
+  }
+  item {
+    key   = "cache repo"
+    value = var.cache_repo == "" ? "not enabled" : var.cache_repo
+  }
+}
