Skip to content

Commit e89cb42

Browse files
committed
clarify purpose of configoptiondata
1 parent d4b7877 commit e89cb42

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

docs/reference/template-functions-config-context.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,9 @@ import ConfigContext from "../partials/template-functions/_config-context.mdx"
1010
func ConfigOption(optionName string) string
1111
```
1212

13-
Returns the value of the specified option from the KOTS Config custom resource as a string. For the `file` config option type, `ConfigOption` returns the base64 encoded value.
13+
Returns the value of the specified option from the KOTS Config custom resource as a string.
14+
15+
For the `file` config option type, `ConfigOption` returns the base64 encoded file. To return the decoded contents of a file, use [ConfigOptionData](#configoptiondata) instead.
1416

1517
```yaml
1618
'{{repl ConfigOption "hostname" }}'
@@ -46,7 +48,7 @@ For more information, see [Setting Helm Values with KOTS](/vendor/helm-optional-
4648
func ConfigOptionData(optionName string) string
4749
```
4850
49-
`ConfigOptionData` returns the base64 decoded value of a `file` config option.
51+
For the `file` config option type, `ConfigOptionData` returns the base64 decoded contents of the file. To return the base64 encoded file, use [ConfigOption](#configoption) instead.
5052
5153
```yaml
5254
'{{repl ConfigOptionData "ssl_key"}}'

0 commit comments

Comments
 (0)