Skip to content

Commit

Permalink
Merge pull request #86 from Karandash8/improve-docs
Browse files Browse the repository at this point in the history
Improve docs
  • Loading branch information
Karandash8 authored Jul 16, 2024
2 parents d287ce1 + e7ed185 commit 4bf4ca2
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,18 +101,15 @@ resources:
- deployment_nginx.yml
- serviceaccount_nginx-prod.yml
```
### Initial app-of-apps application
`bootstrap` application shall be deployed externally

### Variable names
The folloving variable names are reserved (at the root level) and shall not be used in the configuration file:
- __application
- env_name
- app_name

### Referencing variables in config.yml
Variables can be referenced in the configuration file (including *app parameters*) using the following syntax:
```${var_name}``` and ```${var_name[subvar_name][...]}```.
Variables can be referenced in the configuration file (including in *app parameters*) using the following syntax:
```${var_name}``` and ```${var_name[dict_key][...]}```.

Variables can also be used as substring values:
```prefix-${var_name}-suffix```.
Expand All @@ -135,6 +132,7 @@ The folloving variables are expected to be provided:
- `kube-linter` is expected to be installed locally (https://github.com/stackrox/kube-linter).
- `libyaml` is expected to be installed locally for speeding up YAMLs generation.
- Comments are not rendered in the final output manifests.
- Initial App-of-Apps application (`bootstrap`) shall be deployed externally.

## For developers
### Build instructions
Expand Down

0 comments on commit 4bf4ca2

Please sign in to comment.