Commit a5f77e8
authored
Adding custom environment variables details (#2869)
## Type of change
**Documentation enhancement**
This PR adds documentation for custom environment variables in Custom
Assembly, expanding the existing custom annotations section to cover
both features comprehensively.
### What should this PR do?
resolves chainguard-dev/internal#5257
### Why are we making this change?
Custom Assembly supports adding custom environment variables to
Chainguard Containers, but this capability was not documented. Users
need to understand how to set runtime defaults and configuration values
for their customized container images.
### What are the acceptance criteria?
- [ ] Documentation clearly explains how to add custom environment
variables using chainctl
- [ ] Includes a practical example with common use cases (NODE_ENV,
API_URL, PORT, LOG_LEVEL, CACHE_TTL)
- [ ] Documents the restriction on CHAINGUARD_ prefixed environment
variables
- [ ] Section is logically organized alongside custom annotations
documentation
- [ ] Code examples use proper YAML formatting
### How should this PR be tested?
1. Review the documentation for clarity and completeness
2. Verify that the YAML examples are properly formatted
3. Confirm that the environment variable restrictions are clearly stated
4. Check that the new section flows naturally with the existing custom
annotations section
5. Optionally: Test the documented commands against a Custom Assembly
container to verify accuracy
---------
Signed-off-by: Mark Drake <mark@chainguard.dev>1 parent f911343 commit a5f77e8
File tree
1 file changed
+37
-2
lines changed- content/chainguard/chainguard-images/features/ca-docs
1 file changed
+37
-2
lines changedLines changed: 37 additions & 2 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
134 | 134 | | |
135 | 135 | | |
136 | 136 | | |
137 | | - | |
| 137 | + | |
| 138 | + | |
| 139 | + | |
| 140 | + | |
| 141 | + | |
138 | 142 | | |
139 | 143 | | |
140 | 144 | | |
| |||
146 | 150 | | |
147 | 151 | | |
148 | 152 | | |
149 | | - | |
| 153 | + | |
150 | 154 | | |
151 | 155 | | |
152 | 156 | | |
| |||
164 | 168 | | |
165 | 169 | | |
166 | 170 | | |
| 171 | + | |
| 172 | + | |
| 173 | + | |
| 174 | + | |
| 175 | + | |
| 176 | + | |
| 177 | + | |
| 178 | + | |
| 179 | + | |
| 180 | + | |
| 181 | + | |
| 182 | + | |
| 183 | + | |
| 184 | + | |
| 185 | + | |
| 186 | + | |
| 187 | + | |
| 188 | + | |
| 189 | + | |
| 190 | + | |
| 191 | + | |
| 192 | + | |
| 193 | + | |
| 194 | + | |
| 195 | + | |
| 196 | + | |
| 197 | + | |
| 198 | + | |
| 199 | + | |
| 200 | + | |
| 201 | + | |
167 | 202 | | |
168 | 203 | | |
169 | 204 | | |
| |||
0 commit comments