Skip to content

Commit 0f79951

Browse files
authored
Merge pull request #2720 from replicatedhq/kurl-air-gap-edit
Edit HA mode info in kurl install docs
2 parents a72338a + 2c59d3c commit 0f79951

File tree

4 files changed

+13
-21
lines changed

4 files changed

+13
-21
lines changed

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/partials/install/_embedded-ha-step.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
(High Availability Only) If you did not preconfigure a load balancer, you are prompted during the installation. Do one of the following:
1+
(HA Installation Only) If you are installing in HA mode and did not already preconfigure a load balancer, you are prompted during the installation. Do one of the following:
22

33
- If you are using the internal load balancer, leave the prompt blank and proceed with the installation.
44

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
1-
- If you are installing in high availability mode:
2-
- (Optional) If you are going to use the internal load balancer, you can preconfigure it by passing `| sudo bash -s ha ekco-enable-internal-load-balancer`.
3-
- For an external load balancer, ensure that your load balancer is:
4-
- A TCP forwarding external load balancer.
5-
- Configured to distribute traffic to all healthy control plane nodes in its target list.
6-
- (Optional) Preconfigured by passing the `load-balancer-address=HOST:PORT` flag.
1+
- If you are installing in high availability (HA) mode, a load balancer is required. You can use the kURL internal load balancer if the [Embedded kURL Cluster Operator (EKCO) Add-On](https://kurl.sh/docs/add-ons/ekco) is included in the kURL Installer spec. Or, you can bring your own external load balancer. An external load balancer might be preferred when clients outside the cluster need access to the cluster's Kubernetes API.
2+
3+
To install in HA mode, complete the following prerequisites:
4+
- (Optional) If you are going to use the internal EKCO load balancer, you can preconfigure it by passing `| sudo bash -s ha ekco-enable-internal-load-balancer` with the kURL install command. Otherwise, you are prompted for load balancer details during installation. For more information about the EKCO Add-on, see [EKCO Add-On](https://kurl.sh/docs/add-ons/ekco) in the open source kURL documentation.
5+
- To use an external load balancer, ensure that the load balancer meets the following requirements:
6+
- Must be a TCP forwarding load balancer
7+
- Must be configured to distribute traffic to all healthy control plane nodes in its target list
8+
- The health check must be a TCP check on port 6443
9+
10+
For more information about how to create a load balancer for kube-apirserver, see [Create load balancer for kube-apiserver](https://kubernetes.io/docs/setup/production-environment/tools/kubeadm/high-availability/#create-load-balancer-for-kube-apiserver) in the Kubernetes documentation.
11+
12+
You can optionally preconfigure the external loader by passing the `load-balancer-address=HOST:PORT` flag with the kURL install command. Otherwise, you are prompted to provide the load balancer address during installation.

0 commit comments

Comments
 (0)