chore: add envbox documentation #7198
Merged
Conversation
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
bpmct
reviewed
Apr 19, 2023
bpmct
approved these changes
Apr 19, 2023
bpmct
reviewed
Apr 19, 2023
bpmct
reviewed
Apr 20, 2023
Comment on lines
159
to
171
| ```yaml | ||
| # An example of referencing a secret in an environment variable. | ||
| kind: Pod | ||
| spec: | ||
| containers: | ||
| - name: envbox | ||
| env: | ||
| - name: CODER_IMAGE_PULL_SECRET | ||
| valueFrom: | ||
| secretKeyRef: | ||
| name: <name> | ||
| key: .dockerconfigjson | ||
| ``` |
There was a problem hiding this comment.
It might make sense to show this in Terraform instead of YAML since 99% of people on this doc will be looking to add this to their envbox template in Coder. Or show both 🤷🏼
env {
name = "CODER_IMAGE_PULL_SECRET"
value_from {
secret_key_ref {
name = "<name>"
key = ".dockerconfigjson"
}
}
}
bpmct
reviewed
Apr 20, 2023
examples/templates/envbox/main.tf
Outdated
Comment on lines
146
to
148
| node_selector = { | ||
| sreya-test = true | ||
| } |
bpmct
reviewed
Apr 24, 2023
| | `CODER_AGENT_TOKEN` | The [Coder Agent](https://coder.com/docs/v2/latest/about/architecture#agents) token to pass to the inner container. | True | | ||
| | `CODER_INNER_ENVS` | The environment variables to pass to the inner container. A wildcard can be used to match a prefix. Ex: `CODER_INNER_ENVS=KUBERNETES_*,MY_ENV,MY_OTHER_ENV` | false | | ||
| | `CODER_INNER_HOSTNAME` | The hostname to use for the inner container. | false | | ||
| | `CODER_IMAGE_PULL_SECRET` | The docker credentials to use when pulling the inner container. The recommended way to do this is to create an [Image Pull Secret](https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/#registry-secret-existing-credentials) and then reference the secret using an [environment variable](https://kubernetes.io/docs/tasks/inject-data-application/distribute-credentials-secure/#define-container-environment-variables-using-secret-data). | false | |
There was a problem hiding this comment.
Sorry. I totally missed this part 🤦🏼
If you want to remove this from the docker in docker docs in favor of this, that's fine.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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 #6789
Unsure whether we should be adding the template to the repo at this point or not. We can keep it in envbox if we want. I figured we could keep it in
examples/but not add it totemplates inituntil we feel comfortable offering it as a starter template.