diff --git a/docs/install/management-address.md b/docs/install/management-address.md index 175513908ab..ca261403338 100644 --- a/docs/install/management-address.md +++ b/docs/install/management-address.md @@ -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. + +e.g. ![Configure the VIP mode and IP address in 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. + ![](/img/v1.2/install/iso-installed.png) ## How to get the VIP MAC address @@ -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) + ![](/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 + +::: diff --git a/docs/install/requirements.md b/docs/install/requirements.md index 06c108efbd2..7fb200dfb9d 100644 --- a/docs/install/requirements.md +++ b/docs/install/requirements.md @@ -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. + +### 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. + ### Port Requirements for Harvester Nodes Harvester nodes require the following port connections or inbound rules. Typically, all outbound traffic is allowed. diff --git a/versioned_docs/version-v1.2/install/management-address.md b/versioned_docs/version-v1.2/install/management-address.md index 175513908ab..b31b694750c 100644 --- a/versioned_docs/version-v1.2/install/management-address.md +++ b/versioned_docs/version-v1.2/install/management-address.md @@ -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. + +e.g. ![Configure the VIP mode and IP address in 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. + ![](/img/v1.2/install/iso-installed.png) ## How to get the VIP MAC address @@ -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 + +::: diff --git a/versioned_docs/version-v1.2/install/requirements.md b/versioned_docs/version-v1.2/install/requirements.md index 06c108efbd2..7fb200dfb9d 100644 --- a/versioned_docs/version-v1.2/install/requirements.md +++ b/versioned_docs/version-v1.2/install/requirements.md @@ -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. + +### 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. + ### Port Requirements for Harvester Nodes Harvester nodes require the following port connections or inbound rules. Typically, all outbound traffic is allowed.