Skip to content

Edit HA mode info in kurl install docs #2720

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.

Sign up for GitHub

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

Merged
merged 4 commits into from
Oct 4, 2024
Merged

Edit HA mode info in kurl install docs #2720

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8a5ab43
Edit HA mode info in kurl install docs
paigecalvert Oct 3, 2024
1cd3870
edit HA prereq
paigecalvert Oct 4, 2024
becacfa
edits
paigecalvert Oct 4, 2024
2c59d3c
edits
paigecalvert Oct 4, 2024
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
7 changes: 0 additions & 7 deletions docs/enterprise/installing-kurl-airgap.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
import KurlAbout from "../partials/install/_kurl-about.mdx"
import HaLoadBalancerAbout from "../partials/install/_ha-load-balancer-about.mdx"
import IntroEmbedded from "../partials/install/_intro-embedded.mdx"
import IntroAirGap from "../partials/install/_intro-air-gap.mdx"
import PrereqsEmbeddedCluster from "../partials/install/_prereqs-embedded-cluster.mdx"
Expand All @@ -18,12 +17,6 @@ import ExtractKurlBundle from "../partials/install/_extract-kurl-bundle.mdx"

<KurlAbout/>

## About High Availability Mode

Air gap installations can use high availability (HA) mode with the kURL installer.

<HaLoadBalancerAbout/>

## Prerequisites

Complete the following prerequisites:
Expand Down
7 changes: 0 additions & 7 deletions docs/enterprise/installing-kurl.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
import KurlAbout from "../partials/install/_kurl-about.mdx"
import HaLoadBalancerAbout from "../partials/install/_ha-load-balancer-about.mdx"
import IntroEmbedded from "../partials/install/_intro-embedded.mdx"
import PrereqsEmbeddedCluster from "../partials/install/_prereqs-embedded-cluster.mdx"
import HaLoadBalancerPrereq from "../partials/install/_ha-load-balancer-prereq.mdx"
Expand All @@ -14,12 +13,6 @@ import AppNameUI from "../partials/install/_placeholder-app-name-UI.mdx"

<KurlAbout/>

## About High Availability Mode

Online installations can use high availability (HA) mode with the kURL installer.

<HaLoadBalancerAbout/>

## Prerequisites

Complete the following prerequisites:
Expand Down
2 changes: 1 addition & 1 deletion docs/partials/install/_embedded-ha-step.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
(High Availability Only) If you did not preconfigure a load balancer, you are prompted during the installation. Do one of the following:
(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:

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

Expand Down
18 changes: 12 additions & 6 deletions docs/partials/install/_ha-load-balancer-prereq.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
- If you are installing in high availability mode:
- (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`.
- For an external load balancer, ensure that your load balancer is:
- A TCP forwarding external load balancer.
- Configured to distribute traffic to all healthy control plane nodes in its target list.
- (Optional) Preconfigured by passing the `load-balancer-address=HOST:PORT` flag.
- 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.

To install in HA mode, complete the following prerequisites:
- (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.
- To use an external load balancer, ensure that the load balancer meets the following requirements:
- Must be a TCP forwarding load balancer
- Must be configured to distribute traffic to all healthy control plane nodes in its target list
- The health check must be a TCP check on port 6443

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.

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.