Skip to content

Commit 646933b

Browse files
authored
Merge pull request kubernetes-sigs#9513 from musaprg/8097-add-note-about-format-of-env-in-clusterctl
📖 Add a line about the format of key for clusterctl config
2 parents ac96b94 + de68eae commit 646933b

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

docs/book/src/clusterctl/configuration.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,9 @@ variables in the `clusterctl` config file:
5959
AWS_B64ENCODED_CREDENTIALS: XXXXXXXX
6060
```
6161

62+
The format of keys should always be `UPPERCASE_WITH_UNDERSCORE` for both OS environment variables and in the `clusterctl`
63+
config file (NOTE: this limitation derives from [Viper](https://github.com/spf13/viper), the library we are using internally to retrieve variables).
64+
6265
In case a variable is defined both in the config file and as an OS environment variable,
6366
the environment variable takes precedence.
6467

0 commit comments

Comments
 (0)