Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Embedded Cluster to Replicated intro content #2562

Open
wants to merge 24 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 20 additions & 14 deletions docs/intro-kots.md → docs/intro-kots.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,14 @@ The Replicated KOTS entitlement is required to install applications with KOTS. F

<Kots/>

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

Installing an application with KOTS provides access to feautures such as:

* Support for air gap installations
* Support for installations on VMs or bare metal servers
* Support for air gap installations in environments with limited or no outbound internet access
* Support for installations on VMs or bare metal servers, when using Replicated Embedded Cluster or Replicated kURL
* The KOTS Admin Console, which provides a user interface where customers can install and manage their application instances
* Instance telemetry automatically sent to the vendor portal for instances running in customer environments
* Instance telemetry automatically sent to the Vendor Portal for instances running in customer environments
* Strict preflight checks that block installation if environment requirements are not met
* Backup and restore with Replicated snapshots
* Support for marking releases as required to prevent users from skipping them during upgrades
Expand All @@ -28,25 +28,25 @@ KOTS is an open source project that is maintained by Replicated. For more inform

## About Installing with KOTS

KOTS can be used to install applications in Kubernetes clusters, including:
KOTS can be used to install Kubernetes applications and Helm charts in the following environments:
* Clusters provisioned on VMs or bare metal servers with Replicated Embedded Cluster or Replicated kURL
* Existing clusters brought by the user
* Online or air gapped clusters
* Embedded clusters provisioned on VMs or bare metal servers with Replicated Embedded Cluster or Replicated kURL
* Online (internet-connected) or air-gapped (disconnected) environments

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

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:
The following diagram demonstrates how a single release promoted to the Stable channel in the Vendor Portal can be installed using KOTS on a VM, in an air gap cluster, and in an existing internet-connected cluster:

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

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

As shown in the diagram above:
* For installations in existing internet-connected clusters, users run a command to install KOTS in their cluster.
* 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.
* 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.
* For installations in existing online (internet-connected) clusters, users run a command to install KOTS in their cluster.
* 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.
* 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.

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

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

Expand All @@ -64,9 +64,15 @@ The following shows an example of the Admin Console dashboard for an application

[View a larger version of this image](/images/guides/kots/application.png)

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:

![Admin console dashboard with Cluster Management tab](/images/gitea-ec-ready.png)

[View a larger version of this image](/images/gitea-ec-ready.png)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

^ Added an example of the dashboard with a Cluster Management tab


### KOTS CLI

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

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

Expand Down
112 changes: 0 additions & 112 deletions docs/intro-replicated.md

This file was deleted.

Loading