Skip to content

Commit c1d6735

Browse files
paigecalvertpaigecalvert
committed
split up configvalues
1 parent 11673ad commit c1d6735

File tree

5 files changed

+60
-13
lines changed

5 files changed

+60
-13
lines changed

‎docs/enterprise/installing-embedded-automation.mdx‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
import ConfigValuesExample from "../partials/configValues/_configValuesExample.mdx"
2+
import ConfigValuesProcedure from "../partials/configValues/_config-values-procedure.mdx"
23

34
# Installing with Embedded Cluster from the Command Line
45

@@ -12,14 +13,14 @@ To install from the command line, you provide all the necessary installation ass
1213

1314
## Prerequisite
1415

15-
Create a ConfigValues YAML file to define the configuration values for the application release. You will pass the ConfigValues file with the installation command. For air-gapped environments, ensure that the ConfigValues file can be accessed from the installation environment.
16+
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.
1617

17-
For more information, see [Generating a ConfigValues File](/vendor/releases-configvalues).
18-
19-
**Example:**
18+
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:
2019

2120
<ConfigValuesExample/>
2221

22+
<ConfigValuesProcedure/>
23+
2324
## Online (Internet-Connected) Installation
2425

2526
To install with Embedded Cluster in an online environment:

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ import KotsVersionMatch from "../partials/install/_kots-airgap-version-match.mdx
1414
import PlaceholderRoCreds from "../partials/install/_placeholder-ro-creds.mdx"
1515
import AccessAdminConsole from "../partials/install/_access-admin-console.mdx"
1616

17-
# Installing from the Command Line
17+
# Installing with the KOTS CLI
1818

1919
This topic describes how to install an application with Replicated KOTS in an existing cluster using the KOTS CLI.
2020

@@ -42,13 +42,13 @@ The following shows an example of the output from the kots install command:
4242

4343
## Prerequisite
4444

45-
Create a ConfigValues YAML file to define the configuration values for the application release. You will pass the ConfigValues file with the installation command. For air-gapped environments, ensure that the ConfigValues file can be accessed from the installation environment.
45+
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.
4646

47-
For more information, see [Generating a ConfigValues File](/vendor/releases-configvalues).
48-
49-
**Example:**
47+
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:
5048

5149
<ConfigValuesExample/>
50+
51+
<ConfigValuesProcedure/>
5252

5353
## Online (Internet-Connected) Installation
5454

‎docs/enterprise/installing-kurl-automation.mdx‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,14 @@ To install from the command line, you provide all the necessary installation ass
1616

1717
## Prerequisite
1818

19-
Create a ConfigValues YAML file to define the configuration values for the application release. You will pass the ConfigValues file with the installation command. For air-gapped environments, ensure that the ConfigValues file can be accessed from the installation environment.
19+
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.
2020

21-
For more information, see [Generating a ConfigValues File](/vendor/releases-configvalues).
22-
23-
**Example:**
21+
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:
2422

2523
<ConfigValuesExample/>
2624

25+
<ConfigValuesProcedure/>
26+
2727
## Online (Internet-Connected) Installation
2828

2929
<IntroKurl/>

‎docs/partials/configValues/_config-values-procedure.mdx‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
During installation, KOTS automatically generates a ConfigValues file and saves the file in a directory called `upstream`. After installation, you can view the generated ConfigValues file in the Admin Console **View files** tab or from the command line by running the `kubectl kots get config` command.
2+
3+
To get the ConfigValues file from an installed application instance:
4+
5+
1. Install the target release in a development environment. You can either install the release with Replicated Embedded Cluster or install in an existing cluster with KOTS. For more information, see [Online Installation with Embedded Cluster](/enterprise/installing-embedded) or [Online Installation in Existing Clusters](/enterprise/installing-existing-cluster).
6+
7+
1. Depending on the installer that you used, do one of the following to get the ConfigValues for the installed instance:
8+
9+
* **For Embedded Cluster installations**: In the Admin Console, go to the **View files** tab. In the filetree, go to **upstream > userdata** and open **config.yaml**, as shown in the image below:
10+
11+
![ConfigValues file in the Admin Console View Files tab](/images/admin-console-view-files-configvalues.png)
12+
13+
[View a larger version of this image](/images/admin-console-view-files-configvalues.png)
14+
15+
* **For KOTS installations in an existing cluster**: Run the `kubectl kots get config` command to view the generated ConfigValues file:
16+
17+
```bash
18+
kubectl kots get config --namespace APP_NAMESPACE --decrypt
19+
```
20+
Where:
21+
* `APP_NAMESPACE` is the cluster namespace where KOTS is running.
22+
* The `--decrypt` flag decrypts all configuration fields with `type: password`. In the downloaded ConfigValues file, the decrypted value is stored in a `valuePlaintext` field.
23+
24+
The output of the `kots get config` command shows the contents of the ConfigValues file. For more information about the `kots get config` command, including additional flags, see [kots get config](/reference/kots-cli-get-config).

‎docs/partials/install/_config-values-procedure.mdx‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
To get the ConfigValues file from an installed application instance:
2+
3+
1. Install the target release in a development environment. You can either install the release with Replicated Embedded Cluster or install in an existing cluster with KOTS. For more information, see [Online Installation with Embedded Cluster](/enterprise/installing-embedded) or [Online Installation in Existing Clusters](/enterprise/installing-existing-cluster).
4+
5+
1. Depending on the installer that you used, do one of the following to get the ConfigValues for the installed instance:
6+
7+
* **For Embedded Cluster installations**: In the Admin Console, go to the **View files** tab. In the filetree, go to **upstream > userdata** and open **config.yaml**, as shown in the image below:
8+
9+
![ConfigValues file in the Admin Console View Files tab](/images/admin-console-view-files-configvalues.png)
10+
11+
[View a larger version of this image](/images/admin-console-view-files-configvalues.png)
12+
13+
* **For KOTS installations in an existing cluster**: Run the `kubectl kots get config` command to view the generated ConfigValues file:
14+
15+
```bash
16+
kubectl kots get config --namespace APP_NAMESPACE --decrypt
17+
```
18+
Where:
19+
* `APP_NAMESPACE` is the cluster namespace where KOTS is running.
20+
* The `--decrypt` flag decrypts all configuration fields with `type: password`. In the downloaded ConfigValues file, the decrypted value is stored in a `valuePlaintext` field.
21+
22+
The output of the `kots get config` command shows the contents of the ConfigValues file. For more information about the `kots get config` command, including additional flags, see [kots get config](/reference/kots-cli-get-config).

0 commit comments

Comments
 (0)