Skip to content

Commit fd3ddb9

Browse files
paigecalvertpaigecalvert
committed
divide automation topic
1 parent 738262b commit fd3ddb9

File tree

5 files changed

+221
-177
lines changed

5 files changed

+221
-177
lines changed

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

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
import ConfigValuesExample from "../partials/configValues/_configValuesExample.mdx"
2+
3+
# Installing with Embedded Cluster from the Command Line
4+
5+
This topic describes how to install an application with Replicated Embedded Cluster from the command line.
6+
7+
## Overview
8+
9+
You can use the command line to install an application with Replicated Embedded Cluster. A common use case for installing from the command line is to automate installation, such as performing headless installations as part of CI/CD pipelines.
10+
11+
To install from the command line, you provide all the necessary installation assets, such as the license file and the application config values, with the installation command rather than through the Admin Console UI. Any preflight checks defined for the application run automatically during headless installations from the command line rather than being displayed in the Admin Console.
12+
13+
## Prerequisite
14+
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+
17+
For more information, see [Generating a ConfigValues File](/vendor/releases-configvalues).
18+
19+
**Example:**
20+
21+
<ConfigValuesExample/>
22+
23+
## Online (Internet-Connected) Installation
24+
25+
To install with Embedded Cluster in an online environment:
26+
27+
1. Follow the steps provided in the Vendor Portal to download and untar the Embedded Cluster installation assets. For more information, see [Online Installation with Embedded Cluster](/enterprise/installing-embedded).
28+
29+
1. Run the following command to install:
30+
31+
```bash
32+
sudo ./APP_SLUG install --license-file PATH_TO_LICENSE \
33+
--config-values PATH_TO_CONFIGVALUES \
34+
--admin-console-password ADMIN_CONSOLE_PASSWORD
35+
```
36+
37+
Replace:
38+
* `APP_SLUG` with the unique slug for the application.
39+
* `LICENSE_FILE` with the customer license.
40+
* `ADMIN_CONSOLE_PASSWORD` with a password for accessing the Admin Console.
41+
* `PATH_TO_CONFIGVALUES` with the path to the ConfigValues file. See [Generating a ConfigValues File](/vendor/releases-configvalues).
42+
43+
## Air Gap Installation
44+
45+
To install with Embedded Cluster in an air-gapped environment:
46+
47+
1. Follow the steps provided in the Vendor Portal to download and untar the Embedded Cluster air gap installation assets. For more information, see [Air Gap Installation with Embedded Cluster](/enterprise/installing-embedded-air-gap).
48+
49+
1. Ensure that the Embedded Cluster installation assets are available on the air-gapped machine, then run the following command to install:
50+
51+
```bash
52+
sudo ./APP_SLUG install --license-file PATH_TO_LICENSE \
53+
--config-values PATH_TO_CONFIGVALUES \
54+
--admin-console-password ADMIN_CONSOLE_PASSWORD \
55+
--airgap-bundle PATH_TO_AIRGAP_BUNDLE
56+
```
57+
58+
Replace:
59+
* `APP_SLUG` with the unique slug for the application.
60+
* `LICENSE_FILE` with the customer license.
61+
* `PATH_TO_CONFIGVALUES` with the path to the ConfigValues file. See [Generating a ConfigValues File](/vendor/releases-configvalues).
62+
* `ADMIN_CONSOLE_PASSWORD` with a password for accessing the Admin Console.
63+
* `PATH_TO_AIRGAP_BUNDLE` with the path to the Embedded Cluster `.airgap` bundle for the release.

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

Lines changed: 24 additions & 174 deletions
Original file line numberDiff line numberDiff line change
@@ -12,16 +12,33 @@ import InstallKotsCli from "../partials/install/_install-kots-cli.mdx"
1212
import PushKotsImages from "../partials/install/_push-kotsadm-images.mdx"
1313
import KotsVersionMatch from "../partials/install/_kots-airgap-version-match.mdx"
1414
import PlaceholderRoCreds from "../partials/install/_placeholder-ro-creds.mdx"
15+
import AccessAdminConsole from "../partials/install/_access-admin-console.mdx"
1516

1617
# Installing from the Command Line
1718

18-
This topic describes how to install an application with Replicated KOTS, Replicated Embedded Cluster, or Replicated kURL from the command line.
19+
This topic describes how to install an application with Replicated KOTS in an existing cluster using the KOTS CLI.
1920

2021
## Overview
2122

22-
You can use the command line to install an application with Replicated KOTS, Replicated Embedded Cluster, or Replicated kURL. A common use case for installing from the command line is to automate installation, such as performing headless installations as part of CI/CD pipelines.
23+
You can use the KOTS CLI to install an application with Replicated KOTS. A common use case for installing from the command line is to automate installation, such as performing headless installations as part of CI/CD pipelines.
2324

24-
To install from the command line, you provide all the necessary installation assets, such as the license file and the application config values, with the installation command rather than through the Admin Console UI. Any preflight checks defined for the application run automatically during headless installations from the command line rather than being displayed in the Admin Console.
25+
To install with the KOTS CLI, you provide all the necessary installation assets, such as the license file and the application config values, with the installation command rather than through the Admin Console UI. Any preflight checks defined for the application run automatically from the CLI rather than being displayed in the Admin Console.
26+
27+
The following shows an example of the output from the kots install command:
28+
29+
```
30+
• Deploying Admin Console
31+
• Creating namespace ✓
32+
• Waiting for datastore to be ready ✓
33+
• Waiting for Admin Console to be ready ✓
34+
• Waiting for installation to complete ✓
35+
• Waiting for preflight checks to complete ✓
36+
37+
• Press Ctrl+C to exit
38+
• Go to http://localhost:8800 to access the Admin Console
39+
40+
• Go to http://localhost:8888 to access the application
41+
```
2542

2643
## Prerequisite
2744

@@ -33,32 +50,9 @@ For more information, see [Generating a ConfigValues File](/vendor/releases-conf
3350

3451
<ConfigValuesExample/>
3552

36-
## Install
37-
38-
### Embedded Cluster
39-
40-
To install with Embedded Cluster in an online environment:
53+
## Online (Internet-Connected) Installation
4154

42-
1. Follow the steps provided in the Vendor Portal to download and untar the Embedded Cluster installation assets. For more information, see [Online Installation with Embedded Cluster](/enterprise/installing-embedded).
43-
44-
1. Run the following command to install:
45-
46-
```bash
47-
sudo ./APP_SLUG install --license-file PATH_TO_LICENSE \
48-
--config-values PATH_TO_CONFIGVALUES \
49-
--admin-console-password ADMIN_CONSOLE_PASSWORD
50-
```
51-
52-
Replace:
53-
* `APP_SLUG` with the unique slug for the application.
54-
* `LICENSE_FILE` with the customer license.
55-
* `ADMIN_CONSOLE_PASSWORD` with a password for accessing the Admin Console.
56-
* `PATH_TO_CONFIGVALUES` with the path to the ConfigValues file. See [Generating a ConfigValues File](/vendor/releases-configvalues).
57-
58-
59-
### KOTS in an Existing Cluster
60-
61-
To install with KOTS in an existing cluster:
55+
To install with KOTS in an online existing cluster:
6256

6357
1. <InstallKotsCli/>
6458

@@ -78,76 +72,7 @@ To install with KOTS in an existing cluster:
7872

7973
<PlaceholderNamespaceExisting/>
8074

81-
The following shows an example of the output from the kots install command:
82-
83-
```
84-
• Deploying Admin Console
85-
• Creating namespace ✓
86-
• Waiting for datastore to be ready ✓
87-
• Waiting for Admin Console to be ready ✓
88-
• Waiting for installation to complete ✓
89-
• Waiting for preflight checks to complete ✓
90-
91-
• Press Ctrl+C to exit
92-
• Go to http://localhost:8800 to access the Admin Console
93-
94-
• Go to http://localhost:8888 to access the application
95-
```
96-
97-
### kURL
98-
99-
<IntroEmbedded/>
100-
101-
To install with kURL on a VM or bare metal server:
102-
103-
1. Create the kURL cluster:
104-
105-
```bash
106-
curl -sSL https://k8s.kurl.sh/APP_NAME | sudo bash
107-
```
108-
109-
1. Install the application in the cluster:
110-
111-
```bash
112-
kubectl kots install APP_NAME \
113-
--shared-password PASSWORD \
114-
--license-file PATH_TO_LICENSE \
115-
--config-values PATH_TO_CONFIGVALUES \
116-
--namespace default \
117-
--no-port-forward
118-
```
119-
120-
Replace:
121-
122-
<PlaceholdersGlobal/>
123-
124-
<PlaceholderNamespaceEmbedded/>
125-
126-
## Air Gap Install
127-
128-
### Embedded Cluster
129-
130-
To install with Embedded Cluster in an air-gapped environment:
131-
132-
1. Follow the steps provided in the Vendor Portal to download and untar the Embedded Cluster air gap installation assets. For more information, see [Air Gap Installation with Embedded Cluster](/enterprise/installing-embedded-air-gap).
133-
134-
1. Ensure that the Embedded Cluster installation assets are available on the air-gapped machine, then run the following command to install:
135-
136-
```bash
137-
sudo ./APP_SLUG install --license-file PATH_TO_LICENSE \
138-
--config-values PATH_TO_CONFIGVALUES \
139-
--admin-console-password ADMIN_CONSOLE_PASSWORD \
140-
--airgap-bundle PATH_TO_AIRGAP_BUNDLE
141-
```
142-
143-
Replace:
144-
* `APP_SLUG` with the unique slug for the application.
145-
* `LICENSE_FILE` with the customer license.
146-
* `PATH_TO_CONFIGVALUES` with the path to the ConfigValues file. See [Generating a ConfigValues File](/vendor/releases-configvalues).
147-
* `ADMIN_CONSOLE_PASSWORD` with a password for accessing the Admin Console.
148-
* `PATH_TO_AIRGAP_BUNDLE` with the path to the Embedded Cluster `.airgap` bundle for the release.
149-
150-
### KOTS in an Existing Cluster
75+
## Air Gap Installation
15176

15277
To install with KOTS in an air-gapped existing cluster:
15378

@@ -184,81 +109,6 @@ To install with KOTS in an air-gapped existing cluster:
184109

185110
<PlaceholderRoCreds/>
186111

187-
### kURL
188-
189-
<IntroEmbedded/>
190-
191-
To install in an air-gapped kURL cluster:
192-
193-
1. Download the kURL `.tar.gz` air gap bundle:
194-
195-
<DownloadkURLBundle/>
196-
197-
1. <ExtractKurlBundle/>
198-
199-
1. Create the kURL cluster:
200-
201-
```
202-
cat install.sh | sudo bash -s airgap
203-
```
204-
205-
1. Install the application:
206-
207-
```bash
208-
kubectl kots install APP_NAME \
209-
--shared-password PASSWORD \
210-
--license-file PATH_TO_LICENSE \
211-
--config-values PATH_TO_CONFIGVALUES \
212-
--airgap-bundle PATH_TO_AIRGAP_BUNDLE \
213-
--namespace default \
214-
--no-port-forward
215-
```
216-
217-
Replace:
218-
219-
<PlaceholdersGlobal/>
220-
221-
<PlaceholderAirgapBundle/>
222-
223-
<PlaceholderNamespaceEmbedded/>
224-
225112
## (Optional) Access the Admin Console
226113

227-
When you install an application in an existing cluster or when you provision a cluster with the kURL installer, you also install KOTS in the cluster. KOTS deploys the Admin Console. The Admin Console is a user interface where you can manage and upgrade your application instances.
228-
229-
By default, during installation, KOTS automatically opens localhost port 8800 to provide access to the Admin Console. The `--no-port-forward` flag in the `kots install` command prevents KOTS from creating a port forward to the Admin Console.
230-
231-
After you install with the `--no-port-forward` flag, you can optionally create a port forward so that you can log in to the Admin Console in a browser window.
232-
233-
To access the Admin Console:
234-
235-
1. If you installed in a VM where you cannot open a browser window, forward a port on your local machine to `localhost:8800` on the remote VM using the SSH client:
236-
237-
```bash
238-
ssh -L LOCAL_PORT:localhost:8800 USERNAME@IP_ADDRESS
239-
```
240-
Replace:
241-
* `LOCAL_PORT` with the port on your local machine to forward. For example, `9900` or `8800`.
242-
* `USERNAME` with your username for the VM.
243-
* `IP_ADDRESS` with the IP address for the VM.
244-
245-
**Example**:
246-
247-
The following example shows using the SSH client to forward port 8800 on your local machine to `localhost:8800` on the remote VM.
248-
249-
```bash
250-
ssh -L 8800:localhost:8800 user@ip-addr
251-
```
252-
253-
1. Run the following KOTS CLI command to open localhost port 8800, which forwards to the Admin Console service:
254-
255-
```bash
256-
kubectl kots admin-console --namespace NAMESPACE
257-
```
258-
Replace `NAMESPACE` with the namespace where the Admin Console was installed.
259-
260-
For more information about the `kots admin-console` command, see [admin-console](/reference/kots-cli-admin-console-index) in the _KOTS CLI_ documentation.
261-
262-
1. Open a browser window and go to `https://localhost:8800`.
263-
264-
1. Log in to the Admin Console using the password that you created as part of the `kots install` command.
114+
<AccessAdminConsole/>

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

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
import ConfigValuesExample from "../partials/configValues/_configValuesExample.mdx"
2+
import PlaceholdersGlobal from "../partials/install/_placeholders-global.mdx"
3+
import PlaceholderAirgapBundle from "../partials/install/_placeholder-airgap-bundle.mdx"
4+
import PlaceholderNamespaceKurl from "../partials/install/_placeholder-namespace-embedded.mdx"
5+
import IntroKurl from "../partials/install/_automation-intro-embedded.mdx"
6+
7+
# Installing with kURL from the Command Line
8+
9+
This topic describes how to install an application with Replicated kURL from the command line.
10+
11+
## Overview
12+
13+
You can use the command line to install an application with Replicated kURL. A common use case for installing from the command line is to automate installation, such as performing headless installations as part of CI/CD pipelines.
14+
15+
To install from the command line, you provide all the necessary installation assets, such as the license file and the application config values, with the installation command rather than through the Admin Console UI. Any preflight checks defined for the application run automatically during headless installations from the command line rather than being displayed in the Admin Console.
16+
17+
## Prerequisite
18+
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.
20+
21+
For more information, see [Generating a ConfigValues File](/vendor/releases-configvalues).
22+
23+
**Example:**
24+
25+
<ConfigValuesExample/>
26+
27+
## Online (Internet-Connected) Installation
28+
29+
<IntroKurl/>
30+
31+
To install with kURL on a VM or bare metal server:
32+
33+
1. Create the kURL cluster:
34+
35+
```bash
36+
curl -sSL https://k8s.kurl.sh/APP_NAME | sudo bash
37+
```
38+
39+
1. Install the application in the cluster:
40+
41+
```bash
42+
kubectl kots install APP_NAME \
43+
--shared-password PASSWORD \
44+
--license-file PATH_TO_LICENSE \
45+
--config-values PATH_TO_CONFIGVALUES \
46+
--namespace default \
47+
--no-port-forward
48+
```
49+
50+
Replace:
51+
52+
<PlaceholdersGlobal/>
53+
54+
<PlaceholderNamespaceKurl/>
55+
56+
<IntroEmbedded/>
57+
58+
## Air Gap Installation
59+
60+
To install in an air-gapped kURL cluster:
61+
62+
1. Download the kURL `.tar.gz` air gap bundle:
63+
64+
<DownloadkURLBundle/>
65+
66+
1. <ExtractKurlBundle/>
67+
68+
1. Create the kURL cluster:
69+
70+
```
71+
cat install.sh | sudo bash -s airgap
72+
```
73+
74+
1. Install the application:
75+
76+
```bash
77+
kubectl kots install APP_NAME \
78+
--shared-password PASSWORD \
79+
--license-file PATH_TO_LICENSE \
80+
--config-values PATH_TO_CONFIGVALUES \
81+
--airgap-bundle PATH_TO_AIRGAP_BUNDLE \
82+
--namespace default \
83+
--no-port-forward
84+
```
85+
86+
Replace:
87+
88+
<PlaceholdersGlobal/>
89+
90+
<PlaceholderAirgapBundle/>
91+
92+
<PlaceholderNamespaceEmbedded/>

0 commit comments

Comments
 (0)