diff --git a/docs/partials/configValues/_configValuesExample.mdx b/docs/partials/configValues/_configValuesExample.mdx index 96a03ccb76..0297e7264a 100644 --- a/docs/partials/configValues/_configValuesExample.mdx +++ b/docs/partials/configValues/_configValuesExample.mdx @@ -9,7 +9,7 @@ spec: boolean_config_item_name: value: "1" password_config_item_name: - valuePlainText: exampleplaintextpassword + valuePlaintext: exampleplaintextpassword select_one_config_item_name: default: default_option_name value: selected_option_name diff --git a/docs/partials/configValues/_requirements.mdx b/docs/partials/configValues/_requirements.mdx index 0f1d9fc8ce..2bac496dcb 100644 --- a/docs/partials/configValues/_requirements.mdx +++ b/docs/partials/configValues/_requirements.mdx @@ -1,5 +1,5 @@ The ConfigValues resource must meet the following requirements: * Must be valid YAML. * It is not necessary to set a `value` for each configuration item in the ConfigValues, unless the item is [`required`](/reference/custom-resource-config#required) and has no [`default`](/reference/custom-resource-config#default) set in the Config resource. -* For any configuration items of type [`password`](/reference/custom-resource-config#password) defined in the Config resource, set the value in plain text in the ConfigValues [`valuePlainText`](/reference/custom-resource-configvalues#valueplaintext) property rather than in the `value` property. For example, `valuePlainText: somesecretvalue`. Values set in `valuePlainText` are automatically encrypted during installation. +* For any configuration items of type [`password`](/reference/custom-resource-config#password) defined in the Config resource, set the value in plain text in the ConfigValues [`valuePlaintext`](/reference/custom-resource-configvalues#valueplaintext) property rather than in the `value` property. For example, `valuePlaintext: somesecretvalue`. Values set in `valuePlaintext` are automatically encrypted during installation. * All values must be strings. For booleans, integers, or floats, wrap the value in quotes (for example, `value: "1"`, `value: "0"`, or `value: "443"`). \ No newline at end of file diff --git a/docs/reference/custom-resource-configvalues.mdx b/docs/reference/custom-resource-configvalues.mdx index eb6ae68834..397e6fc220 100644 --- a/docs/reference/custom-resource-configvalues.mdx +++ b/docs/reference/custom-resource-configvalues.mdx @@ -94,13 +94,13 @@ In the ConfigValues resource that is automatically generated by the Admin Consol * An empty mapping (`{}`). For configuration items without a user-supplied `value` or a `default` set, the value is set to `{}`. ::: -### values.[item_name].valuePlainText {#valueplaintext} +### values.[item_name].valuePlaintext {#valueplaintext} -A plain text value. For any configuration items of type [`password`](/reference/custom-resource-config#password), the password must be provided in plain text in a `valuePlainText` property rather than in the `value` property. +A plain text value. For any configuration items of type [`password`](/reference/custom-resource-config#password), the password must be provided in plain text in a `valuePlaintext` property rather than in the `value` property. -During installation, the Admin Console encrypts the values set in `valuePlainText`. In the ConfigValues resource that is automatically generated as part of installation, these encrypted values are saved in `value` properties. The image below shows how a `valuePlainText` value is encrypted and added to a `value` property during installation: +During installation, the Admin Console encrypts the values set in `valuePlaintext`. In the ConfigValues resource that is automatically generated as part of installation, these encrypted values are saved in `value` properties. The image below shows how a `valuePlaintext` value is encrypted and added to a `value` property during installation: -![valuesPlainText field in ConfigValues](/images/configvalues-plaintext.png) +![valuesPlaintext field in ConfigValues](/images/configvalues-plaintext.png) [View a larger version of this image](/images/configvalues-plaintext.png) @@ -112,11 +112,11 @@ kind: ConfigValues spec: values: slack_bot_token: - valuePlainText: examplebottoken + valuePlaintext: examplebottoken slack_clientsecret: - valuePlainText: exampleclientsecret + valuePlaintext: exampleclientsecret slack_user_token: - valuePlainText: exampleusertoken + valuePlaintext: exampleusertoken ``` ## Download the ConfigValues for an Installation {#download}