Skip to content
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

Update VIP picture and IP address requirements #468

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion docs/install/management-address.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,18 @@ Description: The Harvester provides a virtual IP as the management address.

Harvester provides a fixed virtual IP (VIP) as the management address, VIP must be different from any Node IP. You can find the management address on the console dashboard after the installation.

The VIP is configured while the **first Node** of the cluster is installed.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The VIP is configured while the **first Node** of the cluster is installed.
The VIP is configured while the **first node** of the Harvester cluster is installed.


e.g. ![Configure the VIP mode and IP address in ISO Installation](/img/v1.2/install/config-virtual-ip.png)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
e.g. ![Configure the VIP mode and IP address in ISO Installation](/img/v1.2/install/config-virtual-ip.png)
Example:
![Configure the cluster VIP and node IP during ISO Installation](/img/v1.2/install/config-virtual-ip.png)


:::note

If you selected the IP address to be configured via DHCP, you will need to configure static MAC-to-IP address mapping on your DHCP server in order to have a persistent Virtual IP

:::

After the Node starts successfully, both of the VIP and Node IP are shown on the console.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
After the Node starts successfully, both of the VIP and Node IP are shown on the console.
Both the node IP and cluster VIP are displayed on the console after the node starts successfully.


![](/img/v1.2/install/iso-installed.png)

## How to get the VIP MAC address
Expand All @@ -38,4 +44,12 @@ The management address:

- Allows the access to the Harvester API/UI via `HTTPS` protocol.
- Allows other nodes to join the cluster.
![](/img/v1.2/install/configure-management-address.png)
w13915984028 marked this conversation as resolved.
Show resolved Hide resolved
![](/img/v1.2/install/config-virtual-ip.png)

:::note

After the first Node of the Harvester cluster is installed, user may configure the [ssl-certificates](../advanced/settings.md#ssl-certificates), then the cluster can be accessed via VIP and FQDN.

The following installed Node can also join the cluster by both VIP and FQDN. When using FQDN, please note a known issue [Unable to join the new node](https://github.com/harvester/harvester/issues/4511) and workaround: https://github.com/harvester/harvester/issues/4511#issuecomment-1761047115
Comment on lines +51 to +53
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
After the first Node of the Harvester cluster is installed, user may configure the [ssl-certificates](../advanced/settings.md#ssl-certificates), then the cluster can be accessed via VIP and FQDN.
The following installed Node can also join the cluster by both VIP and FQDN. When using FQDN, please note a known issue [Unable to join the new node](https://github.com/harvester/harvester/issues/4511) and workaround: https://github.com/harvester/harvester/issues/4511#issuecomment-1761047115
You can configure [SSL certificate settings](../advanced/settings.md#ssl-certificates) after the first cluster node is installed. SSL certificates allow you to access and join nodes to the cluster using VIPs and FQDNs.
However, in some cases you may be [unable to join a new node to a cluster](https://github.com/harvester/harvester/issues/4511) using FQDNs. If you encounter this issue, you can follow the steps in [this workaround](https://github.com/harvester/harvester/issues/4511#issuecomment-1761047115).


:::
10 changes: 10 additions & 0 deletions docs/install/requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,16 @@ A three-node cluster is required to realize the multi-node features of Harvester

Harvester nodes have the following network requirements for installation.

### IP Address Requirements for Harvester Nodes

Harvester is built on top of Kubernetes, and each node needs an independent IP address. Harvester uses this IP address to identify a node identity, and it cannot change during the lifecycle of a Harvester cluster.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Harvester is built on top of Kubernetes, and each node needs an independent IP address. Harvester uses this IP address to identify a node identity, and it cannot change during the lifecycle of a Harvester cluster.
Each node in a Harvester cluster must have an independent IP address. Harvester uses this IP to verify the node's identity so the IP must not change throughout the lifecycle of the cluster.


### IP Address Requirements for Harvester Cluster

The Harvester cluster needs an additional IP address called Virtual IP (VIP). It uses it as the management IP for the whole cluster.

Please refer to [Management Address](./management-address.md) for more details.
Comment on lines +49 to +53
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
### IP Address Requirements for Harvester Cluster
The Harvester cluster needs an additional IP address called Virtual IP (VIP). It uses it as the management IP for the whole cluster.
Please refer to [Management Address](./management-address.md) for more details.
### IP Address Requirements for Harvester Clusters
Each Harvester cluster must have a fixed virtual IP (VIP) that is different from all other node IPs. Harvester uses this VIP as the [management address](./management-address.md) for the cluster.


### Port Requirements for Harvester Nodes

Harvester nodes require the following port connections or inbound rules. Typically, all outbound traffic is allowed.
Expand Down
15 changes: 15 additions & 0 deletions versioned_docs/version-v1.2/install/management-address.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,18 @@ Description: The Harvester provides a virtual IP as the management address.

Harvester provides a fixed virtual IP (VIP) as the management address, VIP must be different from any Node IP. You can find the management address on the console dashboard after the installation.

The VIP is configured while the **first Node** of the cluster is installed.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The VIP is configured while the **first Node** of the cluster is installed.
The VIP is configured while the **first node** of the Harvester cluster is installed.


e.g. ![Configure the VIP mode and IP address in ISO Installation](/img/v1.2/install/config-virtual-ip.png)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
e.g. ![Configure the VIP mode and IP address in ISO Installation](/img/v1.2/install/config-virtual-ip.png)
Example:
![Configure the cluster VIP and node IP during ISO Installation](/img/v1.2/install/config-virtual-ip.png)


:::note

If you selected the IP address to be configured via DHCP, you will need to configure static MAC-to-IP address mapping on your DHCP server in order to have a persistent Virtual IP

:::

After the Node starts successfully, both of the VIP and Node IP are shown on the console.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
After the Node starts successfully, both of the VIP and Node IP are shown on the console.
Both the node IP and cluster VIP are displayed on the console after the node starts successfully.


![](/img/v1.2/install/iso-installed.png)

## How to get the VIP MAC address
Expand All @@ -34,8 +40,17 @@ Example of output:
```

## Usages

The management address:

- Allows the access to the Harvester API/UI via `HTTPS` protocol.
- Allows other nodes to join the cluster.
![](/img/v1.2/install/configure-management-address.png)

:::note

After the first Node of the Harvester cluster is installed, user may configure the [ssl-certificates](../advanced/settings.md#ssl-certificates), then the cluster can be accessed via VIP and FQDN.

The following installed Node can also join the cluster by both VIP and FQDN. When using FQDN, please note a known issue [Unable to join the new node](https://github.com/harvester/harvester/issues/4511) and workaround: https://github.com/harvester/harvester/issues/4511#issuecomment-1761047115
Comment on lines +52 to +54
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
After the first Node of the Harvester cluster is installed, user may configure the [ssl-certificates](../advanced/settings.md#ssl-certificates), then the cluster can be accessed via VIP and FQDN.
The following installed Node can also join the cluster by both VIP and FQDN. When using FQDN, please note a known issue [Unable to join the new node](https://github.com/harvester/harvester/issues/4511) and workaround: https://github.com/harvester/harvester/issues/4511#issuecomment-1761047115
You can configure [SSL certificate settings](../advanced/settings.md#ssl-certificates) after the first cluster node is installed. SSL certificates allow you to access and join nodes to the cluster using VIPs and FQDNs.
However, in some cases you may be [unable to join a new node to a cluster](https://github.com/harvester/harvester/issues/4511) using FQDNs. If you encounter this issue, you can follow the steps in [this workaround](https://github.com/harvester/harvester/issues/4511#issuecomment-1761047115).


:::
10 changes: 10 additions & 0 deletions versioned_docs/version-v1.2/install/requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,16 @@ A three-node cluster is required to realize the multi-node features of Harvester

Harvester nodes have the following network requirements for installation.

### IP Address Requirements for Harvester Nodes

Harvester is built on top of Kubernetes, and each node needs an independent IP address. Harvester uses this IP address to identify a node identity, and it cannot change during the lifecycle of a Harvester cluster.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Harvester is built on top of Kubernetes, and each node needs an independent IP address. Harvester uses this IP address to identify a node identity, and it cannot change during the lifecycle of a Harvester cluster.
Each node in a Harvester cluster must have an independent IP address. Harvester uses this IP to verify the node's identity so the IP must not change throughout the lifecycle of the cluster.


### IP Address Requirements for Harvester Cluster

The Harvester cluster needs an additional IP address called Virtual IP (VIP). It uses it as the management IP for the whole cluster.

Please refer to [Management Address](./management-address.md) for more details.
Comment on lines +49 to +53
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
### IP Address Requirements for Harvester Cluster
The Harvester cluster needs an additional IP address called Virtual IP (VIP). It uses it as the management IP for the whole cluster.
Please refer to [Management Address](./management-address.md) for more details.
### IP Address Requirements for Harvester Clusters
Each Harvester cluster must have a fixed virtual IP (VIP) that is different from all other node IPs. Harvester uses this VIP as the [management address](./management-address.md) for the cluster.


### Port Requirements for Harvester Nodes

Harvester nodes require the following port connections or inbound rules. Typically, all outbound traffic is allowed.
Expand Down