Skip to content

Commit 4fddbb5

Browse files
authored
Merge branch 'main' into 112484
2 parents e05b449 + 15be48e commit 4fddbb5

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+2300
-2912
lines changed

docs/enterprise/installing-embedded-air-gap.mdx

Lines changed: 5 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,6 @@ import Prerequisites from "../partials/install/_ec-prereqs.mdx"
88

99
This topic describes how to install applications with Embedded Cluster on a virtual machine (VM) or bare metal server with no outbound internet access.
1010

11-
:::note
12-
Embedded Cluster installations in air gap environments is a beta feature. This feature is subject to change. To get access to this feature, reach out to Alex Parker at [[email protected]](mailto:[email protected]).
13-
:::
14-
1511
## Overview
1612

1713
When an air gap bundle is built for a release containing an Embedded Cluster Config, both an application air gap bundle and an Embedded Cluster air gap bundle are built. The application air gap bundle can be used for air gap installations with Replicated kURL or with Replicated KOTS in an existing cluster. The Embedded Cluster air gap bundle is used for air gap installations with Embedded Cluster.
@@ -62,23 +58,17 @@ To install with Embedded Cluster in an air gap environment:
6258

6359
[View a larger version of this image](/images/customer-install-instructions-dropdown.png)
6460

65-
The **Embedded Cluster install instructions** dialog is displayed.
61+
1. In the **Embedded Cluster install instructions** dialog, enable the **Install in an air gap environment** checkbox.
6662

67-
<img alt="Embedded cluster install instruction dialog" src="/images/embedded-cluster-install-dialog.png" width="500px"/>
63+
<img alt="Embedded cluster install instruction dialog" src="/images/embedded-cluster-install-dialog-airgap.png" width="500px"/>
6864

69-
[View a larger version of this image](/images/embedded-cluster-install-dialog.png)
65+
[View a larger version of this image](/images/embedded-cluster-install-dialog-airgap.png)
7066

71-
1. (Optional) In the **Embedded Cluster install instructions** dialog, under **Select a version**, select a specific application version to install. By default, the latest version is selected.
67+
1. (Optional) For **Select a version**, select a specific application version to install. By default, the latest version is selected.
7268

7369
1. SSH onto the machine where you will install.
7470

75-
1. Modify the curl command provided in the first step in the **Embedded Cluster installation instructions** dialog by adding the `?airgap=true` query parameter to the end of the `replicated.app` endpoint:
76-
77-
```bash
78-
curl -f https://replicated.app/embedded/APP_SLUG/CHANNEL_SLUG?airgap=true -H "Authorization: LICENSE_ID" -o APP_SLUG-CHANNEL_SLUG.tgz
79-
```
80-
81-
1. On a machine with internet access, run the modified curl command to download the air gap installation assets as a `.tgz`.
71+
1. On a machine with internet access, run the curl command to download the air gap installation assets as a `.tgz`.
8272

8373
1. Move the downloaded `.tgz` to the air gapped machine where you will install.
8474

docs/enterprise/installing-embedded.mdx

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ Before you install, complete the following prerequisites:
1010

1111
<Prerequisites/>
1212

13+
* Ensure that the required domains are accessible from servers performing the installation. See [Firewall Openings for Online Installations](/enterprise/installing-general-requirements#firewall-openings-for-online-installations).
14+
1315
## Install
1416

1517
To install an application with Embedded Cluster:
@@ -188,4 +190,22 @@ sudo ./my-app install --license license.yaml --pod-cidr 172.16.136.0/16
188190

189191
#### Limitation
190192

191-
The `--pod-cidr` and `--service-cidr` flags are not supported on Red Hat Enterprise Linux (RHEL) 9 operating systems.
193+
The `--pod-cidr` and `--service-cidr` flags are not supported on Red Hat Enterprise Linux (RHEL) 9 operating systems.
194+
195+
## Change Admin Console and LAM Ports {#adm-lam-ports}
196+
197+
By default, the Admin Console and Local Artifact Mirror (LAM) run on ports 30000 and 50000, respectively. If these ports are occupied, you can select different ports.
198+
199+
To choose different ports for the Admin Console and LAM during installation with Embedded Cluster, use the `--admin-console-port` and `--local-artifact-mirror-port` flags with the Embedded Cluster `install` command.
200+
201+
For example:
202+
203+
```bash
204+
install --admin-console-port=20000 --local-artifact-mirror-port=40000
205+
```
206+
207+
The Embedded Cluster host preflight checks verify the default ports or the user-supplied ports, so users will be alerted before installation if they need to choose new port(s). For more information about the host preflight checks for Embedded Cluster, see [About Host Preflight Checks](/vendor/embedded-overview#about-host-preflight-checks).
208+
209+
### Limitation
210+
211+
It is not possible to change the port for the Admin Console during a restore with Embedded Cluster. For more information, see [Disaster Recovery for Embedded Cluster (Alpha)](/vendor/embedded-disaster-recovery).

docs/enterprise/installing-existing-cluster-automation.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ One common use case for installing with the CLI is to automate installation, suc
4141

4242
For more information about the advanced options for the `kots install` command, see [install](/reference/kots-cli-install) in the KOTS CLI documentation.
4343

44-
For a tutorial that demonstrates how to install a sample application using the KOTS CLI, see [KOTS Tutorial (CLI)](/vendor/tutorial-cli-setup).
44+
For a tutorial that demonstrates how to install a sample application using the KOTS CLI, see [Install with KOTS in an Existing Cluster](/vendor/tutorial-cli-setup).
4545

4646
## Limitation
4747

docs/enterprise/installing-general-requirements.mdx

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ import DockerCompatibility from "../partials/image-registry/_docker-compatibilit
22
import KubernetesCompatibility from "../partials/install/_kubernetes-compatibility.mdx"
33
import EmbeddedClusterRequirements from "../partials/embedded-cluster/_requirements.mdx"
44
import EmbeddedClusterStorageReqs from "../partials/embedded-cluster/_storage-reqs.mdx"
5+
import EmbeddedClusterPortRequirements from "../partials/embedded-cluster/_port-reqs.mdx"
56

67
# Installation Requirements
78

@@ -262,6 +263,10 @@ To install with the Embedded Cluster installer, your environment must meet the f
262263

263264
<EmbeddedClusterStorageReqs/>
264265

266+
### Port Requirements
267+
268+
<EmbeddedClusterPortRequirements/>
269+
265270
## kURL Requirements {#kurl-requirements}
266271

267272
To install with kURL, your environment must meet the following requirements.

docs/enterprise/installing-kurl-airgap.mdx

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
import KurlAbout from "../partials/install/_kurl-about.mdx"
2-
import HaLoadBalancerAbout from "../partials/install/_ha-load-balancer-about.mdx"
32
import IntroEmbedded from "../partials/install/_intro-embedded.mdx"
43
import IntroAirGap from "../partials/install/_intro-air-gap.mdx"
54
import PrereqsEmbeddedCluster from "../partials/install/_prereqs-embedded-cluster.mdx"
@@ -18,12 +17,6 @@ import ExtractKurlBundle from "../partials/install/_extract-kurl-bundle.mdx"
1817

1918
<KurlAbout/>
2019

21-
## About High Availability Mode
22-
23-
Air gap installations can use high availability (HA) mode with the kURL installer.
24-
25-
<HaLoadBalancerAbout/>
26-
2720
## Prerequisites
2821

2922
Complete the following prerequisites:

docs/enterprise/installing-kurl.mdx

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
import KurlAbout from "../partials/install/_kurl-about.mdx"
2-
import HaLoadBalancerAbout from "../partials/install/_ha-load-balancer-about.mdx"
32
import IntroEmbedded from "../partials/install/_intro-embedded.mdx"
43
import PrereqsEmbeddedCluster from "../partials/install/_prereqs-embedded-cluster.mdx"
54
import HaLoadBalancerPrereq from "../partials/install/_ha-load-balancer-prereq.mdx"
@@ -14,12 +13,6 @@ import AppNameUI from "../partials/install/_placeholder-app-name-UI.mdx"
1413

1514
<KurlAbout/>
1615

17-
## About High Availability Mode
18-
19-
Online installations can use high availability (HA) mode with the kURL installer.
20-
21-
<HaLoadBalancerAbout/>
22-
2316
## Prerequisites
2417

2518
Complete the following prerequisites:

docs/enterprise/updating-apps.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ To configure automatic updates:
3434

3535
To turn off automatic updates, select **Never**.
3636

37-
To define a custom cadence, select **Custom**, then enter a cron expression in the text field. For more information about cron expressions, see [Cron Expressions](/reference/cron-expressions) in _Reference_. Configured automatic update checks use the local server time.
37+
To define a custom cadence, select **Custom**, then enter a cron expression in the text field. For more information about cron expressions, see [Cron Expressions](/reference/cron-expressions). Configured automatic update checks use the local server time.
3838

3939
![Configure automatic updates](/images/automatic-updates-config.png)
4040

docs/enterprise/updating-embedded.mdx

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import Overview from "../partials/embedded-cluster/_update-overview.mdx"
99
This topic describes how to perform updates for [Replicated Embedded Cluster](/vendor/embedded-overview) installations.
1010

1111
:::note
12-
Embedded cluster is in beta. If you are instead looking for information about Replicated kURL, see [Performing Updates in kURL Clusters](updating-kurl).
12+
If you are instead looking for information about Replicated kURL, see [Performing Updates in kURL Clusters](updating-kurl).
1313
:::
1414

1515
## Overview
@@ -68,11 +68,7 @@ To perform an update with Embedded Cluster:
6868
KOTS can experience downtime during an update, such as in single-node installations. If downtime occurs, refreshing the page results in a connection error. Users can refresh the page again after the update is complete to access the Admin Console.
6969
:::
7070

71-
## Update in Air Gap Clusters (Alpha)
72-
73-
:::important
74-
Embedded Cluster installations in air gap environments in an Alpha feature. This feature is subject to change, including breaking changes. To get access to this feature, reach out to Alex Parker at [[email protected]](mailto:[email protected]).
75-
:::
71+
## Update in Air Gap Clusters
7672

7773
<DoNotDowngrade/>
7874

docs/enterprise/updating-kurl.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ import AdminConsoleAirGap from "../partials/updating/_admin-console-air-gap.mdx"
77

88
This topic describes how to perform updates in Replicated kURL installations. It includes procedures for updating an application, as well as for updating the versions of Kubernetes, Replicated KOTS, and add-ons in a kURL cluster.
99

10+
For more information about managing nodes in kURL clusters, including how to safely reset, reboot, and remove nodes when performing maintenance tasks, see [Managing Nodes](https://kurl.sh/docs/install-with-kurl/managing-nodes) in the open source kURL documentation.
11+
1012
## Update an Application
1113

1214
For kURL installations, you can update an application from the Admin Console. You can also set up automatic updates. See [Configuring Automatic Updates](/enterprise/updating-apps).
@@ -23,6 +25,8 @@ For kURL installations, you can update an application from the Admin Console. Yo
2325

2426
After updating the kURL installer spec, you can rerun the kURL installation script to update a kURL cluster. For more information about kURL cluster udpates, see [About kURL Cluster Updates](/enterprise/updating-kurl-about).
2527

28+
For more information about managing nodes in kURL clusters, including how to safely reset, reboot, and remove nodes when performing maintenance tasks, see [Managing Nodes](https://kurl.sh/docs/install-with-kurl/managing-nodes) in the open source kURL documentation.
29+
2630
:::important
2731
The Kubernetes scheduler automatically reschedules Pods to other nodes during maintenance. Any deployments or StatefulSets with a single replica experience downtime while being rescheduled.
2832
:::

docs/intro.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ pagination_next: null
4646
<a href="intro-replicated">Introduction to Replicated</a>
4747
</li>
4848
<li>
49-
<a href="/vendor/distributing-overview">About Distributing Applications with Replicated</a>
49+
<a href="/vendor/kots-faq">Replicated FAQs</a>
5050
</li>
5151
<li>
5252
<a href="/vendor/replicated-onboarding">Replicated Quick Start</a>
@@ -141,9 +141,6 @@ pagination_next: null
141141
<li>
142142
<a href="intro-kots">Introduction to KOTS</a>
143143
</li>
144-
<li>
145-
<a href="/vendor/kots-faq">KOTS Terminology and FAQs</a>
146-
</li>
147144
<li>
148145
<a href="/vendor/distributing-workflow">Onboarding with KOTS</a>
149146
</li>

0 commit comments

Comments
 (0)