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

Jump to bottom

Improve docs #86

Merged
merged 1 commit into from
Jul 16, 2024
Merged

Improve docs #86

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
8 changes: 3 additions & 5 deletions README.md
View file
Open in desktop
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