You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/intro-kots.mdx
+20-14Lines changed: 20 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,14 +12,14 @@ The Replicated KOTS entitlement is required to install applications with KOTS. F
12
12
13
13
<Kots/>
14
14
15
-
KOTS communicates securely with the Replicated vendor platform to synchronize customer licenses, check for available application updates, send instance data, share customer-generated support bundles, and more.
15
+
KOTS communicates securely with the Replicated Vendor Portal to synchronize customer licenses, check for available application updates, send instance data, share customer-generated support bundles, and more.
16
16
17
17
Installing an application with KOTS provides access to features such as:
18
18
19
-
* Support for air gap installations
20
-
* Support for installations on VMs or bare metal servers
19
+
* Support for air gap installations in environments with limited or no outbound internet access
20
+
* Support for installations on VMs or bare metal servers, when using Replicated Embedded Cluster or Replicated kURL
21
21
* The KOTS Admin Console, which provides a user interface where customers can install and manage their application instances
22
-
* Instance telemetry automatically sent to the vendor portal for instances running in customer environments
22
+
* Instance telemetry automatically sent to the Vendor Portal for instances running in customer environments
23
23
* Strict preflight checks that block installation if environment requirements are not met
24
24
* Backup and restore with Replicated snapshots
25
25
* Support for marking releases as required to prevent users from skipping them during upgrades
@@ -28,25 +28,25 @@ KOTS is an open source project that is maintained by Replicated. For more inform
28
28
29
29
## About Installing with KOTS
30
30
31
-
KOTS can be used to install applications in Kubernetes clusters, including:
31
+
KOTS can be used to install Kubernetes applications and Helm charts in the following environments:
32
+
* Clusters provisioned on VMs or bare metal servers with Replicated Embedded Cluster or Replicated kURL
32
33
* Existing clusters brought by the user
33
-
* Online or air gapped clusters
34
-
* Embedded clusters provisioned on VMs or bare metal servers with Replicated Embedded Cluster or Replicated kURL
34
+
* Online (internet-connected) or air-gapped (disconnected) environments
35
35
36
-
To install an application with KOTS, users first run an installation script to install KOTS in the target cluster and deploy the KOTS Admin Console. After KOTS is installed, users can log in to the KOTS Admin Console to upload their license file, configure the application, run preflight checks, and install and deploy the application.
36
+
To install an application with KOTS, users first run an installation script that installs KOTS in the target cluster and deploys the KOTS Admin Console. After KOTS is installed, users can log in to the KOTS Admin Console to upload their license file, configure the application, run preflight checks, and install and deploy the application.
37
37
38
-
The following diagram demonstrates how a single release promoted to the Stable channel in the Replicated vendor platform can be installed using KOTS in an embedded cluster on a VM, in an air gapped cluster, and in an existing internet-connected cluster:
38
+
The following diagram demonstrates how a single release promoted to the Stable channel in the Vendor Portal can be installed with KOTS in an embedded cluster on a VM, in an existing air-gapped cluster, and in an existing internet-connected cluster:
39
39
40
40
<imgalt="Embedded cluster, air gap, and existing cluster app installation workflows"src="/images/kots-installation-overview.png"/>
41
41
42
42
[View a larger version of this image](/images/kots-installation-overview.png)
43
43
44
44
As shown in the diagram above:
45
-
* For installations in existing internet-connected clusters, users run a command to install KOTS in their cluster.
46
-
* For embedded cluster installations on VMs or bare metal servers, users run an installation script that both provisions a cluster in their environment and installs KOTS in the cluster.
47
-
* For installations in airgapped clusters, users download air gap bundles for KOTS and the application from the Replicated download portal and then provide the bundles during installation.
45
+
* For installations in existing online (internet-connected) clusters, users run a command to install KOTS in their cluster.
46
+
* For installations on VMs or bare metal servers, users run an Embedded Cluster or kURL installation script that both provisions a cluster in their environment and installs KOTS in the cluster.
47
+
* For installations in air-gapped clusters, users download air gap bundles for KOTS and the application from the Replicated Download Portal and then provide the bundles during installation.
48
48
49
-
All users must provide a license file to install with KOTS. After KOTS is installed in the cluster, users can access the KOTS Admin Console to provide their license file and deploy the application.
49
+
All users must have a valid license file to install with KOTS. After KOTS is installed in the cluster, users can access the KOTS Admin Console to provide their license and deploy the application.
50
50
51
51
For more information about how to install applications with KOTS, see the [Installing an Application](/enterprise/installing-overview) section.
52
52
@@ -64,9 +64,15 @@ The following shows an example of the Admin Console dashboard for an application
64
64
65
65
[View a larger version of this image](/images/guides/kots/application.png)
66
66
67
+
For applications installed with Replicated Embedded Cluster in a VM or bare metal server, the Admin Console also includes a **Cluster Management** tab where users can add and manage nodes in the embedded cluster, as shown below:
68
+
69
+

70
+
71
+
[View a larger version of this image](/images/gitea-ec-ready.png)
72
+
67
73
### KOTS CLI
68
74
69
-
The kots command-line interface (CLI) is a kubectl plugin. Customers can run commands with the KOTS CLI to install and manage their application instances with KOTS programmatically.
75
+
The KOTS command-line interface (CLI) is a kubectl plugin. Customers can run commands with the KOTS CLI to install and manage their application instances with KOTS programmatically.
70
76
71
77
For information about getting started with the KOTS CLI, see [Installing the KOTS CLI](/reference/kots-cli-getting-started).
0 commit comments