-
Notifications
You must be signed in to change notification settings - Fork 37
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.
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
docs: multi-node airgap documentation #4281
Changes from 12 commits
6ed8f21
af4a124
1b66044
dda9d55
8f38905
f398edf
b8483de
d39dc7a
97fe239
c27e18f
4f02940
e727c33
2427bd7
3d83075
a3a0ac7
3a6da05
a9164b7
bbb81b3
dc0d321
9e44fa5
2fe9917
240cc37
c3cd92b
95f09ed
14ae2e7
b90dfc3
26605ec
7b2a945
fde6052
37a2221
4436426
1d94f1d
e873b0e
91aba6b
1d71bcf
baec566
4e7622a
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
--- | ||
sidebar_label: "Delete a Cluster" | ||
title: "Delete a Cluster" | ||
description: "Learn how to delete a cluster with Local UI." | ||
hide_table_of_contents: false | ||
sidebar_position: 90 | ||
tags: ["edge"] | ||
--- | ||
|
||
You can delete an active cluster using Local UI. Deleting a cluster will free up all the hosts in the cluster for new | ||
workloads. Deleting a cluster does not unlink the linked hosts. For more information about linking or unlinking hosts, | ||
lennessyy marked this conversation as resolved.
Show resolved
Hide resolved
|
||
refer to [Link Hosts](./link-hosts.md). | ||
|
||
## Prerequisites | ||
|
||
- Access to [Local UI](../host-management/access-console.md). Any Operating System (OS) user can be used to log in to | ||
lennessyy marked this conversation as resolved.
Show resolved
Hide resolved
|
||
Local UI. | ||
|
||
- An active cluster deployed and managed by Local UI. | ||
|
||
## Delete a Cluster | ||
|
||
1. Log in to [Local UI](../host-management/access-console.md) on the leader node where your cluster is deployed. | ||
|
||
2. From the left **Main Menu**, click **Cluster**. | ||
|
||
3. In the upper-right corner of the **Cluster** page, click **Actions**. | ||
|
||
4. In the **drop-down Menu** that appears, click **Delete**. | ||
|
||
5. In the pop-up window that appears, click **Confirm**. During the deletion of the cluster, Local UI will become | ||
unavailable as the nodes reboot after cluster deletion. | ||
|
||
## Validate | ||
|
||
1. Log in to [Local UI](../host-management/access-console.md) on the leader of the linked hosts. | ||
|
||
2. From the left **Main Menu**, click **Cluster**. | ||
|
||
3. Confirm that there is no active cluster and that the cluster has been deleted. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,157 @@ | ||
--- | ||
sidebar_label: "Link Hosts" | ||
title: "Link Hosts" | ||
description: "Instructions for linking hosts to prepare for multi-node cluster creation." | ||
hide_table_of_contents: false | ||
sidebar_position: 30 | ||
tags: ["edge"] | ||
--- | ||
|
||
To create a multi-node cluster with hosts provisioned in `airgap` installation mode, the hosts must first be able | ||
identify and securely communicate with each other. By default, hosts that are provisioned in `airgap` installation mode | ||
are not aware of each other even if they are on the same network, and they do not have the credentials to communicate | ||
with each other securely. | ||
|
||
Host linking provides the hosts with the necessary network and security infrastructure to form a cluster together. In a | ||
group of linked hosts, hosts can broadcast information to all its peers. Every group has a leader node, which provides | ||
tokens with its IP and a One-Time Password (OTP) credentials encrypted that you can use to link other nodes. | ||
|
||
Linked hosts will sync images for the Palette agent, provider images, cluster definitions, as well as host status with | ||
lennessyy marked this conversation as resolved.
Show resolved
Hide resolved
|
||
each other. In a group of linked hosts that have not formed a cluster, only the leader node has access to functionality | ||
such as change host settings, upload content, and create clusters. Once a cluster is created, only the control plane | ||
nodes have access to features such as cluster management and can change host settings. | ||
|
||
## Link Hosts | ||
|
||
### Limitations | ||
|
||
- All hosts must be deployed in the same deployment mode. For more information, refer to | ||
abhinavnagaraj marked this conversation as resolved.
Show resolved
Hide resolved
|
||
[Deployment Modes](../../../../deployment-modes/deployment-modes.md). | ||
|
||
- For hosts that are deployed in agent mode, all hosts must share the same Operating System (OS). | ||
|
||
### Prerequisites | ||
|
||
- Two or more hosts deployed in the same deployment mode on the same network. For more information, refer to | ||
[Appliance Mode Installation](../../site-deployment/stage.md) or | ||
[Agent Mode Installation](../../../../deployment-modes/agent-mode/install-agent-host.md). | ||
|
||
- All hosts must be idle. They cannot have any current cluster workloads, or are linked to another node. Refer to | ||
[Delete a Cluster](./delete-cluster.md) and [Unlink Hosts](#unlink-hosts) to learn how to delete a cluster and unlink | ||
a host to free it up for linking. | ||
|
||
### Procedure | ||
|
||
1. Decide on a node that you plan to use as the leader of the group. Log in to | ||
[Local UI](../host-management/access-console.md) of that node. The leader node may or may not already be in a | ||
lennessyy marked this conversation as resolved.
Show resolved
Hide resolved
|
||
cluster, but the follower nodes must be idle and cannot be in a cluster. | ||
|
||
2. From the left **Main Menu**, click **Linked Edge Hosts**. | ||
|
||
3. Click **Generate token**. This will generate a token you will use to link this host with other hosts. The token | ||
contains the encrypted IP address of the node, as well as an OTP that will expire in two minutes. | ||
lennessyy marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
4. Click the **Copy** button to copy the token. | ||
|
||
5. Log in to [Local UI](../host-management/access-console.md) on the node that you want to link to the leader node. | ||
|
||
6. From the left **Main Menu**, click **Linked Edge Hosts**. | ||
|
||
7. Click **Link this device to another**. | ||
|
||
8. In the pop-up box that appears, enter the token you coped from the leader node. | ||
lennessyy marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
9. Click confirm. | ||
|
||
10. Repeat this process for every node you want to link to the leader node. | ||
|
||
### Validate | ||
|
||
1. Log in to [Local UI](../host-management/access-console.md) on the leader node. | ||
|
||
2. From the left **Main Menu**, click **Linked Edge Hosts**. | ||
|
||
3. Confirm that all nodes you linked together show up in the **Linked Edge Hosts** table. | ||
|
||
## Unlink Hosts | ||
|
||
You can unlink a host to either link it to another host or to use it for independent workloads. You can only unlink a | ||
follower host. Leader hosts cannot be unlinked. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Leader hosts cannot be unlinked directly. When all followers are unlinked, the leader is automatically unlinked if its not "in-use"(not part of a single node cluster). |
||
|
||
You can unlink a follower host on the follower host itself or from the leader node. | ||
|
||
lennessyy marked this conversation as resolved.
Show resolved
Hide resolved
|
||
### Prerequisites | ||
|
||
- Two or more linked hosts. | ||
|
||
- [Access to Local UI](../host-management/access-console.md) on the host you want to unlink or on the leader host. | ||
|
||
### Procedure | ||
|
||
<Tabs> | ||
|
||
<TabItem value="From Leader Node"> | ||
|
||
1. Log in to Local UI on the leader node to which the node you want to unlink is paired. | ||
|
||
2. From the left **Main Menu**, click **Linked Edge Hosts**. | ||
|
||
3. In the list of linked nodes, identify the node you want to unlink and click the **three-dot button** next to the IP | ||
address of the node. | ||
|
||
4. Click **Unlink**. | ||
|
||
5. Click **Confirm** | ||
|
||
</TabItem> | ||
|
||
<TabItem value="On Follower Node"> | ||
|
||
1. Log in to Local UI on the node you want to unlink. | ||
|
||
2. From the left **Main Menu**, click **Linked Edge Hosts**. | ||
|
||
3. Click **Unlink** in the upper-right corner of the **Linked Edge Hosts** page. | ||
|
||
4. Click **Confirm** | ||
|
||
</TabItem> | ||
|
||
</Tabs> | ||
|
||
### Validate | ||
|
||
1. Log in to Local UI on the node you unlinked. | ||
|
||
2. From the left **Main Menu**, click **Linked Edge Hosts**. | ||
|
||
3. Confirm that the node has been unlinked from the leader and is ready to be paired with another node. | ||
|
||
## Remove Leader Node Status | ||
|
||
If you have made a host the leader of a group of linked hosts, but later want to link it to another leader node, you | ||
must first remove its leader node status. | ||
lennessyy marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
### Prerequisite | ||
|
||
- Access to Local UI on a host that generates pairing tokens. | ||
|
||
- The host is not linked with any other host. If your host is still linked with other hosts, you must unlink all its | ||
follower nodes. | ||
|
||
### Procedure | ||
|
||
1. Log in to Local UI. | ||
|
||
2. From the left **Main Menu**, click **Linked Edge Hosts**. | ||
|
||
3. Click the red **Stop token generation** button to stop the host from generating pairing tokens. This will make it | ||
ready to be paired with other nodes again as a follower. | ||
|
||
### Validate | ||
|
||
1. Log in to Local UI. | ||
|
||
2. From the left **Main Menu**, click **Linked Edge Hosts**. | ||
|
||
3. Confirm that the host is no longer generating pairing tokens and can be linked to another host as a follower. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,92 @@ | ||
--- | ||
sidebar_label: "Scale a Cluster" | ||
title: "Scale a Cluster" | ||
description: "Learn how to scale up or scale down a cluster." | ||
hide_table_of_contents: false | ||
sidebar_position: 40 | ||
tags: ["edge"] | ||
--- | ||
|
||
Once a cluster is operational, you have the option of scaling up the cluster by adding additional nodes, or scale down | ||
the cluster by removing nodes from the cluster using Local UI. | ||
|
||
## Scale up a Cluster | ||
|
||
To scale up a cluster is to add additional nodes to an active cluster. You can scale up a cluster deployed on hosts | ||
installed in airgap mode in Local UI. | ||
|
||
### Prerequisites | ||
|
||
- You have an active cluster composed of hosts installed in airgap mode. For more information, refer to | ||
[Create Local Cluster](./create-cluster.md). | ||
|
||
- The new nodes you plan to add to the cluster are linked with the nodes in the existing cluster. For more information, | ||
refer to [Link Hosts](./link-hosts.md). | ||
|
||
- You have access to the leader node of the cluster. For more information about leader nodes, refer to | ||
abhinavnagaraj marked this conversation as resolved.
Show resolved
Hide resolved
|
||
[Link Hosts](./link-hosts.md). | ||
|
||
### Procedure | ||
|
||
1. Log in to [Local UI](../host-management/access-console.md) on the leader node where your cluster is deployed. | ||
|
||
2. From the left **Main Menu**, click **Cluster**. | ||
|
||
3. On the **Cluster** page, click **Nodes** to view the **Nodes** tab. | ||
|
||
4. Select a node pool you'd like to edit. You can either edit the control plane or the worker pool. | ||
|
||
5. In the pop-up window,scroll down to **Pool Configuration** and click on **Add Item**. | ||
|
||
6. Select a host that you'd like to add to the cluster. | ||
|
||
7. Click **Confirm** to confirm your changes. It may take 15 to 25 mins for the change to take effect depending on your | ||
lennessyy marked this conversation as resolved.
Show resolved
Hide resolved
lennessyy marked this conversation as resolved.
Show resolved
Hide resolved
|
||
environment and workload. | ||
|
||
### Validate | ||
|
||
1. Log in to [Local UI](../host-management/access-console.md) on the leader node where your cluster is deployed. | ||
|
||
2. From the left **Main Menu**, click **Cluster**. | ||
|
||
3. On the **Cluster** page, click **Nodes** to view the **Nodes** tab. | ||
|
||
4. Confirm that the new node you added to the cluster is in the **Running** status. | ||
|
||
## Scale down a Cluster | ||
|
||
To scale down a cluster is to remove existing nodes from an active cluster. You can scale down a cluster deployed on | ||
hosts installed in airgap mode in Local UI. | ||
|
||
### Prerequisites | ||
|
||
- You have an active multi-node cluster composed of hosts installed in airgap mode. For more information, refer to | ||
[Create Local Cluster](./create-cluster.md). | ||
|
||
- You have access to the leader node of the cluster. For more information about leader nodes, refer to | ||
[Link Hosts](./link-hosts.md). | ||
|
||
### Procedure | ||
|
||
1. Log in to [Local UI](../host-management/access-console.md) on the leader node where your cluster is deployed. | ||
|
||
2. From the left **Main Menu**, click **Cluster**. | ||
|
||
3. On the **Cluster** page, click **Nodes** to view the **Nodes** tab. | ||
|
||
4. Select a node pool you'd like to edit. You can either edit the control plane or the worker pool. | ||
|
||
5. In the pop-up window,scroll down to **Pool Configuration**. Click the **Delete** button next to the nodes you want to | ||
remove. | ||
|
||
6. When you are done removing nodes, Click **Confirm** to confirm your changes. It may take 15 to 25 mins for the change | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🚫 [vale] reported by reviewdog 🐶
lennessyy marked this conversation as resolved.
Show resolved
Hide resolved
|
||
to take effect depending on your environment and workload. | ||
|
||
lennessyy marked this conversation as resolved.
Show resolved
Hide resolved
|
||
### Validate | ||
|
||
1. Log in to [Local UI](../host-management/access-console.md) on the leader node where your cluster is deployed. | ||
|
||
2. From the left **Main Menu**, click **Cluster**. | ||
|
||
3. On the **Cluster** page, click **Nodes** to view the **Nodes** tab. Confirm that the node you removed is no longer in | ||
the cluster. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice catch 😄