Skip to content

Commit

Permalink
Merge pull request #9513 from musaprg/8097-add-note-about-format-of-e…
Browse files Browse the repository at this point in the history
…nv-in-clusterctl

📖 Add a line about the format of key for clusterctl config
  • Loading branch information
k8s-ci-robot authored Oct 3, 2023
2 parents ac96b94 + de68eae commit 646933b
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 646933b

Please sign in to comment.