coop-cloud/docs.coopcloud.tech
coop-cloud
/
docs.coopcloud.tech
4
1
Fork 14
Code Issues Pull Requests 2 Releases Activity

refactor: more warnings for default env vars
continuous-integration/drone/push Build is passing Details 

See coop-cloud/organising#359
This commit is contained in:
decentral1se 2023-10-06 11:12:24 +02:00
parent fa75f96f43
commit c82437da8f
Signed by: decentral1se
GPG Key ID: 03789458B3D0C410
1 changed files with 15 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
docs/maintainers/handbook.md
View File

@ -88,13 +88,26 @@ export NGINX_CONFIG_VERSION=v1
## Manage environment variables
When you define an environment variable in a `.env.sample` for a recipe, such as:
!!! warning
Please read this section carefully to avoid deployment footguns for the
operators who deploy your recipe configuration. It's important to
understand how to add new env vars into the recipe configuration in a
non-breaking manner. Thanks for reading!
When you define an environment variable in an `.env.sample` for a recipe, such as:
```bash
FOO=123
```
And you pass this via the `environment` stanza of a service config in the recipe like so:
This defines an env var which then needs to be added by an operator to their app env file. If you would like to add an env var which is optional, you can do:
```bash
#FOO=123
```
In order to expose this env var to recipe configuration, you pass this via the `environment` stanza of a service config in the recipe like so:
```yaml
service: