Skip to content

Commit b0cd1b9

Browse files
committed
kots intro edits
1 parent 414d609 commit b0cd1b9

File tree

3 files changed

+25
-14
lines changed

3 files changed

+25
-14
lines changed

docs/intro-kots.md

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ displayed_sidebar: kots
77
This topic provides an introduction to the Replicated KOTS installer, including information about KOTS features, installation options, and user interfaces.
88

99
:::note
10-
You must have the Replicated KOTS entitlement to use KOTS. For more information, see [Pricing](https://www.replicated.com/pricing) on the Replicated website.
10+
The Replicated KOTS entitlement is required to install applications with KOTS. For more information, see [Pricing](https://www.replicated.com/pricing) on the Replicated website.
1111
:::
1212

1313
## Overview
@@ -19,8 +19,8 @@ KOTS communicates securely with the Replicated vendor platform to synchronize cu
1919
Installing an application with KOTS provides access to feautures such as:
2020

2121
* Support for air gap installations
22-
* Support for installations onto VMs or bare metal servers
23-
* The KOTS admin console, which provides a user interface where your customers can install and manage their application instance
22+
* Support for installations on VMs or bare metal servers
23+
* The KOTS admin console, which provides a user interface where customers can install and manage their application instances
2424
* Instance telemetry automatically sent to the vendor portal for instances running in customer environments
2525
* Strict preflight checks that block installation if environment requirements are not met
2626
* Backup and restore with Replicated snapshots
@@ -30,27 +30,34 @@ KOTS is an open source project that is maintained by Replicated. For more inform
3030

3131
## About Installing with KOTS
3232

33-
The following diagram demonstrates the options for installing an application with KOTS, including installing in an existing cluster, an embedded cluster, and in air gap environments:
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.
34+
35+
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+
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:
3438

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

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

39-
As shown in the diagram above, customers can install an application with KOTS by first installing KOTS in the cluster. Then, they can use KOTS to configure and install the application.
43+
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.
45+
* 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+
* 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.
4047

41-
KOTS is installed in Kubernetes clusters. Customers can install in their own existing cluster. Or, for customers that do not have a cluster or that have less experience with Kubernetes, KOTS can also be installed in an embedded cluster on a VM or bare metal server.
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.
4249

43-
For more information about kURL, see [Introduction to kURL](/vendor/kurl-about).
50+
For more information about how to install applications with KOTS, see the [Installing an Application](/enterprise/installing-overview) section.
4451

4552
## KOTS User Interfaces
4653

47-
This section describest the interfaces that users can use to install and manage applications with KOTS.
54+
This section describes the KOTS interfaces available to users for installing and managing applications.
4855

4956
### KOTS Admin Console
5057

51-
KOTS provides an admin console to make it easy for customers to install, upgrade, and manage their application instance.
58+
KOTS provides an admin console to make it easy for users to install, manage, update, configure, monitor, backup and restore, and troubleshoot their application instance from a GUI.
5259

53-
The admin console is a user interface for KOTS that includes built-in functionality allowing users to install, manage, update, configure, monitor, backup and restore, and troubleshoot their application instances.
60+
The following shows an example of the admin console dashboard for an application:
5461

5562
![Admin Console Dashboard](/images/guides/kots/application.png)
5663

@@ -62,4 +69,4 @@ The kots command-line interface (CLI) is a kubectl plugin. Customers can run com
6269

6370
For information about getting started with the kots CLI, see [Installing the kots CLI](/reference/kots-cli-getting-started).
6471

65-
For information about how to run automated installations with the kots CLI, see [Installing with Automation](/enterprise/installing-existing-cluster-automation).
72+
The kots CLI can also be used to install an application without needing to access the admin console. This can be useful for automating installations and upgrades. For information about how to run automated installations with the kots CLI, see [Installing with Automation](/enterprise/installing-existing-cluster-automation).

docs/vendor/kurl-about.mdx

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

3-
This topic provides an introduction to the Replicated kURL installer.
3+
This topic provides an introduction to the Replicated kURL installer, including information about defining specifications for kURL clusters and installing with kURL.
4+
5+
:::note
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.
7+
:::
48

59
## Overview
610

@@ -42,6 +46,6 @@ For information about how to install applications in embedded clusters with KOTS
4246

4347
## About the Open Source kURL Documentation
4448

45-
The kURL project has open source documentation at [kurl.sh](https://kurl.sh/docs/introduction/).
49+
The open source documentation for the kURL project is available at [kurl.sh](https://kurl.sh/docs/introduction/).
4650

47-
The open source kURL documentation contains additional information about kURL installation options, kURL add-ons, and adding and managing nodes in kURL clusters. Software vendors can use the open source kURL documentation to find detailed reference information when creating Kubernetes installer specs or testing installation.
51+
The open source kURL documentation contains additional information including kURL installation options, kURL add-ons, and procedural content such as how to add and manage nodes in kURL clusters. Software vendors can use the open source kURL documentation to find detailed reference information when creating Kubernetes installer specs or testing installation.
141 Bytes
Loading

0 commit comments

Comments
 (0)