docs(devcontainers): document Envbuilder lifecycle limitations and workarounds#26079
Draft
david-fraley wants to merge 1 commit into
Draft
docs(devcontainers): document Envbuilder lifecycle limitations and workarounds#26079david-fraley wants to merge 1 commit into
david-fraley wants to merge 1 commit into
Conversation
…rkarounds Document known Envbuilder limitations that cause confusion for users: - Custom Dockerfile ENTRYPOINT is replaced by Envbuilder - postAttachCommand and initializeCommand are not supported - SSH keys and Git credentials are unavailable during lifecycle scripts Add recommended workaround using coder_agent startup_script for operations that require Coder-managed credentials (e.g., git submodule initialization with SSH). Fixes #26071
Docs preview📖 View docs preview for |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #26071
Documents known Envbuilder limitations that cause confusion when users try to automate setup tasks in dev container lifecycle scripts:
ENTRYPOINTinstructions do not execute.postAttachCommand,initializeCommand, andwaitForare not supported by Envbuilder.git submodule update --init --recursiveto fail.Adds the recommended workaround: use the
coder_agentstartup script for operations that require Coder-managed credentials, with a Terraform example.Changes
docs/admin/integrations/devcontainers/envbuilder/add-envbuilder.md: Expanded the lifecycle scripts section with supported/unsupported commands, ENTRYPOINT behavior, and SSH credentials guidance with a template code example.docs/admin/integrations/devcontainers/envbuilder/envbuilder-releases-known-issues.md: Added key limitations summary before the link to the full Envbuilder spec support matrix.docs/user-guides/devcontainers/troubleshooting-dev-containers.md: Added troubleshooting entries for git submodule/SSH failures in lifecycle scripts and custom ENTRYPOINT not executing.