Update VIP picture and IP address requirements #468
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for harvester-preview ready!
|
bk201
reviewed
Oct 13, 2023
|
Note: After the #462 is merged, we can further polish the |
connorkuehl
reviewed
Oct 13, 2023
Signed-off-by: Jian Wang <[email protected]>
connorkuehl
approved these changes
Oct 13, 2023
jillian-maroket
requested review from
jillian-maroket
and removed request for
LucasSaintarbor
| @@ -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. | |||
There was a problem hiding this comment.
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. |
| :::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. |
There was a problem hiding this comment.
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. |
Comment on lines
+51
to
+53
| 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 |
There was a problem hiding this comment.
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). |
| @@ -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. | |||
There was a problem hiding this comment.
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. |
| @@ -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. | |||
There was a problem hiding this comment.
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. |
Comment on lines
+49
to
+53
| ### 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. |
There was a problem hiding this comment.
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. |
Comment on lines
+49
to
+53
| ### 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. |
There was a problem hiding this comment.
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. |
| @@ -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. | |||
There was a problem hiding this comment.
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. |
| @@ -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.  | |||
There was a problem hiding this comment.
Suggested change
| e.g.  | |
| Example: | |
|  |
| @@ -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.  | |||
There was a problem hiding this comment.
Suggested change
| e.g.  | |
| Example: | |
|  |
|
@jillian-maroket Thanks for your comment. Could you please have a pre-check of @LucasSaintarbor 's comment. Some descriptions have already been updated per comments. Hopefully, we don't need to continuously update the document due to different reviewer have different favourites. And, for the added parts, we also try to keep content/description/format similar with the existing contents. thanks. |
Hi @w13915984028, sorry for the double review. I wanted @jillian-maroket to review this PR for practice and she made some formatting/grammar suggestions I missed. This won't be a normal occurrence moving forward but we should go with her review on this PR. Thanks! |
bk201
approved these changes
Oct 20, 2023
|
@w13915984028 May you review the changes suggested by @jillian-maroket when you get the chance? Can https://github.com/harvester/docs/issues/465 be closed? |
|
@LucasSaintarbor I will rebase and recheck the PR, thanks. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue: https://github.com/harvester/docs/issues/465