Skip to content

Commit c4e58b7

Browse files
committed
edits
1 parent ec7406d commit c4e58b7

File tree

3 files changed

+18
-7
lines changed

3 files changed

+18
-7
lines changed

docs/enterprise/installing-embedded-automation.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ With headless installation, you provide all the necessary installation assets, s
1414

1515
## Prerequisite
1616

17-
Create a Replicated KOTS ConfigValues resource to define the configuration values for the application. The ConfigValues resource allows you to pass the configuration values for an application from the command line with the install command, rather than through the Admin Console UI. For air-gapped environments, ensure that the ConfigValues file can be accessed from the installation environment.
17+
Create a ConfigValues resource to define the configuration values for the application. The ConfigValues resource allows you to pass the configuration values for an application from the command line with the install command, rather than through the Admin Console UI. For air-gapped environments, ensure that the ConfigValues file can be accessed from the installation environment.
1818

1919
The ConfigValues resource includes the fields that are defined in the Replicated KOTS Config custom resource for the release, along with the user-supplied and default values for each field, as shown in the example below:
2020

docs/enterprise/installing-existing-cluster-automation.mdx

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import ConfigValuesExample from "../partials/configValues/_configValuesExample.mdx"
2-
import ConfigValuesProcedure from "../partials/configValues/_config-values-procedure.mdx"
2+
import ConfigValuesRequirements from "../partials/configValues/_requirements.mdx"
33
import PlaceholdersGlobal from "../partials/install/_placeholders-global.mdx"
44
import PlaceholderAirgapBundle from "../partials/install/_placeholder-airgap-bundle.mdx"
55
import PlaceholderNamespaceExisting from "../partials/install/_placeholder-namespace-existing.mdx"
@@ -39,13 +39,17 @@ The following shows an example of the output from the kots install command:
3939

4040
## Prerequisite
4141

42-
Create a ConfigValues YAML file to define the configuration values for the application release. The ConfigValues file allows you to pass the configuration values for an application from the command line with the install command, rather than through the Admin Console UI. For air-gapped environments, ensure that the ConfigValues file can be accessed from the installation environment.
42+
Create a ConfigValues resource to define the configuration values for the application. The ConfigValues resource allows you to pass the configuration values for an application from the command line with the install command, rather than through the Admin Console UI. For air-gapped environments, ensure that the ConfigValues file can be accessed from the installation environment.
4343

44-
The KOTS ConfigValues file includes the fields that are defined in the KOTS Config custom resource for an application release, along with the user-supplied and default values for each field, as shown in the example below:
44+
The ConfigValues resource includes the fields that are defined in the Replicated KOTS Config custom resource for the release, along with the user-supplied and default values for each field, as shown in the example below:
4545

4646
<ConfigValuesExample/>
4747

48-
<ConfigValuesProcedure/>
48+
#### ConfigValues Requirements
49+
50+
<ConfigValuesRequirements/>
51+
52+
For more information, see [ConfigValues](/reference/custom-resource-configvalues).
4953

5054
## Online (Internet-Connected) Installation
5155

docs/reference/custom-resource-configvalues.mdx

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
import ConfigValuesExample from "../partials/configValues/_configValuesExample.mdx"
22
import ConfigValuesRequirements from "../partials/configValues/_requirements.mdx"
3+
import GetConfigValues from "../partials/configValues/_config-values-procedure.mdx"
34

45
# ConfigValues
56

@@ -13,7 +14,7 @@ The ConfigValues resource lists the values and defaults for each application con
1314

1415
In automated or headless installations, end users provide a ConfigValues resource with the install command to set the application configuration values from the command line rather than through the Admin Console UI. For more information about performing headless installations with Replicated Embedded Cluster, see [Automate Embedded Cluster Installations](/enterprise/installing-embedded-automation). For information about performing headless installations with KOTS in an existing cluster, see [Install with the KOTS CLI](/enterprise/installing-existing-cluster-automation).
1516

16-
Additionally, for each installation, the Admin Console automatically generates a ConfigValues resource and makes it available for download in the Admin Console **View files** tab.
17+
Additionally, for each installation, the Admin Console automatically generates a ConfigValues resource and makes it available for download in the Admin Console **View files** tab or with the [`kots get config`](/reference/kots-cli-get-config) command. For more information, see [Download the ConfigValues for an Installation](#download) below.
1718

1819
The following image shows how application configuration items defined a Config resource map to a ConfigValues resource:
1920

@@ -116,4 +117,10 @@ spec:
116117
valuePlainText: exampleclientsecret
117118
slack_user_token:
118119
valuePlainText: exampleusertoken
119-
```
120+
```
121+
122+
## Download the ConfigValues for an Installation {#download}
123+
124+
For each installation, the Admin Console automatically generates a ConfigValues resource and makes it available for download in the Admin Console **View files** tab or with the [`kots get config`](/reference/kots-cli-get-config) command.
125+
126+
<GetConfigValues/>

0 commit comments

Comments
 (0)