Skip to content

Commit

Permalink
docs: add stable IP requirements (#3033)
Browse files Browse the repository at this point in the history
* docs: add stable IP requirements

* docs: copy edits

---------

Co-authored-by: Lenny Chen <[email protected]>
  • Loading branch information
lennessyy and lennessyy authored Jun 7, 2024
1 parent 486bebe commit e2d84db
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 6 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,15 @@ cluster using Local UI.
ISO during EdgeForge. For more information, refer to [Upload Content Bundle](./upload-content-bundle.md) and
[Build Edge Artifacts with Content Bundle](../../edgeforge-workflow/palette-canvos/build-artifacts.md).

- You must ensure that the Edge host has a stable IP address. You have the following options to achieve a stable IP
address:

- Use a static IP address. Contact your network administrator to assign the Edge host a static IP address.
- Use Dynamic Host Configuration Protocol (DHCP) reservations to reserve an IP address in a DHCP network. Contact your
network administrator to reserve IP addresses for your Edge hosts in a DHCP network.
- Enable network overlay on your Edge cluster. Network overlay can only be enabled during cluster creation. For more
information about network overlay, refer to [Enable Overlay Network](../../networking/vxlan-overlay.md).

## Create Local Cluster

1. Log into the local UI by visiting the 5080 port of your Edge device's IP address or domain name. For more
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,15 @@ tags: ["edge"]
---

To complete the Edge Installation process, an Edge host must become a member of a host cluster. You can add an Edge host
to an existing host cluster of type Edge Native, or you can create a new host cluster for Edge hosts and make the Edge
host a member.
to an existing Edge cluster, or you can create a new host cluster for Edge hosts and make the Edge host a member.

:::info

Procedures described on this page apply to Edge hosts with a connection to a Palette instance only. To learn how to
create a cluster using an Edge host that does not have a connection to a Palette instance (an air-gapped Edge host),
refer to [Create Cluster with Local UI](../../local-ui/cluster-management/create-cluster.md).

:::

Select the workflow that best fits your needs.

Expand All @@ -27,7 +34,18 @@ Use the following steps to create a new host cluster so that you can add Edge ho

### Prerequisites

- A registered Edge host.
- One or more registered Edge host. For more information about Edge host registration, refer to
[Edge Host Registration](./edge-host-registration.md).

- If you are using more than one Edge host to form a cluster, the hosts in the same cluster must be on the same network.

- You must ensure that the Edge hosts have stable IP addresses. You have the following options to do achieve stable IP
addressing for Edge hosts:
- Use static IP addresses. Contact your network administrator to assign the Edge host a static IP address.
- Use Dynamic Host Configuration Protocol (DHCP) reservations to reserve an IP address in a DHCP network. Contact your
network administrator to reserve IP addresses for your Edge hosts in a DHCP network.
- Enable network overlay on your Edge cluster. Network overlay can only be enabled during cluster creation. For more
information about network overlay, refer to [Enable Overlay Network](../../networking/vxlan-overlay.md).

### Create Cluster

Expand Down Expand Up @@ -185,15 +203,25 @@ node pool.

### Prerequisites

- A registered Edge host.
- An existing Edge cluster.

- One or more registered Edge host on the same network as your existing cluster. For more information about Edge host
registration, refer to [Edge Host Registration](./edge-host-registration.md).

- You must ensure that the Edge hosts have stable IP addresses. You have the following options to do achieve stable IP
addressing for Edge hosts:

- A host cluster of type Edge Native.
- Use static IP addresses. Contact your network administrator to assign the Edge host a static IP address.
- Use Dynamic Host Configuration Protocol (DHCP) reservations to reserve an IP address in a DHCP network. Contact your
network administrator to reserve IP addresses for your Edge hosts in a DHCP network.
- Your Edge cluster has enabled network overlay. Network overlay can only be enabled during cluster creation. For more
information about network overlay, refer to [Enable Overlay Network](../../networking/vxlan-overlay.md).

:::warning

When adding a new Edge host to an existing cluster, ensure you are not creating a scenario where
[etcd](https://etcd.io/) could fail in establishing a quorum. Quorum failures typically result when there is an even
number of nodes. To learn more, check out the resource from the etcd documentation titled
number of control plane nodes. To learn more, check out the resource from the etcd documentation titled
[Why an odd number of cluster members](https://etcd.io/docs/v3.3/faq/#why-an-odd-number-of-cluster-members).

:::
Expand Down

0 comments on commit e2d84db

Please sign in to comment.