Add a line about the format of key for clusterctl config

Signed-off-by: Kotaro Inoue <[email protected]> Update docs/book/src/clusterctl/configuration.md Co-authored-by: killianmuldoon <[email protected]> Update docs/book/src/clusterctl/configuration.md Co-authored-by: Fabrizio Pandini <[email protected]>
kubernetes-sigs · Oct 3, 2023 · 5abdada · 5abdada
1 parent 6f27407
commit 5abdada
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/docs/book/src/clusterctl/configuration.md b/docs/book/src/clusterctl/configuration.md
@@ -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.