Skip to content

Commit 8c9f52c

Browse files
committed
edits
1 parent 1867f2a commit 8c9f52c

File tree

2 files changed

+6
-5
lines changed

2 files changed

+6
-5
lines changed
Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
The ConfigValues resource must meet the following requirements:
22
* Must be valid YAML.
33
* Must list all configuration items that are defined in the corresponding Config resource in the release, except any items with the [`hidden`](/reference/custom-resource-config#hidden) or [`readonly`](/reference/custom-resource-config#readonly) properties set to true.
4-
* For each configuration item in the Config resource that has a default value set, the ConfigValues must also list the default in the `default` property. Defaults are not automatically merged from the Config resource during installation.
5-
* For any configuration items of type [`password`](/reference/custom-resource-config#password), set the password in plain text in a `valuePlainText` property rather than in the `value` property. For example, `valuePlainText: somesecretvalue`. Values set in `valuePlainText` are encrypted during installation.
6-
* All values must be strings. For booleans or integers, use quotes (for example, `value: "1"`, `value: "0"`, or `value: "443"`).
4+
* 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.
5+
* For each configuration item defined in the Config resource that has a [`default`](/reference/custom-resource-config#default) set, the ConfigValues must also list the default in the `default` property. Defaults are not automatically merged from the Config resource during installation.
6+
* 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.
7+
* 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: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ spec:
6262
The user-supplied value for the application configuration item.
6363
6464
:::note
65-
In the ConfigValues resource that is automatically generated by the Admin Console as part of installation, the `value` property might also be set to a value rendered by a Replicated template function. For example, a [`hidden`](/reference/custom-resource-config#hidden) item defined in the Config resource might use the Replicated RandomString template function to set the value with `value: repl{{ RandomString 40}}`.
65+
In the ConfigValues resource that is automatically generated by the Admin Console as part of installation, the `value` property might also be set to a value rendered by a Replicated template function. For example, a [`hidden`](/reference/custom-resource-config#hidden) item defined in the Config resource might use the Replicated RandomString template function to set the value with `value: repl{{ RandomString 40}}`. For more information about using Replicated template functions, see [About Template Functions](/reference/template-functions-about).
6666
:::
6767

6868
#### Example
@@ -82,7 +82,7 @@ spec:
8282
value: "443"
8383
```
8484

85-
### values.[item_name].valuePlainText
85+
### values.[item_name].valuePlainText {#valueplaintext}
8686

8787
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.
8888

0 commit comments

Comments
 (0)