Fixes #1205 - updating bicep files for new container environment vari… #1207
Conversation
This file contains 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
…vironment variable schema Signed-off-by: Nick Beenham <[email protected]>
willtsai
requested changes
Aug 30, 2024
There was a problem hiding this comment.
Thanks for submitting this! The changes you've made to snippets in documentation looks comprehensive. However, the field descriptions on the container schema page also needs to be updated to reflect the new structure of environment variables.
|
NOTE: these docs changes are dependent on code changes to be merged first: radius-project/radius#7744 |
Signed-off-by: Nick Beenham <[email protected]>
Signed-off-by: Nick Beenham <[email protected]>
kachawla
reviewed
Sep 5, 2024
| @@ -35,7 +35,7 @@ weight: 300 | |||
| | Key | Required | Description | Example | | |||
| |------|:--------:|-------------|---------| | |||
| | image | y | The registry and image to download and run in your container. Follows the format `<registry-hostname>:<port>/<image-name>:<tag>` where registry hostname is optional and defaults to the Docker public registry, port is optional and defaults to 443, tag is optional and defaults to `latest`.| `ghcr.io/USERNAME/myimage:latest` | |||
| | env | n | A list of environment variables to be set for the container. | `'ENV_VAR': 'value'` | |||
| | env | n | A list of environment variables to be set for the container. Environment variables can either be of `value` or a reference so a kubernetes secret in the format `valueFrom`. | `'ENV_VAR': { value: 'value' }` or `'ENV_VAR': { valueFrom: { secretRef: { source: secret.id key: 'SECRET_KEY' } } }` | |||
There was a problem hiding this comment.
Should we make the reference description more higher level, since kubernetes secret is implementation detail and will change when support for types is added?
Suggested change
| | env | n | A list of environment variables to be set for the container. Environment variables can either be of `value` or a reference so a kubernetes secret in the format `valueFrom`. | `'ENV_VAR': { value: 'value' }` or `'ENV_VAR': { valueFrom: { secretRef: { source: secret.id key: 'SECRET_KEY' } } }` | |
| | env | n | A list of environment variables to be set for the container. Environment variables can either be of `value` or a reference to a Application.Core/SecretStore resource id in the format `valueFrom`. | `'ENV_VAR': { value: 'value' }` or `'ENV_VAR': { valueFrom: { secretRef: { source: secret.id key: 'SECRET_KEY' } } }` |
Signed-off-by: Nick Beenham <[email protected]>
willtsai
approved these changes
Sep 10, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
…able schema
Thank you for helping make the Radius documentation better!
Please follow this checklist before submitting:
In addition, please fill out the following to help reviewers understand this pull request:
Description
Updating bicep files with new container environment variables schema
Issue reference
Fixes: #1205