Skip to content

Commit

Permalink
Add a line about the format of key for clusterctl config
Browse files Browse the repository at this point in the history
Signed-off-by: Kotaro Inoue <inoue.kotaro@linecorp.com>

Update docs/book/src/clusterctl/configuration.md

Co-authored-by: killianmuldoon <47175296+killianmuldoon@users.noreply.github.com>

Update docs/book/src/clusterctl/configuration.md

Co-authored-by: Fabrizio Pandini <fabrizio.pandini@gmail.com>
  • Loading branch information
musaprg and fabriziopandini committed Oct 2, 2023
1 parent b685b09 commit de68eae
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions docs/book/src/clusterctl/configuration.md
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

0 comments on commit de68eae

Please sign in to comment.