Skip to content

Commit

Permalink
docs: change node to host (#4972)
Browse files Browse the repository at this point in the history
* docs: change node to host

* docs: fix broken link

* docs: more removal

---------

Co-authored-by: Lenny Chen <[email protected]>
  • Loading branch information
lennessyy and lennessyy authored Dec 10, 2024
1 parent 823482b commit 5e7a059
Show file tree
Hide file tree
Showing 3 changed files with 54 additions and 46 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,17 @@ sidebar_position: 90
tags: ["edge"]
---

You can delete an active cluster using Local UI. Deleting a cluster will return all nodes in the cluster to **Ready**
You can delete an active cluster using Local UI. Deleting a cluster will return all hosts in the cluster to **Ready**
status. Deleting a cluster does not unlink the linked hosts. If you want to use the hosts that were freed from the
cluster, you must unlink them first. For more information about linking or unlinking hosts, refer to
[Link Hosts](./link-hosts.md).

When you delete a cluster, the node where you performed the delete action from will be the new leader node of the group.
For more information about leader nodes, refer to [Link Hosts](link-hosts.md#leader-nodes).
:::preview

:::

When you delete a cluster, the host where you performed the delete action from will be the new leader host of the group.
For more information about leader hosts, refer to [Link Hosts](link-hosts.md#leader-hosts).

## Prerequisites

Expand All @@ -24,7 +28,7 @@ For more information about leader nodes, refer to [Link Hosts](link-hosts.md#lea

## Delete a Cluster

1. Log in to [Local UI](../host-management/access-console.md) on the leader node where your cluster is deployed.
1. Log in to [Local UI](../host-management/access-console.md) on a control plane node where your cluster is deployed.

2. From the left **Main Menu**, click **Cluster**.

Expand All @@ -33,7 +37,7 @@ For more information about leader nodes, refer to [Link Hosts](link-hosts.md#lea
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.
unavailable as the hosts reboot after cluster deletion.

## Validate

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,26 +17,26 @@ 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.

## Leader Nodes
## Leader Hosts

To link hosts together, you designate one node as the leader node. The leader node has two obligations:
To link hosts together, you designate one host as the leader. The leader host has two obligations:

- Generate tokens with its IP address and One-Time Password (OTP) credentials, which you can use to link other nodes as
- Generate tokens with its IP address and One-Time Password (OTP) credentials, which you can use to link other hosts as
followers.
- Sync content bundles uploaded to the node and configuration changes made to the node to the rest of the cluster.
- Sync content bundles uploaded to the host and configuration changes made to the host to the rest of the cluster.

A group of linked hosts that have not formed a cluster only has one leader node, where you can upload content bundles
and create a cluster.
A group of linked hosts that have not formed a cluster only has one leader, where you can upload content bundles and
create a cluster.

Once a cluster is formed, every control plane node will be generating the pairing tokens and can act as the leader node.
When you perform an action on any control plane node, that node will act as the leader and propagate the action to the
rest of the cluster. For example, if you upload a content bundle to a control plane node, the content bundle will be
synced from that node to the rest of the cluster, even if the control plane node was not the leader node before a
cluster is formed. This design removes the need to memorize which node was the leader before forming a cluster.
Once a cluster is formed, every control plane node will be generating the pairing tokens and can act as the leader. When
you perform an action on any control plane node, that node will act as the leader and propagate the action to the rest
of the cluster. For example, if you upload a content bundle to a control plane node, the content bundle will be synced
from that node to the rest of the cluster, even if the control plane node was not the leader before a cluster is formed.
This design removes the need to memorize which host was the leader before forming a cluster.

When you [delete a cluster](../cluster-management/delete-cluster.md), all nodes will return to the **Ready** state, but
will remain linked. Since the group of hosts no longer have a cluster, they will only have one leader node, which is the
host where you performed the delete action from.
When you [delete a cluster](../cluster-management/delete-cluster.md), all hosts will return to the **Ready** state, but
will remain linked. Since the group of hosts no longer have a cluster, they will only have one leader, which is the host
where you performed the delete action from.

## Link Hosts

Expand All @@ -51,7 +51,7 @@ with each other.
- For hosts that are deployed in [agent mode](../../../../deployment-modes/agent-mode/agent-mode.md), all hosts must
share the same Operating System (OS).

- You cannot update the IP address of a linked node.
- You cannot update the IP address of a linked host.

### Prerequisites

Expand All @@ -70,46 +70,46 @@ with each other.

### 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.
1. Decide on host that you plan to use as the leader of the group. Log in to
[Local UI](../host-management/access-console.md) of that host.

2. From the left **Main Menu**, click **Linked Edge Hosts**.

3. Click **Generate token**. This will make the host start generating tokens you will use to link this host with other
hosts. The base-64 encoded token contains the IP address of the node, as well as an OTP that will expire in two
minutes. Once a token expires, the leader node generates another token automatically.
hosts. The base-64 encoded token contains the IP address of the host, as well as an OTP that will expire in two
minutes. Once a token expires, the leader generates another token automatically.

If you have already made the

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.
5. Log in to [Local UI](../host-management/access-console.md) on the host that you want to link to the leader host.

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 copied from the leader node.
8. In the pop-up box that appears, enter the token you copied from the leader host.

9. Click **Confirm**.

10. Repeat this process for every node you want to link to the leader node.
10. Repeat this process for every host you want to link to the leader host.

### Validate

1. Log in to [Local UI](../host-management/access-console.md) on the leader node.
1. Log in to [Local UI](../host-management/access-console.md) on the leader host.

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.
3. Confirm that all hosts 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. Once all follower hosts have been unlinked, you can
[remove its leader status](#remove-leader-node-status) and link it to another node.
[remove its leader status](#remove-leader-node-status) and link it to another host.

You can unlink a follower host on the follower host itself or from the leader node.
You can unlink a follower host on the follower host itself or from the leader host.

### Prerequisites

Expand All @@ -125,24 +125,24 @@ You can unlink a follower host on the follower host itself or from the leader no

<Tabs>

<TabItem value="From Leader Node">
<TabItem value="From Leader Host">

1. Log in to Local UI on the leader node.
1. Log in to Local UI on the leader host.

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.
3. In the list of linked hosts, identify the host you want to unlink and click the **three-dot button** next to the IP
address of the host.

4. Click **Unlink**.

5. Click **Confirm**

</TabItem>

<TabItem value="On Follower Node">
<TabItem value="On Follower Host">

1. Log in to Local UI on the node you want to unlink.
1. Log in to Local UI on the host you want to unlink.

2. From the left **Main Menu**, click **Linked Edge Hosts**.

Expand All @@ -156,23 +156,23 @@ You can unlink a follower host on the follower host itself or from the leader no

### Validate

1. Log in to Local UI on the node you unlinked.
1. Log in to Local UI on the host 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.
3. Confirm that the host has been unlinked from the leader and is ready to be paired with another host.

## Remove Leader Node Status

Removing the leader node status of a node allows you to link the node to another group of linked nodes as a follower.
You can only do this when the node is not part of an active cluster.
Removing the leader host status of a host allows you to link the host to another group of linked hosts as a follower.
You can only do this when the host is not part of an active cluster.

### Prerequisites

- 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.
follower hosts.

### Procedure

Expand All @@ -181,7 +181,7 @@ You can only do this when the node is not part of an active cluster.
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.
ready to be paired with other hosts again as a follower.

### Validate

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ 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.

:::preview

:::

## 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
Expand All @@ -20,10 +24,10 @@ installed in airgap mode in Local UI.
- 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,
- The new host you plan to add to the cluster are linked with the host 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
- You have access to the leader node of the cluster. For more information about leader host, refer to
[Link Hosts](./link-hosts.md).

### Procedure
Expand Down Expand Up @@ -63,7 +67,7 @@ hosts installed in airgap mode in Local UI.
- 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
- You have access to the leader node of the cluster. For more information about leader host, refer to
[Link Hosts](./link-hosts.md).

### Procedure
Expand Down

0 comments on commit 5e7a059

Please sign in to comment.