From 4fd26a2913027a557480bf3a8fd810978862b982 Mon Sep 17 00:00:00 2001 From: Eric Date: Tue, 2 Jul 2024 20:30:55 +0000 Subject: [PATCH] docs: clarify envbox version pinning --- examples/templates/envbox/README.md | 6 +++++- examples/templates/envbox/main.tf | 3 ++- 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/examples/templates/envbox/README.md b/examples/templates/envbox/README.md index ad97f7777edad..790c700ac9cbb 100644 --- a/examples/templates/envbox/README.md +++ b/examples/templates/envbox/README.md @@ -36,7 +36,7 @@ The following environment variables can be used to configure various aspects of | `CODER_CPUS` | Dictates the number of CPUs to allocate the inner container. It is recommended to set this using the Kubernetes [Downward API](https://kubernetes.io/docs/tasks/inject-data-application/environment-variable-expose-pod-information/#use-container-fields-as-values-for-environment-variables). | false | | `CODER_MEMORY` | Dictates the max memory (in bytes) to allocate the inner container. It is recommended to set this using the Kubernetes [Downward API](https://kubernetes.io/docs/tasks/inject-data-application/environment-variable-expose-pod-information/#use-container-fields-as-values-for-environment-variables). | false | -# Migrating Existing Envbox Templates +## Migrating Existing Envbox Templates Due to the [deprecation and removal of legacy parameters](https://coder.com/docs/v2/latest/templates/parameters#legacy) it may be necessary to migrate existing envbox templates on newer versions of @@ -50,6 +50,10 @@ To supply values to existing existing Terraform variables you can specify the coder templates push envbox --var namespace="mynamespace" --var max_cpus=2 --var min_cpus=1 --var max_memory=4 --var min_memory=1 ``` +## Version Pinning + +The template sets the image tag as `latest`. We highly recommend pinning the image to a specific release of envbox, as the `latest` tag may change. + ## Contributions Contributions are welcome and can be made against the [envbox repo](https://github.com/coder/envbox). diff --git a/examples/templates/envbox/main.tf b/examples/templates/envbox/main.tf index 3b52a65b4370d..14b39dffd1089 100644 --- a/examples/templates/envbox/main.tf +++ b/examples/templates/envbox/main.tf @@ -153,7 +153,8 @@ resource "kubernetes_pod" "main" { restart_policy = "Never" container { - name = "dev" + name = "dev" + # We highly recommend pinning this to a specific release of envbox, as the latest tag may change. image = "ghcr.io/coder/envbox:latest" image_pull_policy = "Always" command = ["/envbox", "docker"]