diff --git a/static/img/v1.0/install-hv/config-cluster-token.png b/static/img/v1.0/install-hv/config-cluster-token.png new file mode 100644 index 0000000..b99a3fe Binary files /dev/null and b/static/img/v1.0/install-hv/config-cluster-token.png differ diff --git a/static/img/v1.0/install-hv/config-dns-server.png b/static/img/v1.0/install-hv/config-dns-server.png new file mode 100644 index 0000000..633ba81 Binary files /dev/null and b/static/img/v1.0/install-hv/config-dns-server.png differ diff --git a/static/img/v1.0/install-hv/config-hostname.png b/static/img/v1.0/install-hv/config-hostname.png new file mode 100644 index 0000000..8601915 Binary files /dev/null and b/static/img/v1.0/install-hv/config-hostname.png differ diff --git a/static/img/v1.0/install-hv/config-ntp-server.png b/static/img/v1.0/install-hv/config-ntp-server.png new file mode 100644 index 0000000..33cf13b Binary files /dev/null and b/static/img/v1.0/install-hv/config-ntp-server.png differ diff --git a/static/img/v1.0/install-hv/config-password.png b/static/img/v1.0/install-hv/config-password.png new file mode 100644 index 0000000..963dee9 Binary files /dev/null and b/static/img/v1.0/install-hv/config-password.png differ diff --git a/static/img/v1.0/install-hv/config-proxy.png b/static/img/v1.0/install-hv/config-proxy.png new file mode 100644 index 0000000..c3f4edd Binary files /dev/null and b/static/img/v1.0/install-hv/config-proxy.png differ diff --git a/static/img/v1.0/install-hv/configure-management-address.png b/static/img/v1.0/install-hv/configure-management-address.png new file mode 100644 index 0000000..053c617 Binary files /dev/null and b/static/img/v1.0/install-hv/configure-management-address.png differ diff --git a/static/img/v1.0/install-hv/edit-menu-entry.png b/static/img/v1.0/install-hv/edit-menu-entry.png new file mode 100644 index 0000000..3f91e42 Binary files /dev/null and b/static/img/v1.0/install-hv/edit-menu-entry.png differ diff --git a/static/img/v1.0/install-hv/force-resolution.png b/static/img/v1.0/install-hv/force-resolution.png new file mode 100644 index 0000000..ee392d1 Binary files /dev/null and b/static/img/v1.0/install-hv/force-resolution.png differ diff --git a/static/img/v1.0/install-hv/grub-menu.png b/static/img/v1.0/install-hv/grub-menu.png new file mode 100644 index 0000000..365d493 Binary files /dev/null and b/static/img/v1.0/install-hv/grub-menu.png differ diff --git a/static/img/v1.0/install-hv/import-ssh-keys.png b/static/img/v1.0/install-hv/import-ssh-keys.png new file mode 100644 index 0000000..c38cc73 Binary files /dev/null and b/static/img/v1.0/install-hv/import-ssh-keys.png differ diff --git a/static/img/v1.0/install-hv/remote-config.png b/static/img/v1.0/install-hv/remote-config.png new file mode 100644 index 0000000..9e61f1d Binary files /dev/null and b/static/img/v1.0/install-hv/remote-config.png differ diff --git a/static/img/v1.2/cluster-resource-usage.png b/static/img/v1.2/cluster-resource-usage.png new file mode 100644 index 0000000..04f09d9 Binary files /dev/null and b/static/img/v1.2/cluster-resource-usage.png differ diff --git a/static/img/v1.2/host-resource-usage.png b/static/img/v1.2/host-resource-usage.png new file mode 100644 index 0000000..8396fe8 Binary files /dev/null and b/static/img/v1.2/host-resource-usage.png differ diff --git a/versioned_docs/version-v1.6/install/external-disk-support.md b/versioned_docs/version-v1.6/install/external-disk-support.md index b9bfb98..f23875a 100644 --- a/versioned_docs/version-v1.6/install/external-disk-support.md +++ b/versioned_docs/version-v1.6/install/external-disk-support.md @@ -3,11 +3,11 @@ sidebar_position: 10 sidebar_label: External Disk Support title: "External Disk Support" keywords: - - Harvester + - Hypervisor - Net ISO Installation - BMC ISO Redirection - BMC Virtual Media -description: Install Harvester on diskless systems. +description: Install Hypervisor on diskless systems. --- @@ -46,7 +46,7 @@ Configuration tasks that you must perform include the following: See your system provider's documentation for more information about boot settings and firmware functions. A link to a sample document is provided in the References section. -![target-details.png](/img/v1.4/external-disk/target-details.png) +![target-details.png](/img/v1.4/external-disk-hv/target-details.png) ### Install Hypervisor diff --git a/versioned_docs/version-v1.6/install/harvester-configuration.md b/versioned_docs/version-v1.6/install/harvester-configuration.md index 6286927..c666bef 100644 --- a/versioned_docs/version-v1.6/install/harvester-configuration.md +++ b/versioned_docs/version-v1.6/install/harvester-configuration.md @@ -653,7 +653,7 @@ install: ### `install.rawdiskimagepath` -**Definition**: Setting that forces the installer to only install the Harvester hypervisor (without any configuration). You must enable `harvester.install.automatic` to use this setting. +**Definition**: Setting that forces the installer to only install the Hypervisor hypervisor (without any configuration). You must enable `harvester.install.automatic` to use this setting. ### `install.role` diff --git a/versioned_docs/version-v1.6/install/iso-install.md b/versioned_docs/version-v1.6/install/iso-install.md index c9ae187..5a694fd 100644 --- a/versioned_docs/version-v1.6/install/iso-install.md +++ b/versioned_docs/version-v1.6/install/iso-install.md @@ -20,11 +20,11 @@ Hypervisor ships as a bootable appliance image, you can install it directly on a During the installation, you can either choose to **create a new Hypervisor cluster** or **join the node to an existing Hypervisor cluster**. -The following [video](https://youtu.be/X0VIGZ_lExQ) shows a quick overview of an ISO installation. + ## Installation Steps @@ -36,7 +36,7 @@ The following [video](https://youtu.be/X0VIGZ_lExQ) shows a quick overview of an ![hardware-checks.png](/img/v1.0/install-hv/hardware-checks.png) -1. Use the arrow keys to choose an installation mode. By default, the first node will be the management node of the cluster. +2. Use the arrow keys to choose an installation mode. By default, the first node will be the management node of the cluster. ![choose-installation-mode.png](/img/v1.0/install-hv/choose-installation-mode.png) @@ -50,7 +50,7 @@ The following [video](https://youtu.be/X0VIGZ_lExQ) shows a quick overview of an When there are 3 nodes, the other 2 nodes added first are automatically promoted to management nodes to form an HA cluster. If you want to promote management nodes from different zones, you can add the node label `topology.kubernetes.io/zone` in the [os.labels](./harvester-configuration.md#oslabels) config by providing a URL of [Hypervisor configuration](./harvester-configuration.md) on the customize the host step. In this case, at least three different zones are required. ::: -1. Choose a role for the node. You are required to perform this step if you selected the installation mode `Join an existing Hypervisor cluster`. +3. Choose a role for the node. You are required to perform this step if you selected the installation mode `Join an existing Hypervisor cluster`. ![choose-node-role.png](/img/v1.0/install-hv/select-role.png) @@ -59,11 +59,11 @@ The following [video](https://youtu.be/X0VIGZ_lExQ) shows a quick overview of an - `Witness Role`: Restricts a node to being a witness node (only functions as an etcd node) in a specific cluster. - `Worker Role`: Restricts a node to being a worker node (never promoted to management node) in a specific cluster. -1. Configure and confirm a `Password` to access the node. The default SSH user is `rancher`. +4. Configure and confirm a `Password` to access the node. The default SSH user is `rancher`. - ![config-password.png](/img/v1.2/install/config-password.png) + ![config-password.png](/img/v1.0/install-hv/config-password.png) -1. Choose the installation disk you want to install the Hypervisor cluster on and the data disk you want to store VM data on. By default, Hypervisor uses [GUID Partition Table (GPT)](https://en.wikipedia.org/wiki/GUID_Partition_Table) partitioning schema for both UEFI and BIOS. If you use the BIOS boot, then you will have the option to select [Master boot record (MBR)](https://en.wikipedia.org/wiki/Master_boot_record). +5. Choose the installation disk you want to install the Hypervisor cluster on and the data disk you want to store VM data on. By default, Hypervisor uses [GUID Partition Table (GPT)](https://en.wikipedia.org/wiki/GUID_Partition_Table) partitioning schema for both UEFI and BIOS. If you use the BIOS boot, then you will have the option to select [Master boot record (MBR)](https://en.wikipedia.org/wiki/Master_boot_record). :::info important Support for legacy BIOS booting is deprecated in v1.7.0 and will be removed in a later release. Existing Hypervisor clusters that use this boot mode will continue to function, but upgrading to later versions may require re-installation in UEFI mode. To avoid issues and disruptions, use UEFI in new installations. @@ -75,11 +75,11 @@ The following [video](https://youtu.be/X0VIGZ_lExQ) shows a quick overview of an - `Data disk`: The disk to store VM data on. Choosing a separate disk to store VM data is recommended. Not applicable for witness nodes. - `Persistent size`: If you only have one disk or use the same disk for both OS and VM data, you need to configure persistent partition size to store system packages and container images. The default and minimum persistent partition size is 150 GiB. You can specify a size like 200Gi or 153600Mi. -1. Configure the `HostName` of the node. +6. Configure the `HostName` of the node. - ![config-hostname.png](/img/v1.2/install/config-hostname.png) + ![config-hostname.png](/img/v1.0/install-hv/config-hostname.png) -1. Configure network interface(s) for the management network. By default, Hypervisor creates a [bonded NIC](./requirements.md#hardware-requirements) named `mgmt-bo` for the [built-in management cluster network](../networking/clusternetwork.md#built-in-cluster-network), and the IP address can be configured via DHCP or statically assigned. +7. Configure network interface(s) for the management network. By default, Hypervisor creates a [bonded NIC](./requirements.md#hardware-requirements) named `mgmt-bo` for the [built-in management cluster network](../networking/clusternetwork.md#built-in-cluster-network), and the IP address can be configured via DHCP or statically assigned. ![config-network.png](/img/v1.0/install-hv/config-network.png) @@ -89,7 +89,7 @@ The following [video](https://youtu.be/X0VIGZ_lExQ) shows a quick overview of an It is not possible to change the node IP throughout the lifecycle of a Hypervisor cluster. If using DHCP, you must ensure the DHCP server always offers the same IP for the same node. If the node IP is changed, the related node cannot join the cluster and might even break the cluster. - In addition, you are required to add the *routers* option (`option routers`) when configuring the DHCP server. This option is used to add the default route on the Harvester host. Without the default route, the node will fail to start. + In addition, you are required to add the *routers* option (`option routers`) when configuring the DHCP server. This option is used to add the default route on the Hypervisor host. Without the default route, the node will fail to start. For example: ``` Linux~ # ip route @@ -97,10 +97,10 @@ The following [video](https://youtu.be/X0VIGZ_lExQ) shows a quick overview of an ``` For more information, see [DHCP Server Configuration](./pxe-boot-install.md#dhcp-server-configuration). - The default MTU value of the bonded NIC is `1500`. If you require a different MTU value, configure the [`install.management_interface`](./harvester-configuration.md#installmanagement_interface) setting in a Harvester configuration file per following step. + The default MTU value of the bonded NIC is `1500`. If you require a different MTU value, configure the [`install.management_interface`](./harvester-configuration.md#installmanagement_interface) setting in a Hypervisor configuration file per following step. ::: -1. (Optional) Configure the CIDRs for the cluster pods and services. +8. (Optional) Configure the CIDRs for the cluster pods and services. If you want to use the default values, leave the fields blank. @@ -120,11 +120,11 @@ The following [video](https://youtu.be/X0VIGZ_lExQ) shows a quick overview of an - **Service CIDR**: 172.22.0.0/16 - **Cluster DNS IP**: 172.22.0.10 -1. (Optional) Configure the `DNS Servers`. Use commas as a delimiter to add more DNS servers. Leave it blank to use the default DNS server. +9. (Optional) Configure the `DNS Servers`. Use commas as a delimiter to add more DNS servers. Leave it blank to use the default DNS server. - ![config-dns-server.png](/img/v1.2/install/config-dns-server.png) + ![config-dns-server.png](/img/v1.0/install-hv/config-dns-server.png) -1. Configure the virtual IP (VIP) by selecting a `VIP Mode`. This VIP is used to access the cluster or for other nodes to join the cluster. +10. Configure the virtual IP (VIP) by selecting a `VIP Mode`. This VIP is used to access the cluster or for other nodes to join the cluster. :::note For DHCP setup with static MAC-to-IP address mappings configured, enter the MAC address in the provided field to fetch the unique persistent virtual IP (VIP). Otherwise, leave it blank. @@ -132,35 +132,35 @@ The following [video](https://youtu.be/X0VIGZ_lExQ) shows a quick overview of an ![config-virtual-ip.png](/img/v1.0/install-hv/config-virtual-ip.png) -1. Configure the `Cluster token`. This token is used for adding other nodes to the cluster. +11. Configure the `Cluster token`. This token is used for adding other nodes to the cluster. - ![config-cluster-token.png](/img/v1.2/install/config-cluster-token.png) + ![config-cluster-token.png](/img/v1.0/install-hv/config-cluster-token.png) -1. Configure `NTP servers` to make sure all nodes' times are synchronized. This defaults to `0.suse.pool.ntp.org`. Use commas as a delimiter to add more NTP servers. +12. Configure `NTP servers` to make sure all nodes' times are synchronized. This defaults to `0.suse.pool.ntp.org`. Use commas as a delimiter to add more NTP servers. - ![config-ntp-server.png](/img/v1.2/install/config-ntp-server.png) + ![config-ntp-server.png](/img/v1.0/install-hv/config-ntp-server.png) :::note Using multiple NTP servers provides redundancy, better accuracy, fault tolerance, and improved performance. It ensures that time synchronization continues even if one server fails or gives incorrect data, and it helps distribute the load across different servers. ::: -1. (Optional) If you need to use an HTTP proxy to access the outside world, enter the `Proxy address`. Otherwise, leave this blank. +13. (Optional) If you need to use an HTTP proxy to access the outside world, enter the `Proxy address`. Otherwise, leave this blank. - ![config-proxy.png](/img/v1.2/install/config-proxy.png) + ![config-proxy.png](/img/v1.0/install-hv/config-proxy.png) -1. (Optional) You can choose to import SSH keys by providing `HTTP URL`. For example, your GitHub public keys `https://github.com/.keys` can be used. +14. (Optional) You can choose to import SSH keys by providing `HTTP URL`. For example, your GitHub public keys `https://github.com/.keys` can be used. - ![import-ssh-keys.png](/img/v1.2/install/import-ssh-keys.png) + ![import-ssh-keys.png](/img/v1.0/install-hv/import-ssh-keys.png) -1. (Optional) If you need to customize the host with a [Hypervisor configuration](./harvester-configuration.md) file, enter the `HTTP URL` here. +15. (Optional) If you need to customize the host with a [Hypervisor configuration](./harvester-configuration.md) file, enter the `HTTP URL` here. - ![remote-config.png](/img/v1.2/install/remote-config.png) + ![remote-config.png](/img/v1.0/install-hv/remote-config.png) -1. Review and confirm your installation options. After confirming the installation options, Hypervisor will be installed to your host. The installation may take a few minutes to be complete. +16. Review and confirm your installation options. After confirming the installation options, Hypervisor will be installed to your host. The installation may take a few minutes to be complete. ![confirm-install.png](/img/v1.0/install-hv/confirm-install.png) -1. Once the installation is complete, your node restarts. After the restart, the Hypervisor console displays the management URL and status. The default URL of the web interface is `https://your-virtual-ip`. You can use `F12` to switch from the Hypervisor console to the Shell and type `exit` to go back to the Hypervisor console. +17. Once the installation is complete, your node restarts. After the restart, the Hypervisor console displays the management URL and status. The default URL of the web interface is `https://your-virtual-ip`. You can use `F12` to switch from the Hypervisor console to the Shell and type `exit` to go back to the Hypervisor console. :::note Choosing `Install Hypervisor binaries only` on the first page requires additional setup after the first bootup. @@ -168,7 +168,7 @@ The following [video](https://youtu.be/X0VIGZ_lExQ) shows a quick overview of an ![iso-installed.png](/img/v1.0/install-hv/iso-installed.png) -1. You will be prompted to set the password for the default `admin` user when logging in for the first time. +18. You will be prompted to set the password for the default `admin` user when logging in for the first time. ![first-login.png](/img/v1.0/install-hv/first-time-login.png) @@ -180,9 +180,9 @@ In some cases, if you are using an older VGA connector, you may encounter an `pa ### Installer may crash when using an older graphics card/monitor -In some cases, if you are using an older graphics card/monitor, you may encounter a `panic: invalid dimensions` error during ISO installation. + We are working on this known issue and planning a fix for a future release. You can try to use another GRUB entry to force it to use the resolution of `1024x768` when booting up. @@ -192,10 +192,10 @@ If you are using a version earlier than v1.1.1, please try the following workaro 1. Boot up with the ISO, and press `E` to edit the first menu entry: - ![grub-menu.png](/img/v1.2/install/grub-menu.png) + ![grub-menu.png](/img/v1.0/install-hv/grub-menu.png) -1. Append `vga=792` to the line started with `$linux`: +2. Append `vga=792` to the line started with `$linux`: - ![edit-menu-entry.png](/img/v1.2/install/edit-menu-entry.png) + ![edit-menu-entry.png](/img/v1.0/install-hv/edit-menu-entry.png) -1. Press `Ctrl+X` or `F10` to boot up. +3. Press `Ctrl+X` or `F10` to boot up. diff --git a/versioned_docs/version-v1.6/install/management-address.md b/versioned_docs/version-v1.6/install/management-address.md index 034bc5c..b61dac4 100644 --- a/versioned_docs/version-v1.6/install/management-address.md +++ b/versioned_docs/version-v1.6/install/management-address.md @@ -19,7 +19,7 @@ If you selected the IP address to be configured via DHCP, you will need to confi ::: -![](/img/v1.2/install/iso-installed.png) +![](/img/v1.0/install-hv/iso-installed.png) ## Requirements @@ -84,4 +84,4 @@ The management address: - Allows the access to the Hypervisor API/UI via `HTTPS` protocol. - Allows other nodes to join the cluster. - ![](/img/v1.2/install/configure-management-address.png) + ![](/img/v1.0/install-hv/configure-management-address.png) diff --git a/versioned_docs/version-v1.6/install/post-install.md b/versioned_docs/version-v1.6/install/post-install.md index aede10a..7c314e2 100644 --- a/versioned_docs/version-v1.6/install/post-install.md +++ b/versioned_docs/version-v1.6/install/post-install.md @@ -4,7 +4,7 @@ sidebar_label: Post-installation steps title: "Post-Installation Steps" draft: true keywords: - - Harvester + - Hypervisor - Installation description: Post-installation steps. --- @@ -18,9 +18,9 @@ You can enhance the security and performance of your Hypervisor cluster by perfo ## Disable SSH Password -By default during installation, SSH password authentication is enabled on the Harvester nodes. This allows administrator to access the nodes for installation diagnosis. +By default during installation, SSH password authentication is enabled on the Hypervisor nodes. This allows administrator to access the nodes for installation diagnosis. -Once installation is completed, however, disabling SSH password authentication is recommended. You can run the following command, which uses `kubectl` to apply a [`CloudInit`](https://docs.harvesterhci.io/v1.6/advanced/cloudinitcrd/) configuration, to disable SSH password authentication on all Harvester nodes: +Once installation is completed, however, disabling SSH password authentication is recommended. You can run the following command, which uses `kubectl` to apply a [`CloudInit`](https://docs.harvesterhci.io/v1.6/advanced/cloudinitcrd/) configuration, to disable SSH password authentication on all Hypervisor nodes: ```sh cat < diff --git a/versioned_docs/version-v1.6/install/pxe-boot-install.md b/versioned_docs/version-v1.6/install/pxe-boot-install.md index 738e7e6..9451b59 100644 --- a/versioned_docs/version-v1.6/install/pxe-boot-install.md +++ b/versioned_docs/version-v1.6/install/pxe-boot-install.md @@ -3,15 +3,15 @@ sidebar_position: 4 sidebar_label: PXE Boot Installation title: "PXE Boot Installation" keywords: - - Harvester + - Hypervisor - harvester - Rancher - rancher - - Install Harvester - - Installing Harvester - - Harvester Installation + - Install Hypervisor + - Installing Hypervisor + - Hypervisor Installation - PXE Boot Install -description: Starting from version `0.2.0`, Harvester can be installed automatically. This document provides an example to do an automatic installation with PXE boot. +description: Starting from version `0.2.0`, Hypervisor can be installed automatically. This document provides an example to do an automatic installation with PXE boot. --- @@ -103,7 +103,7 @@ install: iso_url: http://10.100.0.10/harvester/harvester--amd64.iso # tty: ttyS1,115200n8 # For machines without a VGA console - vip: 10.100.0.99 # The VIP to access the Harvester GUI. Make sure the IP is free to use + vip: 10.100.0.99 # The VIP to access the Hypervisor GUI. Make sure the IP is free to use vip_mode: static # Or dhcp, check configuration file for more information # vip_hw_addr: 52:54:00:ec:0e:0b # Leave empty when vip_mode is static ``` @@ -191,7 +191,7 @@ In the ISO installation scenario, when the management network interface is in DH For example: ``` - Harvester Host:~ # ip route + Hypervisor Host:~ # ip route default via 192.168.122.1 dev mgmt-br proto dhcp ``` diff --git a/versioned_docs/version-v1.6/install/requirements.md b/versioned_docs/version-v1.6/install/requirements.md index 9a18e75..47186ed 100644 --- a/versioned_docs/version-v1.6/install/requirements.md +++ b/versioned_docs/version-v1.6/install/requirements.md @@ -60,8 +60,8 @@ Hypervisor nodes require the following port connections or inbound rules. Typica | Protocol | Port | Source | Description | |:----------|:---------------------------|:-----------------------------------------|:----------------------------------------| -| TCP | 2379 | Harvester management nodes | Etcd client port | -| TCP | 2381 | Harvester management nodes | Etcd metrics collection | +| TCP | 2379 | Hypervisor management nodes | Etcd client port | +| TCP | 2381 | Hypervisor management nodes | Etcd metrics collection | | TCP | 2380 | Hypervisor management nodes | Etcd peer port | | TCP | 2382 | Hypervisor management nodes | Etcd client port (HTTP only) | | TCP | 10010 | Hypervisor management and compute nodes | Containerd | diff --git a/versioned_docs/version-v1.6/install/usb-install.md b/versioned_docs/version-v1.6/install/usb-install.md index 0eb9843..e9a9043 100644 --- a/versioned_docs/version-v1.6/install/usb-install.md +++ b/versioned_docs/version-v1.6/install/usb-install.md @@ -41,7 +41,7 @@ No matter which tool you use, creating a bootable device erases your USB device [balenaEtcher](https://www.balena.io/etcher/) supports writing an image to a USB flash drive on most Linux distros, macOS, and Windows. It has a GUI and is easy to use. -1. Select the Harvester installation ISO. +1. Select the Hypervisor installation ISO. 2. Select the target USB device to create a USB installation flash drive. ![balena-etcher.png](/img/v1.2/install/balena-etcher.png) @@ -70,14 +70,14 @@ You can press `e` to edit the GRUB menu entry and append `nomodeset` to the boot ![](/img/v1.2/install/usb-install-nomodeset.png) -### Harvester installer is not displayed +### Hypervisor installer is not displayed If a USB flash driver boots, but you can't see the harvester installer, try one of the following workarounds: - Plug the USB flash drive into a USB 2.0 slot. - For version `v0.3.0` or above, remove the `console=ttyS0` parameter when booting. Press `e` to edit the GRUB menu entry and remove the `console=ttyS0` parameter. -### Harvester interactive ISO hangs with the USB installation method +### Hypervisor interactive ISO hangs with the USB installation method During installation from a USB flash drive with v1.2.0 ISO image (created by tools like `balenaEtcher`, `dd`, etc.), the installation process may get stuck on the initial image loading process because a required label is missing on the boot partition. Therefore, the installation cannot mount the data partition correctly, causing some checks in `dracut` to be blocked.