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

[release-1.5] 📖 Add a line about the format of key for clusterctl config #9518

Merged
merged 1 commit into from
Oct 3, 2023
Merged

[release-1.5] 📖 Add a line about the format of key for clusterctl config #9518

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
3 changes: 3 additions & 0 deletions docs/book/src/clusterctl/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,9 @@ variables in the `clusterctl` config file:
AWS_B64ENCODED_CREDENTIALS: XXXXXXXX
```

The format of keys should always be `UPPERCASE_WITH_UNDERSCORE` for both OS environment variables and in the `clusterctl`
config file (NOTE: this limitation derives from [Viper](https://github.com/spf13/viper), the library we are using internally to retrieve variables).

In case a variable is defined both in the config file and as an OS environment variable,
the environment variable takes precedence.

Expand Down