Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs regarding BAKE_VARIABLES config #242

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update docs regarding BAKE_VARIABLES config #242

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ BAKE_AUTH_SERVICE_ID=VALUE
BAKE_AUTH_SERVICE_KEY=VALUE
BAKE_AUTH_TENANT_ID=VALUE
BAKE_AUTH_SUBSCRIPTION_ID=VALUE
BAKE_VARIABLES='C:\path\to\your\envvars.yml'
GIT_USER=VALUE
GIT_PASSWORD=VALUE
REGISTRY_URL=VALUE
Expand Down
14 changes: 7 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ Note: There are several environment variables for azure authentication and envir
| BAKE_ENV_NAME | Full name of the environment this deployment is for |
| BAKE_ENV_CODE | 4 letter environment code, used for naming of resources/resource groups|
| BAKE_ENV_REGIONS | JSON array of region objects that the recipe should deploy to |
| BAKE_VARIABLES | JSON of bake variables that the recipe can access |
| BAKE_VARIABLES | Path to YAML file of bake variables that the recipe can access |
| BAKE_LOG_LEVEL | Log levels include debug, info (default if unspecified), warn, and error |

*note: read the section on Environment for a deeper explanation of environment/regions/variables*
Expand Down Expand Up @@ -123,16 +123,16 @@ To setup an environment you must define a few items:
# setting regions to both east and west US
set BAKE_ENV_REGIONS='[{"name":"East US","code":"eus","shortName":"eastus"},{"name":"West US","code":"wus","shortName":"westus"}]'
```
* BAKE_VARIABLES: JSON of name/value pair variables that the recipe can access. These are typically used as environment wide/specific settings to configure recipes per environment (i.e. enviroment specific secret keys, etc.)
* BAKE_VARIABLES: Path to YAML file of name/value pair variables that the recipe can access. These are typically used as environment wide/specific settings to configure recipes per environment (i.e. enviroment specific secret keys, etc.)

**JSON structure**
```json
'storage_key': 'secret'
'env_type': 'prod'
**YAML structure**
```yaml
storage_key: "secret"
env_type: "prod"
```

```bash
set BAKE_VARIABLEs='{ ''storage_key'': ''secret'', ''env_type'':''prod'' }'
set BAKE_VARIABLES='/path/to/your/envVars.yml'
```

### Azure resource groups
Expand Down