From de68eae9c35cabe06d7c87cd181cf53ebd6fa4a3 Mon Sep 17 00:00:00 2001 From: Kotaro Inoue Date: Mon, 2 Oct 2023 02:00:35 +0900 Subject: [PATCH] Add a line about the format of key for clusterctl config Signed-off-by: Kotaro Inoue 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 --- docs/book/src/clusterctl/configuration.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/book/src/clusterctl/configuration.md b/docs/book/src/clusterctl/configuration.md index 3ac2017d9601..759c6b3f3034 100644 --- 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.