Skip to content

Commit baead50

Browse files
committed
edits
1 parent eef6feb commit baead50

File tree

3 files changed

+17
-12
lines changed

3 files changed

+17
-12
lines changed

docs/intro-kots.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
displayed_sidebar: kots
33
---
44

5+
import Kots from "../docs/partials/kots/_kots-definition.mdx"
6+
57
# Introduction to KOTS
68

79
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
1214

1315
## Overview
1416

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/>
1618

1719
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.
1820

@@ -30,22 +32,25 @@ KOTS is an open source project that is maintained by Replicated. For more inform
3032

3133
## About Installing with KOTS
3234

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
3439

3540
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.
3641

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:
3843

3944
<img alt="Embedded cluster, air gap, and existing cluster app installation workflows" src="/images/kots-installation-overview.png" width="650px"/>
4045

4146
[View a larger version of this image](/images/kots-installation-overview.png)
4247

4348
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.
4550
* 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.
4651
* 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.
4752

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.
4954

5055
For more information about how to install applications with KOTS, see the [Installing an Application](/enterprise/installing-overview) section.
5156

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
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 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.

docs/vendor/kurl-about.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Introduction to kURL
22

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.
44

55
:::note
66
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
2020

2121
For more information about creating Kubernetes installer specs for kURL, see [Creating a Kubernetes Installer](/vendor/packaging-embedded-kubernetes).
2222

23-
### Embedded Cluster Installations
23+
### kURL Installations
2424

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.
2626

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 application with KOTS.
2828

2929
The following shows an example of the output of the kURL installation script:
3030

@@ -40,9 +40,9 @@ this password; this can be done with the following command:
4040
kubectl kots reset-password default
4141
```
4242

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.
4444

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).
4646

4747
## About the Open Source kURL Documentation
4848

0 commit comments

Comments
 (0)