Skip to content

Commit 11673ad

Browse files
committed
update kots install overview
1 parent fd3ddb9 commit 11673ad

File tree

1 file changed

+14
-32
lines changed

1 file changed

+14
-32
lines changed
Lines changed: 14 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,59 +1,41 @@
1-
# About Installing an Application
1+
# Considerations Before Installing
22

3-
This topic provides an introduction to installing with Replicated KOTS, including options to consider before installing.
3+
Before you install an application with KOTS in an existing cluster, consider the following installation options.
44

5-
## Overview
6-
7-
You can use Replicated KOTS to install applications into various environments, with or without existing Kubernetes clusters. The installation options include online and air gapped clusters, and support managed offerings such as EKS, GKE, AKS, and more.
8-
9-
## Considerations Before Installing
10-
11-
Before you install an application, consider the following installation options.
12-
13-
### Installations With or Without an Existing Cluster
14-
15-
With KOTS, you can install an application in one of two ways:
16-
* **With an existing cluster**: You can install an application in an existing Kubernetes cluster that meets the system requirements. For more information, see [Existing Cluster Requirements](installing-general-requirements#existing-cluster-requirements) in _Installation Requirements_.
17-
* **Without an existing cluster**: If you do not have an existing Kubernetes cluster, you can install in a virtual machine or a bare metal server. For more information, see [kURL Requirements](installing-general-requirements#kurl-requirements) in _Installation Requirements_.
18-
19-
Most software vendors support both options and require the customer to determine their preferred method of deployment.
20-
21-
### Internet-Connected or Air Gap Installations
5+
## Online (Internet-Connected) or Air Gap Installations
226

237
Most Kubernetes clusters are able to make outbound internet requests. Inbound access is never recommended or required.
248
As such, most cluster operators are able to perform an online installation.
259

2610
If the target cluster does not have outbound internet access, the application can also be delivered through an air gap installation.
2711

28-
To install an application in an air gapped environment, the cluster must have access to an image registry. In this case, KOTS re-tags and pushes all images to the target registry. KOTS supports installations in air gapped environments on both existing clusters and on clusters created by the kURL installer.
12+
To install an application in an air-gapped environment, the cluster must have access to an image registry. In this case, KOTS re-tags and pushes all images to the target registry.
2913

30-
For information about installing in air gapped environments:
31-
* **Existing clusters**: See [Air Gap Installation in Existing Clusters](installing-existing-cluster-airgapped)
32-
* **Embedded clusters with kURL**: See [Air Gap Installation with kURL](installing-kurl-airgap)
14+
For information about installing with KOTS in air-gapped environments, see [Air Gap Installation in Existing Clusters](installing-existing-cluster-airgapped).
3315

34-
### Existing Cluster Installations into Hardened Environments
16+
## Hardened Environments
3517

36-
By default, KOTS Pods and containers are not deployed with a specific security context. For existing cluster installations into a hardened environment, you can use the `--strict-security-context` flag with the installation command so that KOTS runs with a strict security context for Pods and containers.
18+
By default, KOTS Pods and containers are not deployed with a specific security context. For installations into a hardened environment, you can use the `--strict-security-context` flag with the installation command so that KOTS runs with a strict security context for Pods and containers.
3719

3820
For more information about the security context enabled by the `--strict-security-context` flag, see [kots install](/reference/kots-cli-install).
3921

40-
### Local Image Registries
22+
## Configuring Local Image Registries
4123

4224
During install, KOTS can re-tag and push images to a local image registry.
4325
This is useful to enable CVE scans, image policy validation, and other pre-deployment rules. A private image registry is required for air gapped environments, and is optional for online environments.
4426

4527
For information about image registry requirements, see [Private Registry Requirements](installing-general-requirements#private-registry-requirements).
4628

47-
### Automated Installation
29+
## Automated (Headless) Installation
4830

49-
You can automate application installation in online, air gap, existing cluster, and embedded cluster environments using the KOTS CLI. In an automated installation, you provide all the information required to install and deploy the application with the `kots install` command, rather than providing this information in the Replicated Admin Console.
31+
You can automate application installation in online and air-gapped environments using the KOTS CLI. In an automated installation, you provide all the information required to install and deploy the application with the `kots install` command, rather than providing this information in the Replicated Admin Console.
5032

51-
For more information, see [Installing from the Command Line](/enterprise/installing-existing-cluster-automation).
33+
For more information, see [Installing with the CLI](/enterprise/installing-existing-cluster-automation).
5234

53-
### KOTS Installations Without Object Storage
35+
## KOTS Installations Without Object Storage
5436

55-
The Replicated Admin Console requires persistent storage for state. For existing cluster installations, KOTS deploys MinIO for object storage by default. For embedded cluster installations with Replicated kURL, the object storage provider is either MinIO or Rook, depending on which add-on your software vendor included in the kURL installer specification.
37+
The KOTS Admin Console requires persistent storage for state. KOTS deploys MinIO for object storage by default.
5638

57-
You can optionally install KOTS without object storage. When installed without object storage, KOTS deploys the Admin Console as a Statefulset with an attached PersistentVolume (PV) instead of as a deployment.
39+
You can optionally install KOTS without object storage. When installed without object storage, KOTS deploys the Admin Console as a StatefulSet with an attached PersistentVolume (PV) instead of as a deployment.
5840

5941
For more information about how to install KOTS without object storage, see [Installing Without Object Storage](/enterprise/installing-stateful-component-requirements).

0 commit comments

Comments
 (0)