Skip to content

Commit 45d4296

Browse files
authored
Merge pull request #3536 from replicatedhq/configvalues-typo
valuePlaintext typo
2 parents fd1f2b2 + 4e89c67 commit 45d4296

File tree

3 files changed

+9
-9
lines changed

3 files changed

+9
-9
lines changed

docs/partials/configValues/_configValuesExample.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ spec:
99
boolean_config_item_name:
1010
value: "1"
1111
password_config_item_name:
12-
valuePlainText: exampleplaintextpassword
12+
valuePlaintext: exampleplaintextpassword
1313
select_one_config_item_name:
1414
default: default_option_name
1515
value: selected_option_name
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
The ConfigValues resource must meet the following requirements:
22
* Must be valid YAML.
33
* 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.
4-
* 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.
4+
* 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.
55
* All values must be strings. For booleans, integers, or floats, wrap the value in quotes (for example, `value: "1"`, `value: "0"`, or `value: "443"`).

docs/reference/custom-resource-configvalues.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -94,13 +94,13 @@ In the ConfigValues resource that is automatically generated by the Admin Consol
9494
* An empty mapping (`{}`). For configuration items without a user-supplied `value` or a `default` set, the value is set to `{}`.
9595
:::
9696

97-
### values.[item_name].valuePlainText {#valueplaintext}
97+
### values.[item_name].valuePlaintext {#valueplaintext}
9898

99-
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.
99+
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.
100100

101-
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:
101+
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:
102102

103-
![valuesPlainText field in ConfigValues](/images/configvalues-plaintext.png)
103+
![valuesPlaintext field in ConfigValues](/images/configvalues-plaintext.png)
104104

105105
[View a larger version of this image](/images/configvalues-plaintext.png)
106106

@@ -112,11 +112,11 @@ kind: ConfigValues
112112
spec:
113113
values:
114114
slack_bot_token:
115-
valuePlainText: examplebottoken
115+
valuePlaintext: examplebottoken
116116
slack_clientsecret:
117-
valuePlainText: exampleclientsecret
117+
valuePlaintext: exampleclientsecret
118118
slack_user_token:
119-
valuePlainText: exampleusertoken
119+
valuePlaintext: exampleusertoken
120120
```
121121

122122
## Download the ConfigValues for an Installation {#download}

0 commit comments

Comments
 (0)