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.md
+10-5Lines changed: 10 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,8 @@
2
2
displayed_sidebar: kots
3
3
---
4
4
5
+
import Kots from "../docs/partials/kots/_kots-definition.mdx"
6
+
5
7
# Introduction to KOTS
6
8
7
9
This topic provides an introduction to the Replicated KOTS installer, including information about KOTS features, installation options, and user interfaces.
@@ -12,7 +14,7 @@ The Replicated KOTS entitlement is required to install applications with KOTS. F
12
14
13
15
## Overview
14
16
15
-
Replicated KOTS is a kubectl plugin and an in-cluster admin console that provides highly successful installations of Helm charts and Kubernetes applications into customer-controlled environments, including on-prem and air gap environments. KOTS also supports installations onto VMs or bare metal servers through _embedded clusters_, which are clusters built from a customized Kubernetes distribution embedded with an application and provisioned in the customer environment at the time of installation.
17
+
<Kots/>
16
18
17
19
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.
18
20
@@ -30,22 +32,25 @@ KOTS is an open source project that is maintained by Replicated. For more inform
30
32
31
33
## About Installing with KOTS
32
34
33
-
KOTS can be used to install applications in Kubernetes clusters, including air gapped clusters, embedded clusters provisioned on VMs or bare metal servers with Replicated kURL, or any existing cluster brought by the user.
35
+
KOTS can be used to install applications in Kubernetes clusters, including:
36
+
* Existing clusters brought by the user
37
+
* Online or air gapped clusters
38
+
* Embedded clusters provisioned on VMs or bare metal servers with Replicated embedded cluster or Replicated kURL
34
39
35
40
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
41
37
-
The following diagram demonstrates how a single application release promoted 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:
42
+
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
43
39
44
<imgalt="Embedded cluster, air gap, and existing cluster app installation workflows"src="/images/kots-installation-overview.png"width="650px"/>
40
45
41
46
[View a larger version of this image](/images/kots-installation-overview.png)
42
47
43
48
As shown in the diagram above:
44
-
* For installations into existing clusters with access to the internet, users run a command to install KOTS in their cluster.
49
+
* For installations in existing internet-connected clusters, users run a command to install KOTS in their cluster.
45
50
* 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.
46
51
* 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.
47
52
48
-
All users are provided a license file that allows them 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.
53
+
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
54
50
55
For more information about how to install applications with KOTS, see the [Installing an Application](/enterprise/installing-overview) section.
Replicated KOTS is a kubectl plugin and an in-cluster admin console that provides highly successful installations of Helm charts and Kubernetes applications into customer-controlled environments, including on-prem and air gap environments. KOTS also supports installations onto VMs or bare metal servers through _embedded clusters_, which are clusters built from a customized Kubernetes distribution embedded with an application and provisioned in the customer environment at the time of installation.
1
+
Replicated KOTS is a kubectl plugin and an in-cluster admin console that provides highly successful installations of Helm charts and Kubernetes applications into customer-controlled environments, including on-prem and air gap environments. KOTS also supports installations on VMs or bare metal servers through _embedded clusters_, which are clusters built from a customized Kubernetes distribution embedded with an application and provisioned in the customer environment at the time of installation.
Copy file name to clipboardExpand all lines: docs/vendor/kurl-about.mdx
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Introduction to kURL
2
2
3
-
This topic provides an introduction to the Replicated kURL installer, including information about defining specifications for kURL clusters and installing with kURL.
3
+
This topic provides an introduction to the Replicated kURL installer, including information about kURL specifications and installations.
4
4
5
5
:::note
6
6
The Replicated KOTS entitlement is required to install applications with KOTS and kURL. For more information, see [Pricing](https://www.replicated.com/pricing) on the Replicated website.
@@ -20,11 +20,11 @@ Installer specs can be embedded with an application by promoting the spec to the
20
20
21
21
For more information about creating Kubernetes installer specs for kURL, see [Creating a Kubernetes Installer](/vendor/packaging-embedded-kubernetes).
22
22
23
-
### Embedded Cluster Installations
23
+
### kURL Installations
24
24
25
-
Installations with Replicated KOTS in clusters provisioned by kURL are called _embedded cluster_ installations. In embedded cluster installations, users run a kURL installation script on their VM or bare metal server to provision a cluster.
25
+
To install with kURL, users run a kURL installation script on their VM or bare metal server to provision a cluster.
26
26
27
-
When the KOTS add-on is included in the Kubernetes installer spec, the kURL installation script also automatically installs the kots CLI and KOTS admin console in the cluster. After the installation script completes, users can access the admin console at the URL provided in the ouput of the command to configure and deploy the application. Users can also manage nodes for clusters provisioned with kURL from the **Cluster Management** page of the KOTS admin console.
27
+
When the KOTS add-on is included in the Kubernetes installer spec, the kURL installation script installs the kots CLI and KOTS admin console in the cluster. After the installation script completes, users can access the admin console at the URL provided in the ouput of the command to configure and deploy the applicationwith KOTS.
28
28
29
29
The following shows an example of the output of the kURL installation script:
30
30
@@ -40,9 +40,9 @@ this password; this can be done with the following command:
40
40
kubectl kots reset-password default
41
41
```
42
42
43
-
Embedded cluster installations are supported in online (internet-connected) and air gapped environments.
43
+
kURL installations are supported in online (internet-connected) and air gapped environments.
44
44
45
-
For information about how to install applications in embedded clusters with KOTS and kURL, see [Online Installation with kURL](/enterprise/installing-embedded-cluster).
45
+
For information about how to install applications with kURL, see [Online Installation with kURL](/enterprise/installing-embedded-cluster).
0 commit comments