Skip to content

Commit 6fb43af

Browse files
committed
add ha arch to partial
1 parent b30aa80 commit 6fb43af

File tree

3 files changed

+21
-13
lines changed

3 files changed

+21
-13
lines changed

docs/enterprise/embedded-manage-nodes.mdx

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
import HaArchitecture from "../partials/embedded-cluster/_multi-node-ha-arch.mdx"
2+
13
# Managing Multi-Node Clusters with Embedded Cluster
24

35
The topic describes managing nodes in clusters created with Replicated Embedded Cluster, including how to add nodes and enable high-availability for multi-node clusters.
@@ -87,6 +89,12 @@ Multi-node clusters are not highly available by default. The first node of the c
8789
High availability for Embedded Cluster 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]).
8890
:::
8991

92+
### HA Architecture
93+
94+
<HaArchitecture/>
95+
96+
For more information about the Embedded Cluster built-in extensions, see [Built-In Extensions](/vendor/embedded-overview#built-in-extensions) in _Embedded Cluster Overview_.
97+
9098
### Requirements
9199

92100
Enabling high availability has the following requirements:
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
The following diagram shows the architecture of an HA multi-node Embedded Cluster installation:
2+
3+
![Embedded Cluster multi-node architecture](/images/embedded-architecture-multi-node-ha.png)
4+
5+
[View a larger version of this image](/images/embedded-architecture-multi-node-ha.png)
6+
7+
In HA multi-node installations, the Embedded Cluster Operator and the KOTS Admin Console are installed on the primary node only. All other built-in extenions, including the image registry for air gap installations, are installed on each node in the cluster. Any Helm [`extensions`](/reference/embedded-config#extensions) that you include in the Embedded Cluster Config can optionally be installed on one or more nodes.
8+
9+
Additionally, three replicas of rqlite are deployed for HA. Rqlite is used by KOTS to store information such as support bundles, version history, application metadata, and other small amounts of data needed to manage the application.

docs/vendor/embedded-overview.mdx

Lines changed: 4 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
import EmbeddedCluster from "../partials/embedded-cluster/_definition.mdx"
22
import Requirements from "../partials/embedded-cluster/_requirements.mdx"
33
import EmbeddedClusterPortRequirements from "../partials/embedded-cluster/_port-reqs.mdx"
4+
import HaArchitecture from "../partials/embedded-cluster/_multi-node-ha-arch.mdx"
45

56
# Embedded Cluster Overview
67

@@ -44,29 +45,19 @@ The following diagram shows the architecture of a multi-node Embedded Cluster in
4445

4546
[View a larger version of this image](/images/embedded-architecture-multi-node.png)
4647

47-
As shown in the diagram above, in multi-node installations, the Embedded Cluster Operator, KOTS (including rqlite), and the image registry for air gap installations are all installed on the primary node only.
48+
As shown in the diagram above, in multi-node installations, the Embedded Cluster Operator, KOTS, and the image registry for air gap installations are all installed on the primary node only.
4849

4950
For installations that include disaster recovery with Velero, the Velero Node Agent runs on each node in the cluster. The Node Agent is a Kubernetes DaemonSet that performs backup and restore tasks such as creating snapshots and transferring data during restores.
5051

51-
Any Helm [`extensions`](/reference/embedded-config#extensions) included in the Embedded Cluster Config can be installed on one or more nodes.
52+
Additionally, any Helm [`extensions`](/reference/embedded-config#extensions) that you include in the Embedded Cluster Config can optionally be installed on one or more nodes.
5253

5354
### Multi-Node Architecture with High Availability
5455

5556
:::note
5657
High availability (HA) for multi-node installations with Embedded Cluster is Alpha and is not enabled by default. For more informaiton about enabling HA, see [Enable High Availability for Multi-Node Clusters (Alpha)](/enterprise/embedded-manage-nodes#ha).
5758
:::
5859

59-
The following diagram shows the architecture of an HA multi-node Embedded Cluster installation:
60-
61-
![Embedded Cluster multi-node architecture](/images/embedded-architecture-multi-node-ha.png)
62-
63-
[View a larger version of this image](/images/embedded-architecture-multi-node-ha.png)
64-
65-
In HA multi-node installations, the Embedded Cluster Operator and the KOTS Admin Console are installed on the primary node only. All other built-in extenions, including the image registry for air gap installations, are installed on each node in the cluster.
66-
67-
Additionally, three replicas of rqlite are deployed for HA. Rqlite is used by KOTS to store information such as support bundles, version history, application metadata, and other small amounts of data needed to manage the application.
68-
69-
For installations that include disaster recovery with Velero, the Velero Node Agent runs on each node in the cluster. The Node Agent is a Kubernetes DaemonSet that performs backup and restore tasks such as creating snapshots and transferring data during restores.
60+
<HaArchitecture/>
7061

7162
## Built-In Extensions {#built-in-extensions}
7263

0 commit comments

Comments
 (0)