make cache_repo a template var instead of a parameter

johnstcn · johnstcn · commit e3616e9a0816 · 2024-07-05T17:54:45.000+01:00
diff --git a/examples/templates/devcontainer-docker/README.md b/examples/templates/devcontainer-docker/README.md
@@ -9,7 +9,7 @@ tags: [container, docker, devcontainer]
 
 # Remote Development on Docker Containers (with Devcontainers)
 
-Provision Devcontainers as [Coder workspaces](https://coder.com/docs/v2/latest/workspaces) with this example template.
+Provision Devcontainers as [Coder workspaces](https://coder.com/docs/v2/latest/workspaces) in Docker with this example template.
 
 ## Prerequisites
 
@@ -54,7 +54,10 @@ See the [Envbuilder documentation](https://github.com/coder/envbuilder/blob/main
 
 ## Caching
 
-To speed up your builds, you can run a local registry and use it as a cache. For example:
+To speed up your builds, you can use a container registry as a cache.
+When creating the template, set the parameter `cache_repo`.
+
+For example, you can run a local registry:
 
 ```shell
 docker run --detach \
@@ -65,7 +68,7 @@ docker run --detach \
   registry:2
 ```
 
-Then, when creating a workspace, enter `localhost:5000/devcontainer-cache` for the parameter `cache_repo`.
+Then, when creating the template, enter `localhost:5000/devcontainer-cache` for the parameter `cache_repo`.
 
 > [!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`
diff --git a/examples/templates/devcontainer-docker/main.tf b/examples/templates/devcontainer-docker/main.tf
@@ -87,13 +87,11 @@ EOF
   order        = 4
 }
 
-data "coder_parameter" "cache_repo" {
-  default      = ""
-  description  = "Enter a cache repo here to speed up builds."
-  display_name = "Cache Repo"
-  mutable      = true
-  name         = "cache_repo"
-  order        = 6
+variable "cache_repo" {
+  default     = ""
+  description = "Use a container registry as a cache to speed up builds."
+  sensitive   = true
+  type        = string
 }
 
 variable "cache_repo_docker_config_path" {
@@ -161,7 +159,7 @@ resource "docker_container" "workspace" {
     "ENVBUILDER_GIT_URL=${local.repo_url}",
     "ENVBUILDER_INIT_SCRIPT=${replace(coder_agent.main.init_script, "/localhost|127\\.0\\.0\\.1/", "host.docker.internal")}",
     "ENVBUILDER_FALLBACK_IMAGE=${data.coder_parameter.fallback_image.value}",
-    "ENVBUILDER_CACHE_REPO=${data.coder_parameter.cache_repo.value}",
+    "ENVBUILDER_CACHE_REPO=${var.cache_repo}",
     "ENVBUILDER_DOCKER_CONFIG_BASE64=${try(data.local_sensitive_file.cache_repo_dockerconfigjson[0].content_base64, "")}",
   ]
   host {
diff --git a/examples/templates/devcontainer-kubernetes/main.tf b/examples/templates/devcontainer-kubernetes/main.tf
@@ -40,6 +40,13 @@ variable "namespace" {
   description = "The Kubernetes namespace to create workspaces in (must exist prior to creating workspaces). If the Coder host is itself running as a Pod on the same Kubernetes cluster as you are deploying workspaces to, set this to the same namespace."
 }
 
+variable "cache_repo" {
+  default     = ""
+  description = "Use a container registry as a cache to speed up builds."
+  sensitive   = true
+  type        = string
+}
+
 data "coder_parameter" "cpu" {
   type         = "number"
   name         = "cpu"
@@ -116,15 +123,6 @@ EOF
   order        = 7
 }
 
-data "coder_parameter" "cache_repo" {
-  default      = ""
-  description  = "Enter a cache repo here to speed up builds."
-  display_name = "Cache Repo"
-  mutable      = true
-  name         = "cache_repo"
-  order        = 8
-}
-
 variable "cache_repo_secret_name" {
   default     = ""
   description = "Path to a docker config.json containing credentials to the provided cache repo, if required."
@@ -249,7 +247,7 @@ resource "kubernetes_deployment" "main" {
           }
           env {
             name  = "ENVBUILDER_CACHE_REPO"
-            value = data.coder_parameter.cache_repo.value
+            value = var.cache_repo
           }
           env {
             name  = "ENVBUILDER_DOCKER_CONFIG_BASE64"
