Skip to content

Commit e4177ce

Browse files
committed
add overview info
1 parent 3b92c3b commit e4177ce

File tree

4 files changed

+38
-59
lines changed

4 files changed

+38
-59
lines changed

docs/enterprise/embedded-manage-nodes.mdx

Lines changed: 7 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -1,76 +1,27 @@
1+
import JoinNode from "../partials/embedded-cluster/_add-nodes.mdx"
2+
import JoinNodeAirGap from "../partials/embedded-cluster/_add-nodes-air-gap.mdx"
3+
14
# Adding and Managing Nodes with Embedded Cluster
25

36
The topic describes managing nodes in clusters created with Replicated Embedded Cluster, including how to add or reset nodes and enable high-availability for multi-node clusters.
47

58
## Add Nodes (Beta) {#add-nodes}
69

7-
You can add nodes and create a multi-node cluster. When adding nodes, you select one or more roles for that node, depending on which roles are defined in the Embedded Cluster config. The Admin Console provides the join command you use to join nodes to the cluster.
10+
You can add nodes and create a multi-node cluster. When adding nodes, you select one or more roles for that node, depending on which roles are defined in the Embedded Cluster Config. The Admin Console provides the join command you use to join nodes to the cluster.
811

912
For more information about defining node roles, see [Roles](/reference/embedded-config#roles) in _Embedded Cluster Config_.
1013

1114
To add nodes to a cluster:
1215

13-
1. In the Admin Console, click **Cluster Management** at the top.
14-
15-
When initially installing the application, you are brought to this page automatically after logging into the Admin Console.
16-
17-
1. Click **Add node**.
18-
19-
1. In the **Add a Node** dialog, select one or more roles for this node. If no custom roles are defined, the role selection will not appear and only the join command will show.
20-
21-
<img alt="Add node page in the Admin Console" src="/images/admin-console-add-node.png" width="600px"/>
22-
23-
[View a larger version of this image](/images/admin-console-add-node.png)
24-
25-
1. Copy the provided join command.
26-
27-
**Example:**
28-
29-
```
30-
sudo ./APP_SLUG join 10.128.0.43:30000 bM8DO3MNvkouz9TFK3TcFanI
31-
```
32-
33-
1. SSH onto the machine you want to join to the cluster.
34-
35-
:::important
36-
You must join nodes with the same installer that you used for the first node. If you use a different installer from a different release of your application, the cluster will not be stable.
37-
:::
38-
39-
1. Run the join command on the node.
40-
41-
1. In the Admin Console, on the **Cluster Management** page, verify that the node appears. Wait for the node's status to change to Ready.
42-
43-
1. Repeat the process for as many nodes as you would like to add.
16+
<JoinNode/>
4417

4518
## Add Nodes to Air Gap Clusters (Beta) {#add-nodes-air-gap}
4619

4720
You can add nodes to an air gap cluster. This involves downloading the Embedded Cluster assets to each node, copying a join command from the Admin Console, and running the join command on each node.
4821

49-
### Prerequisite
50-
51-
The Embedded Cluster binary and the air gap bundle must be present on each node you want to join to the cluster. Use the same commands as you did during installation to download and untar these assets on each node. For more information, see [Install](#install) above.
52-
53-
:::note
54-
The binary and air gap bundles on each additional node must be the same version as what is currently installed. To download a specific version of these assets, you can select a version in the **Embedded Cluster install instructions** dialog. For more information, see [Install](#install) above.
55-
:::
56-
57-
### Procedure
58-
5922
To add nodes to an air gap cluster after successfully installing the first node:
6023

61-
1. In the Admin Console, click **Cluster Management** at the top.
62-
63-
When initially installing an application, you are brought to this page automatically after logging into the Admin Console.
64-
65-
1. Click **Add node**, choose one or more node roles (if present), and copy the join command.
66-
67-
1. SSH onto another machine you want to join to the cluster. Run the air gap join command on the node.
68-
69-
**For example:**
70-
71-
```bash
72-
sudo ./APP_SLUG join --airgap-bundle APP_SLUG.airgap 10.128.0.32:30000 TxXboDstBAamXaPdleSK7Lid
73-
```
24+
<JoinNodeAirGap/>
7425

7526
## Enable High Availability for Multi-Node Clusters (Alpha) {#ha}
7627

@@ -124,7 +75,7 @@ When resetting a node, OpenEBS PVCs on the node are deleted. Only PVCs created a
12475

12576
To reset a node:
12677

127-
1. SSH onto the machine. Ensure that the Embedded Cluster binary is still available on that machine. For more information about downloading Embedded Cluster installation assets, see [Online Installation with Embedded Cluster](/enterprise/installing-embedded).
78+
1. SSH onto the machine. Ensure that the Embedded Cluster binary is still available on that machine.
12879

12980
1. Run the reset command to reset the node. The `--reboot` flag automatically reboots the machine to ensure that transient configuration is also reset.
13081

docs/partials/embedded-cluster/_add-nodes-air-gap.mdx

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,22 @@
22

33
1. In the Admin Console, click **Cluster Management** at the top.
44

5-
1. Click **Add node**, choose one or more node roles (if present), and copy the join command.
5+
1. Click **Add node**.
6+
7+
1. In the **Add a Node** dialog, select one or more roles for the new node that you will join. If no custom roles are defined, the role selection will not appear and only the join command is displayed.
8+
9+
<img alt="Add node page in the Admin Console" src="/images/admin-console-add-node.png" width="600px"/>
10+
11+
[View a larger version of this image](/images/admin-console-add-node.png)
12+
13+
1. Copy the join command.
614

715
1. SSH onto the machine you want to join to the cluster.
816

917
1. On the machine, download and untar the Embedded Cluster installation assets (including the Embedded Cluster binary and air gap bundle). You can use the same `curl` command that you ran during installation to download the assets.
1018

1119
:::note
12-
The binary and air gap bundles on each node must be the same Embedded Cluster version as what is installed in the cluster. To download a specific version of these assets, you can select a version in the **Embedded Cluster install instructions** dialog.
20+
The Embedded Cluster binary and air gap bundles on each node must all be the same version. To download a specific version of these assets, you can select a version in the **Embedded Cluster install instructions** dialog.
1321
:::
1422

1523
1. Run the air gap join command that you copied.

docs/partials/embedded-cluster/_add-nodes.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
1. On the machine, download and untar the Embedded Cluster installation assets. You can use the same `curl` command that you ran during installation to download the assets.
1818

1919
:::note
20-
The binary on each node must be the same Embedded Cluster version as what is installed in the cluster. To download a specific version of these assets, you can select a version in the **Embedded Cluster install instructions** dialog.
20+
The Embedded Cluster binary on each node must be the same version as what is installed in the cluster. To download a specific version of these assets, you can select a version in the **Embedded Cluster install instructions** dialog.
2121
:::
2222

2323
1. Run the join command that you copied.

docs/vendor/embedded-overview.mdx

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -164,6 +164,26 @@ When you skip host preflight checks, the Admin Console still runs any applicatio
164164
Skipping host preflight checks is _not_ recommended for production installations.
165165
:::
166166

167+
## About Managing Nodes with Embedded Cluster
168+
169+
This section describes managing nodes in clusters created with Embedded Cluster.
170+
171+
### Managing Nodes
172+
173+
Users can add and manage nodes with Embedded Cluster from the Admin Console.
174+
175+
For more information, see [Adding and Managing Nodes with Embedded Cluster](/enterprise/embedded-manage-nodes).
176+
177+
### High Availability for Multi-Node Clusters (Alpha)
178+
179+
Multi-node clusters are not highly available by default. After three controller nodes are present in the cluster, high availability (HA) can be enabled.
180+
181+
For more information about creating HA multi-node clusters with Embedded Cluster, see [Enable High Availability for Multi-Node Clusters (Alpha)](/enterprise/embedded-manage-nodes#ha) in _Adding and Managing Nodes with Embedded Cluster_.
182+
183+
### Defining Custom Node Roles
184+
185+
You can define custom node roles in the Embedded Cluster Config to support installations in multi-node clusters.
186+
167187
## (Optional) Serve Installation Assets Using the Vendor API
168188

169189
To install with Embedded Cluster, you need to download the Embedded Cluster installer binary and a license. Air gap installations also require an air gap bundle. Some vendors already have a portal where their customers can log in to access documentation or download artifacts. In cases like this, you can serve the Embedded Cluster installation essets yourself using the Replicated Vendor API, rather than having customers download the assets from the Replicated app service using a curl command during installation.

0 commit comments

Comments
 (0)