From ff8b6379b20cc8ae9106afcb8733c33ba7211a9d Mon Sep 17 00:00:00 2001 From: Cian Johnston Date: Tue, 10 Sep 2024 10:16:23 +0100 Subject: [PATCH 1/2] chore(README.md): add notes regarding Coder integration --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index e5cc3cfe..b94baf83 100644 --- a/README.md +++ b/README.md @@ -53,6 +53,27 @@ Exit the container, and re-run the `docker run` command... after the build compl > If you need to bypass this behavior for any reason, you can bypass this safety check by setting > `ENVBUILDER_FORCE_SAFE=true`. +## Usage with Coder + +Coder provides sample +[Docker](https://github.com/coder/coder/tree/main/examples/templates/devcontainer-docker) +and +[Kubernetes](https://github.com/coder/coder/tree/main/examples/templates/devcontainer-kubernetes) +for use with Envbuilder. You can import these template and modify them to fit +your specific requirements. + +Below are some specific points to be aware of when using Envbuilder with a Coder +deployment: + +- The `ENVBUILDER_INIT_SCRIPT` should execute `coder_agent.main.init_script` in + order for you to be able to connect to your workspace. +- In order for the Agent init script to be able to fetch the agent binary from + your Coder deployment, the resulting Devcontainer must contain a download tool + such as `curl`, `wget`, or `busybox`. +- `CODER_AGENT_TOKEN` should be included in the environment variables for the + Envbuilder container. You can also set `CODER_AGENT_URL` if required. + + ### Git Branch Selection Choose a branch using `ENVBUILDER_GIT_URL` with a _ref/heads_ reference. For instance: From 1713fc13d73554154496c1da0a7ba3b2c83a6632 Mon Sep 17 00:00:00 2001 From: Cian Johnston Date: Tue, 10 Sep 2024 11:55:24 +0100 Subject: [PATCH 2/2] Apply suggestions from code review Co-authored-by: Mathias Fredriksson --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b94baf83..7ae8ab99 100644 --- a/README.md +++ b/README.md @@ -59,7 +59,7 @@ Coder provides sample [Docker](https://github.com/coder/coder/tree/main/examples/templates/devcontainer-docker) and [Kubernetes](https://github.com/coder/coder/tree/main/examples/templates/devcontainer-kubernetes) -for use with Envbuilder. You can import these template and modify them to fit +templates for use with Envbuilder. You can import these templates and modify them to fit your specific requirements. Below are some specific points to be aware of when using Envbuilder with a Coder