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 388cc93..b9bfb98 100644 --- a/versioned_docs/version-v1.6/install/external-disk-support.md +++ b/versioned_docs/version-v1.6/install/external-disk-support.md @@ -19,9 +19,9 @@ _Available as of v1.4.0_ ## Background -Harvester can now be installed on and booted from external disks. This is particularly useful in environments where hosts have NICs or HBA cards that support booting from external iSCSI devices or SAN storage arrays. Such diskless systems are common in large datacenters. +Hypervisor can now be installed on and booted from external disks. This is particularly useful in environments where hosts have NICs or HBA cards that support booting from external iSCSI devices or SAN storage arrays. Such diskless systems are common in large datacenters. -The following sections provide information about installing Harvester on an external iSCSI device. The workflow for SAN arrays is similar, but a different set of kernel arguments may be needed to allow Harvester to successfully boot from a SAN array. +The following sections provide information about installing Hypervisor on an external iSCSI device. The workflow for SAN arrays is similar, but a different set of kernel arguments may be needed to allow Hypervisor to successfully boot from a SAN array. ## iSCSI-Based Installation @@ -48,9 +48,9 @@ See your system provider's documentation for more information about boot setting ![target-details.png](/img/v1.4/external-disk/target-details.png) -### Install Harvester +### Install Hypervisor -You can load the Harvester ISO using any of the standard methods. The installer should automatically detect the iSCSI device. Select this device when you are prompted to specify the installation disk. +You can load the Hypervisor ISO using any of the standard methods. The installer should automatically detect the iSCSI device. Select this device when you are prompted to specify the installation disk. The information displayed on the installer differs slightly when you select an iSCSI target. @@ -86,7 +86,7 @@ The `multiPathConfig` structure has changed since v1.7.0. Check the [latest conf ::: -The test setup uses multiple tagged VLANs, such as VLAN 2017 (used for connecting with the iSCSI volume) and VLAN 2011 (used for the Harvester management interface). +The test setup uses multiple tagged VLANs, such as VLAN 2017 (used for connecting with the iSCSI volume) and VLAN 2011 (used for the Hypervisor management interface). The kernel argument `vlan=enp4s0f0.2017:enp4s0f0 ip=10.115.48.10::10.115.55.254:255.255.248.0::enp4s0f0.2017:none` is necessary only if the iSCSI volume is accessible via an interface on a tagged VLAN. The arguments ensure that an additional tagged interface is created during boot and that a static address is allocated to the interface. See [dracut.cmdline](https://manpages.opensuse.org/Tumbleweed/dracut/dracut.cmdline.7.en.html) for more information about configuring the kernel arguments to match your use case. diff --git a/versioned_docs/version-v1.6/install/harvester-configuration.md b/versioned_docs/version-v1.6/install/harvester-configuration.md index 72c6410..6286927 100644 --- a/versioned_docs/version-v1.6/install/harvester-configuration.md +++ b/versioned_docs/version-v1.6/install/harvester-configuration.md @@ -1,14 +1,14 @@ ---- +ypervisor--- sidebar_position: 5 -sidebar_label: Harvester Configuration -title: "Harvester Configuration" +sidebar_label: Hypervisor Configuration +title: "Hypervisor Configuration" keywords: - - Harvester + - Hypervisor - harvester - Rancher - rancher - - Harvester Configuration -description: Harvester configuration file can be provided during manual or automatic installation to configure various settings. + - Hypervisor Configuration +description: Hypervisor configuration file can be provided during manual or automatic installation to configure various settings. --- @@ -17,7 +17,7 @@ description: Harvester configuration file can be provided during manual or autom ## Configuration Example -Harvester configuration file can be provided during manual or automatic installation to configure various settings. The following is a configuration example: +Hypervisor configuration file can be provided during manual or automatic installation to configure various settings. The following is a configuration example: ```yaml scheme_version: 1 @@ -106,8 +106,8 @@ Below is a reference of all configuration keys. ::: :::note -**Configuration Priority**: When you provide a remote Harvester Configuration file during the install of Harvester, the Harvester Configuration file will not overwrite the values for the inputs you had previously filled out and selected. Priority is given to the values that you input during the guided install. -For instance, if you have in your Harvester Configuration file specified `os.hostname` and during install you fill in the field of `hostname` when prompted, the value that you filled in will take priority over your Harvester Configuration's `os.hostname`. +**Configuration Priority**: When you provide a remote Hypervisor Configuration file during the install of Hypervisor, the Hypervisor Configuration file will not overwrite the values for the inputs you had previously filled out and selected. Priority is given to the values that you input during the guided install. +For instance, if you have in your Hypervisor Configuration file specified `os.hostname` and during install you fill in the field of `hostname` when prompted, the value that you filled in will take priority over your Hypervisor Configuration's `os.hostname`. ::: ### `scheme_version` @@ -116,10 +116,10 @@ For instance, if you have in your Harvester Configuration file specified `os.hos The version of scheme reserved for future configuration migration. -This configuration is mandatory for migrating the configuration to a new scheme version. It tells Harvester the previous version and the need to migrate. +This configuration is mandatory for migrating the configuration to a new scheme version. It tells Hypervisor the previous version and the need to migrate. :::note -This field didn't take any effect in the current Harvester version. +This field didn't take any effect in the current Hypervisor version. ::: :::caution @@ -130,13 +130,13 @@ Make sure that your custom configuration always has the correct scheme version. #### Definition -`server_url` is the URL of the Harvester cluster, which is used for the new `node` to join the cluster. +`server_url` is the URL of the Hypervisor cluster, which is used for the new `node` to join the cluster. This configuration is mandatory when the installation is in `JOIN` mode. The default format of `server_url` is `https://cluster-VIP:443`. :::note -To ensure a high availability (HA) Harvester cluster, please use either the Harvester cluster [VIP](#installvip) or a domain name in `server_url`. +To ensure a high availability (HA) Hypervisor cluster, please use either the Hypervisor cluster [VIP](#installvip) or a domain name in `server_url`. ::: @@ -155,7 +155,7 @@ install: The cluster secret or node token. If the value matches the format of a node token it will automatically be assumed to be a node token. Otherwise it is treated as a cluster secret. -In order for a new node to join the Harvester cluster, the token should match what the server has. +In order for a new node to join the Hypervisor cluster, the token should match what the server has. #### Example @@ -232,7 +232,7 @@ The `os.persistent_state_paths` option allows you to configure custom paths wher #### Example -Refer to the following example config for installing `rook-ceph` in Harvester: +Refer to the following example config for installing `rook-ceph` in Hypervisor: ```yaml os: @@ -252,7 +252,7 @@ You can add additional software packages with `after_install_chroot_commands`. T #### Example -Refer to the following example config for installing an RPM package in Harvester: +Refer to the following example config for installing an RPM package in Hypervisor: ```yaml os: @@ -275,7 +275,7 @@ os: :::note -Upgrading Harvester causes the changes to the OS in the `after-install-chroot` stage to be lost. You must also configure the `after-upgrade-chroot` to make your changes persistent across an upgrade. Refer to [Runtime persistent changes](https://rancher.github.io/elemental-toolkit/docs/customizing/runtime_persistent_changes/) before upgrading Harvester. +Upgrading Hypervisor causes the changes to the OS in the `after-install-chroot` stage to be lost. You must also configure the `after-upgrade-chroot` to make your changes persistent across an upgrade. Refer to [Runtime persistent changes](https://rancher.github.io/elemental-toolkit/docs/customizing/runtime_persistent_changes/) before upgrading Hypervisor. ::: @@ -362,7 +362,7 @@ If you set a password at runtime it will be reset on the next boot. The value of the password can be clear text or an encrypted form. The easiest way to get this encrypted form is to change your password on a Linux system and copy the value of the second field from `/etc/shadow`. You can also encrypt a password using OpenSSL. For the encryption algorithms -supported by Harvester, please refer to the table below. +supported by Hyypervisor, please refer to the table below. | Algorithm | Command | Support | |:---:|:---:|:---:| @@ -406,7 +406,7 @@ os: :::note This example sets the HTTP(S) proxy for **foundational OS components**. -To set up an HTTP(S) proxy for Harvester components such as fetching external images and backup to S3 services, +To set up an HTTP(S) proxy for Hypervisor components such as fetching external images and backup to S3 services, see [Settings/http-proxy](../advanced/settings.md#http-proxy). ::: @@ -431,7 +431,7 @@ os: #### Definition -Subsystem used to configure the OpenSSH Daemon (sshd). Harvester currently only supports `sftp`. +Subsystem used to configure the OpenSSH Daemon (sshd). Hypervisor currently only supports `sftp`. #### Example @@ -448,7 +448,7 @@ os: **Versions**: v1.2.0 and later -**Definition**: Setting that defines the default addon status. Harvester addons are disabled by default. +**Definition**: Setting that defines the default addon status. Hypervisor addons are disabled by default. **Supported values**: - `vm-import-controller` (chartName: harvester-vm-import-controller) @@ -497,7 +497,7 @@ install: ### `install.device` -**Definition**: Device on which the Harvester OS is installed. +**Definition**: Device on which the Hypervisor OS is installed. When installing via PXE, use `/dev/disk/by-id/$id` or `/dev/disk/by-path/$path` to specify the storage device if the server contains multiple physical volumes. @@ -511,9 +511,9 @@ When installing via PXE, use `/dev/disk/by-id/$id` or `/dev/disk/by-path/$path` **Definition**: Setting that forces usage of MBR partitioning on BIOS systems. -Harvester uses GPT partitioning on UEFI and BIOS systems by default. Compatibility issues may require you to use MBR partitioning instead. +Hypervisor uses GPT partitioning on UEFI and BIOS systems by default. Compatibility issues may require you to use MBR partitioning instead. -If you specify the same storage device for both `install.device` and `install.data_disk`, Harvester creates an additional partition for storing VM data. This additional partition is not created when you force usage of MBR partitioning. Instead, VM data is stored in a partition that stores OS data. +If you specify the same storage device for both `install.device` and `install.data_disk`, Hypervisor creates an additional partition for storing VM data. This additional partition is not created when you force usage of MBR partitioning. Instead, VM data is stored in a partition that stores OS data. **Example**: @@ -528,7 +528,7 @@ install: **Definition**: Percentage of the total allocatable CPU on each node to be reserved for each Longhorn Instance Manager pod. -Using the default value is recommended for high system availability. When deploying single-node Harvester clusters, you can specify a value less than 12. +Using the default value is recommended for high system availability. When deploying single-node Hypervisor clusters, you can specify a value less than 12. For more information about how to set the correct value, see [Guaranteed Instance Manager CPU](https://longhorn.io/docs/1.6.0/references/settings/#guaranteed-instance-manager-cpu) in the Longhorn documentation. @@ -549,9 +549,9 @@ For more information about how to set the correct value, see [Guaranteed Instanc **Versions**: v1.1.2 and later -**Definition**: Replica count of the default Harvester StorageClass `harvester-longhorn`. +**Definition**: Replica count of the default Hypervisor StorageClass `harvester-longhorn`. -Using the default value is recommended for high storage availability. When deploying single-node Harvester clusters, you must set the value to 1. +Using the default value is recommended for high storage availability. When deploying single-node Hypervisor clusters, you must set the value to 1. For more information, see [Default Replica Count](https://longhorn.io/docs/1.6.0/references/settings/#default-replica-count) in the Longhorn documentation. @@ -570,17 +570,17 @@ install: ### `install.iso_url` -**Definition**: URL of ISO image to be downloaded and used to install Harvester when booting from the kernel or vmlinuz. +**Definition**: URL of ISO image to be downloaded and used to install Hypervisor when booting from the kernel or vmlinuz. ### `install.management_interface` **Definition**: Network interfaces for the host machine. -Harvester uses the [systemd net naming scheme](https://www.freedesktop.org/software/systemd/man/systemd.net-naming-scheme.html). Ensure that the interface name is present on the target machine before installation. +Hypervisor uses the [systemd net naming scheme](https://www.freedesktop.org/software/systemd/man/systemd.net-naming-scheme.html). Ensure that the interface name is present on the target machine before installation. **Fields**: - `method`: Method used to assign an IP to the network. Supported values: - - `dhcp`: Harvester requests an IP from the DHCP server. + - `dhcp`: Hypervisor requests an IP from the DHCP server. - `static`: IP and gateway addresses are manually assigned. - `ip`: Static IP assigned to the network. This field is required when the value of `method` is `static`. - `subnet_mask`: Subnet mask of the network. This field is required when the value of `method` is `static`. @@ -615,11 +615,11 @@ install: ### `install.mode` -**Definition**: Mode of installing Harvester. +**Definition**: Mode of installing Hypervisor. **Supported values**: -- `create`: Create a new Harvester installation. -- `join`: Join an existing Harvester installation. You must specify the `server_url`. +- `create`: Create a new Hypervisor installation. +- `join`: Join an existing Hypervisor installation. You must specify the `server_url`. **Example**: @@ -657,10 +657,10 @@ install: ### `install.role` -**Definition**: Role assigned to a node at the time of installation. When unspecified, Harvester assigns the `default` role. +**Definition**: Role assigned to a node at the time of installation. When unspecified, Hypervisor assigns the `default` role. - `default`: Allows a node to function as a management node or a worker node. -- `management`: Allows a node to be prioritized when Harvester promotes nodes to management nodes. +- `management`: Allows a node to be prioritized when Hypervisor promotes nodes to management nodes. - `worker`: Restricts a node to being a worker node (never promoted to management node) in a specific cluster. - `witness`: Restricts a node to being a witness node (only functions as an etcd node) in a specific cluster. @@ -698,17 +698,17 @@ install: ### `install.vip` -**Definition**: VIP of the Harvester management endpoint. +**Definition**: VIP of the Hypervisor management endpoint. -After installation, you can access the Harvester UI at `https://`. +After installation, you can access the Hypervisor UI at `https://`. ### `install.vip_mode` **Definition**: Mode of assigning the VIP. **Supported values**: -- `dhcp`: Harvester sends DHCP requests to get the VIP. You must specify the hardware address using the `install.vip_hw_addr` field. -- `static`: Harvester uses a static VIP. +- `dhcp`: Hypervisor sends DHCP requests to get the VIP. You must specify the hardware address using the `install.vip_hw_addr` field. +- `static`: Hypervisor uses a static VIP. **Example**: @@ -735,7 +735,7 @@ install: ### `install.cluster_pod_cidr` -**Definition**: CIDR of the Harvester pods. +**Definition**: CIDR of the Hypervisor pods. Use this field to override the default pod CIDR of 10.52.0.0/16. @@ -748,7 +748,7 @@ install: ### `install.cluster_service_cidr` -**Definition**: CIDR of the Harvester services. +**Definition**: CIDR of the Hypervisor services. Use this field to override the default service CIDR of 10.53.0.0/16. @@ -767,7 +767,7 @@ install: ### `install.cluster_dns` -**Definition**: IP of the Harvester DNS service. +**Definition**: IP of the Hypervisor DNS service. Use this field to override the default DNS service IP of 10.53.0.10. @@ -798,8 +798,8 @@ The installer sends HTTP requests to the specified URL. Multiple requests can be - `FAILED`: The installation was unsuccessful. - `method`: HTTP method - `url`: URL to which HTTP requests are sent -- `insecure`: When set to `true`, Harvester does not verify the server's certificate. The default value is `false`. -- `basicAuth`: When set to `true`, Harvester uses the "Basic" HTTP authentication scheme. +- `insecure`: When set to `true`, Hypervisor does not verify the server's certificate. The default value is `false`. +- `basicAuth`: When set to `true`, Hypervisor uses the "Basic" HTTP authentication scheme. - `headers`: When set to `true`, custom headers are included in the HTTP requests. Headers such as `Content-Length` are automatically included. - `payload`*: When set to `true`, payload data is sent with the HTTP requests. You may need to set the correct Content-Type header in the `headers` field to ensure that the server accepts the request. @@ -865,7 +865,7 @@ install: **Definition**: Setting that determines if images are pulled from the internet after installation. -The value of this field is typically derived from the kernel parameter `harvester.install.with_net_images`. When the value is `true`, Harvester does not preload images packaged in the installation medium, and instead pulls images from the internet when necessary. +The value of this field is typically derived from the kernel parameter `harvester.install.with_net_images`. When the value is `true`, Hypervisor does not preload images packaged in the installation medium, and instead pulls images from the internet when necessary. ---

 

@@ -874,14 +874,14 @@ The value of this field is typically derived from the kernel parameter `harveste #### Definition -You can overwrite the default Harvester system settings by configuring `system_settings`. +You can overwrite the default Hypervisor system settings by configuring `system_settings`. See the [Settings](../advanced/settings.md) page for additional information and the list of all the options. :::note -Overwriting system settings only works when Harvester is installed in "create" mode. -If you install Harvester in "join" mode, this setting is ignored. -Installing in "join" mode will adopt the system settings from the existing Harvester system. +Overwriting system settings only works when Hypervisor is installed in "create" mode. +If you install Hypervisor in "join" mode, this setting is ignored. +Installing in "join" mode will adopt the system settings from the existing Hypervisor system. ::: diff --git a/versioned_docs/version-v1.6/install/install-binaries-mode.md b/versioned_docs/version-v1.6/install/install-binaries-mode.md index e4faabb..7538354 100644 --- a/versioned_docs/version-v1.6/install/install-binaries-mode.md +++ b/versioned_docs/version-v1.6/install/install-binaries-mode.md @@ -1,14 +1,14 @@ --- sidebar_position: 8 -sidebar_label: Install Harvester Binaries Only -title: "Install Harvester Binaries Only" +sidebar_label: Install Hypervisor Binaries Only +title: "Install Hypervisor Binaries Only" keywords: - - Harvester + - Hypervisor - harvester - Rancher - rancher - ISO Installation -description: To get the Harvester ISO, download it from the GitHub releases. During the installation, you can choose to install the binaries only. +description: To get the Hypervisor ISO, download it from the GitHub releases. During the installation, you can choose to install the binaries only. --- @@ -17,26 +17,26 @@ description: To get the Harvester ISO, download it from the GitHub releases. Dur _Available as of v1.2.0_ -The `Install Harvester binaries only` mode allows you to install and configure binaries only, making it ideal for cloud and edge use cases. +The `Install Hypervisor binaries only` mode allows you to install and configure binaries only, making it ideal for cloud and edge use cases. -![choose-installation-mode.png](/img/v1.2/install/choose-installation-mode.png) +![choose-installation-mode.png](/img/v1.2/install-hv/choose-installation-mode.png) ### Background -Currently when a new Harvester node is launched it needs to be the first node in the cluster or join an existing cluster. -These two modes are useful when you already know enough about the environment to install the Harvester node. -However, for use cases such as bare-metal cloud providers and the edge, these installation modes load the OS and Harvester content to the node without letting you configure the network. Moreover, the K8s and networking configuration will not be applied. +Currently when a new Hypervisor node is launched it needs to be the first node in the cluster or join an existing cluster. +These two modes are useful when you already know enough about the environment to install the Hypervisor node. +However, for use cases such as bare-metal cloud providers and the edge, these installation modes load the OS and Hypervisor content to the node without letting you configure the network. Moreover, the K8s and networking configuration will not be applied. -If you choose `Install Harvester binaries only`, you will need to perform additional configuration after the first bootup: +If you choose `Install Hypervisor binaries only`, you will need to perform additional configuration after the first bootup: -- Create/Join option for Harvester +- Create/Join option for Hypervisor - Management network interface details - Cluster token - Node password -Then, the installer will apply the endpoint configuration and boot Harvester. No further reboots will be required. +Then, the installer will apply the endpoint configuration and boot Hypervisor. No further reboots will be required. ### Stream disk mode -Harvester has published a raw image artifact for pre-installed Harvester. The Harvester installer now allows streaming a pre-installed image directly to disk to support better integration with cloud providers. +Hypervisor has published a raw image artifact for pre-installed Hypervisor. The Hypervisor installer now allows streaming a pre-installed image directly to disk to support better integration with cloud providers. On `Equinix Metal`, you can use the following kernel arguments to use the streaming mode: diff --git a/versioned_docs/version-v1.6/install/iso-install.md b/versioned_docs/version-v1.6/install/iso-install.md index 8050ecd..c9ae187 100644 --- a/versioned_docs/version-v1.6/install/iso-install.md +++ b/versioned_docs/version-v1.6/install/iso-install.md @@ -4,21 +4,21 @@ sidebar_position: 2 sidebar_label: ISO Installation title: "ISO Installation" keywords: - - Harvester + - Hypervisor - harvester - Rancher - rancher - ISO Installation -description: To get the Harvester ISO, download it from the Github releases. During the installation you can either choose to form a new cluster, or join the node to an existing cluster. +description: To get the Hypervisor ISO, download it from the Github releases. During the installation you can either choose to form a new cluster, or join the node to an existing cluster. --- -Harvester ships as a bootable appliance image, you can install it directly on a bare metal server with the ISO image. To get the ISO image, download **💿 harvester-v1.x.x-amd64.iso** from the [Harvester releases](https://github.com/harvester/harvester/releases) page. +Hypervisor ships as a bootable appliance image, you can install it directly on a bare metal server with the ISO image. To get the ISO image, download **💿 harvester-v1.x.x-amd64.iso** from the [Hypervisor releases](https://github.com/harvester/harvester/releases) page. -During the installation, you can either choose to **create a new Harvester cluster** or **join the node to an existing Harvester cluster**. +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. @@ -28,7 +28,7 @@ The following [video](https://youtu.be/X0VIGZ_lExQ) shows a quick overview of an ## Installation Steps -1. Mount the Harvester ISO file and boot the server by selecting the `Harvester Installer` option. +1. Mount the Hypervisor ISO file and boot the server by selecting the `Hypervisor Installer` option. ![iso-installation.png](/img/v1.0/install-hv/iso-installation.png) @@ -40,22 +40,22 @@ The following [video](https://youtu.be/X0VIGZ_lExQ) shows a quick overview of an ![choose-installation-mode.png](/img/v1.0/install-hv/choose-installation-mode.png) - - `Create a new Harvester cluster`: creates an entirely new Harvester cluster. + - `Create a new Hypervisor cluster`: creates an entirely new Hypervisor cluster. - - `Join an existing Harvester cluster`: joins an existing Harvester cluster. You need the VIP and cluster token of the cluster you want to join. + - `Join an existing Hypervisor cluster`: joins an existing Hypervisor cluster. You need the VIP and cluster token of the cluster you want to join. - - `Install Harvester binaries only`: If you choose this option, additional setup is required after the first bootup. + - `Install Hypervisor binaries only`: If you choose this option, additional setup is required after the first bootup. :::info - 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 [Harvester configuration](./harvester-configuration.md) on the customize the host step. In this case, at least three different zones are required. + 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 Harvester cluster`. +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`. ![choose-node-role.png](/img/v1.0/install-hv/select-role.png) - `Default Role`: Allows a node to function as a management node or a worker node. This role does not have any specific privileges or restrictions. - - `Management Role`: Allows a node to be prioritized when Harvester promotes nodes to management nodes. + - `Management Role`: Allows a node to be prioritized when Hypervisor promotes nodes to management nodes. - `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. @@ -63,15 +63,15 @@ The following [video](https://youtu.be/X0VIGZ_lExQ) shows a quick overview of an ![config-password.png](/img/v1.2/install/config-password.png) -1. Choose the installation disk you want to install the Harvester cluster on and the data disk you want to store VM data on. By default, Harvester 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). +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). :::info important - Support for legacy BIOS booting is deprecated in v1.7.0 and will be removed in a later release. Existing Harvester 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. + 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. ::: ![choose-installation-target-data-disk.png](/img/v1.0/install-hv/choose-installation-target-data-disk.png) - - `Installation disk`: The disk to install the Harvester cluster on. + - `Installation disk`: The disk to install the Hypervisor cluster on. - `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. @@ -79,7 +79,7 @@ The following [video](https://youtu.be/X0VIGZ_lExQ) shows a quick overview of an ![config-hostname.png](/img/v1.2/install/config-hostname.png) -1. Configure network interface(s) for the management network. By default, Harvester 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. +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. ![config-network.png](/img/v1.0/install-hv/config-network.png) @@ -87,7 +87,7 @@ The following [video](https://youtu.be/X0VIGZ_lExQ) shows a quick overview of an Physical switches connected to `bonded NIC` must be configured strictly as trunk ports. These ports must accept tagged traffic and send traffic tagged with the VLAN ID used by the VM network. - It is not possible to change the node IP throughout the lifecycle of a Harvester 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. + 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. For example: @@ -152,18 +152,18 @@ The following [video](https://youtu.be/X0VIGZ_lExQ) shows a quick overview of an ![import-ssh-keys.png](/img/v1.2/install/import-ssh-keys.png) -1. (Optional) If you need to customize the host with a [Harvester configuration](./harvester-configuration.md) file, enter the `HTTP URL` here. +1. (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) -1. Review and confirm your installation options. After confirming the installation options, Harvester will be installed to your host. The installation may take a few minutes to be complete. +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. ![confirm-install.png](/img/v1.0/install-hv/confirm-install.png) -1. Once the installation is complete, your node restarts. After the restart, the Harvester 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 Harvester console to the Shell and type `exit` to go back to the Harvester console. +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. :::note - Choosing `Install Harvester binaries only` on the first page requires additional setup after the first bootup. + Choosing `Install Hypervisor binaries only` on the first page requires additional setup after the first bootup. ::: ![iso-installed.png](/img/v1.0/install-hv/iso-installed.png) diff --git a/versioned_docs/version-v1.6/install/management-address.md b/versioned_docs/version-v1.6/install/management-address.md index 078efcc..034bc5c 100644 --- a/versioned_docs/version-v1.6/install/management-address.md +++ b/versioned_docs/version-v1.6/install/management-address.md @@ -4,14 +4,14 @@ sidebar_label: Management Address title: "Management Address" keywords: - VIP -description: The Harvester provides a virtual IP as the management address. +description: The Hypervisor 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. +Hypervisor 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. :::note @@ -24,17 +24,17 @@ If you selected the IP address to be configured via DHCP, you will need to confi ## Requirements - The VIP and the node management interfaces must belong to the same subnet. -- All Harvester node management interfaces must be on the same layer-2 network segment. +- All Hypervisor node management interfaces must be on the same layer-2 network segment. Both are required because the VIP relies on the Address Resolution Protocol (ARP), which is a layer-2 protocol. -The VIP can be assigned to any Harvester node management interface and can change at any time (not only when node failure occurs). When the VIP changes hosts, *gratuitous ARPs* are sent so that other hosts on the network know where to direct traffic intended for the Harvester cluster's management IP address (the VIP). +The VIP can be assigned to any Hypervisor node management interface and can change at any time (not only when node failure occurs). When the VIP changes hosts, *gratuitous ARPs* are sent so that other hosts on the network know where to direct traffic intended for the Hypervisor cluster's management IP address (the VIP). :::warning -If you plan to host a Harvester cluster in a bare metal data center, the service provider will likely designate a "floating" or "reserved" IP address as the VIP that you can assign to one of your servers. Updating this assignment causes traffic to instantly start flowing to the new node it is assigned to. In these situations, Harvester is unable to update the floating/reserved IP assignment in your provider's systems when the VIP changes hosts. +If you plan to host a Hypervisor cluster in a bare metal data center, the service provider will likely designate a "floating" or "reserved" IP address as the VIP that you can assign to one of your servers. Updating this assignment causes traffic to instantly start flowing to the new node it is assigned to. In these situations, Hypervisor is unable to update the floating/reserved IP assignment in your provider's systems when the VIP changes hosts. -Furthermore, the VIP's "gratuitous ARPs" may also be ineffective depending on your provider's networking setup between your Harvester nodes (for example, if your Harvester hosts are not on the same layer-2 network). You must update the floating/reserved IP assignment manually when the VIP changes hosts to ensure that the cluster functions properly. For more information, see [Finding which node the VIP is on](#identifying-the-node-the-vip-is-assigned-to). +Furthermore, the VIP's "gratuitous ARPs" may also be ineffective depending on your provider's networking setup between your Hypervisor nodes (for example, if your Hypervisor hosts are not on the same layer-2 network). You must update the floating/reserved IP assignment manually when the VIP changes hosts to ensure that the cluster functions properly. For more information, see [Finding which node the VIP is on](#identifying-the-node-the-vip-is-assigned-to). ::: @@ -52,7 +52,7 @@ Example of output: ## Identifying the Node the VIP Is Assigned To -You can use kubectl (either on your local machine with the Harvester kubeconfig file, or when using SSH to connect to any Harvester management node as a root user). +You can use kubectl (either on your local machine with the Hypervisor kubeconfig file, or when using SSH to connect to any Hypervisor management node as a root user). ```console kubectl -n kube-system get svc ingress-expose -o jsonpath='{.metadata.annotations.kube-vip\.io/vipHost}' @@ -63,7 +63,7 @@ Example output: harvester-xzj76 ``` -Alternatively, you can use SSH to connect to each Harvester management node and then run the command `ip address show mgmt-br`. +Alternatively, you can use SSH to connect to each Hypervisor management node and then run the command `ip address show mgmt-br`. Example: @@ -82,6 +82,6 @@ When the output includes both the VIP and the node address, the VIP is assigned ## Usages The management address: -- Allows the access to the Harvester API/UI via `HTTPS` protocol. +- 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) diff --git a/versioned_docs/version-v1.6/install/net-install.md b/versioned_docs/version-v1.6/install/net-install.md index c5a3291..87ad0a2 100644 --- a/versioned_docs/version-v1.6/install/net-install.md +++ b/versioned_docs/version-v1.6/install/net-install.md @@ -1,33 +1,33 @@ ---- +ypervisor--- sidebar_position: 9 sidebar_label: Net Install ISO title: "Net Install ISO" keywords: - - Harvester + - Hypervisor - Net ISO Installation - BMC ISO Redirection - BMC Virtual Media -description: Harvester Net Install ISO is a minimal ISO that contains only the OS binaries. It's useful for some situations. +description: Hypervisor Net Install ISO is a minimal ISO that contains only the OS binaries. It's useful for some situations. --- -The Harvester net install ISO is a minimal installation image that contains only the core OS components, allowing the installer to boot and then install the Harvester OS on a disk. After installation is completed, the Harvester OS pulls all required container images from the internet (mostly from Docker Hub). +The Hypervisor net install ISO is a minimal installation image that contains only the core OS components, allowing the installer to boot and then install the Hypervisor OS on a disk. After installation is completed, the Hypervisor OS pulls all required container images from the internet (mostly from Docker Hub). You can use the net install ISO in the following situations: - The virtual media implementation on a server is buggy or slow. Community users have reported that ISO redirection is too slow to preload all images onto a system. For more information, see [Issue 2651](https://github.com/harvester/harvester/issues/2651). -- You have a private registry that contains all Harvester images, as well as the knowledge and experience required to configure image mirrors for containerd. +- You have a private registry that contains all Hypervisor images, as well as the knowledge and experience required to configure image mirrors for containerd. :::caution -**You must always use the full ISO to bootstrap a Harvester cluster** (in other words, use the ISO without the `-net-install` suffix). The full ISO contains all required images, and the installer preloads those images during installation. You can easily reach the [Docker Hub rate limit](https://docs.docker.com/docker-hub/download-rate-limit/) when using a net install ISO to bootstrap the Harvester cluster. +**You must always use the full ISO to bootstrap a Hypervisor cluster** (in other words, use the ISO without the `-net-install` suffix). The full ISO contains all required images, and the installer preloads those images during installation. You can easily reach the [Docker Hub rate limit](https://docs.docker.com/docker-hub/download-rate-limit/) when using a net install ISO to bootstrap the Hypervisor cluster. ::: ## Usage -Download the net install ISO from the GitHub [Releases](https://github.com/harvester/harvester/releases) page, and then boot the ISO to install Harvester. Net install ISO file names have the suffix `net-install` (for example, https://releases.rancher.com/harvester/v1.3.0/harvester-v1.3.0-amd64-net-install.iso). +Download the net install ISO from the GitHub [Releases](https://github.com/harvester/harvester/releases) page, and then boot the ISO to install Hypervisor. Net install ISO file names have the suffix `net-install` (for example, https://releases.rancher.com/harvester/v1.3.0/harvester-v1.3.0-amd64-net-install.iso). ## PXE Installation diff --git a/versioned_docs/version-v1.6/install/post-install.md b/versioned_docs/version-v1.6/install/post-install.md index 562f303..aede10a 100644 --- a/versioned_docs/version-v1.6/install/post-install.md +++ b/versioned_docs/version-v1.6/install/post-install.md @@ -2,6 +2,7 @@ sidebar_position: 11 sidebar_label: Post-installation steps title: "Post-Installation Steps" +draft: true keywords: - Harvester - Installation @@ -13,7 +14,7 @@ description: Post-installation steps. -You can enhance the security and performance of your Harvester cluster by performing the following procedures after installation is completed. +You can enhance the security and performance of your Hypervisor cluster by performing the following procedures after installation is completed. ## Disable SSH Password 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 1f642ea..738e7e6 100644 --- a/versioned_docs/version-v1.6/install/pxe-boot-install.md +++ b/versioned_docs/version-v1.6/install/pxe-boot-install.md @@ -18,11 +18,11 @@ description: Starting from version `0.2.0`, Harvester can be installed automatic -Starting from version `0.2.0`, Harvester can be installed automatically. This document provides an example to do an automatic installation with PXE boot. +Starting from version `0.2.0`, Hypervisor can be installed automatically. This document provides an example to do an automatic installation with PXE boot. We recommend using [iPXE](https://ipxe.org/) to perform the network boot. It has more features than the traditional PXE Boot program and is likely available in modern NIC cards. If the iPXE firmware is not available for your NIC card, the iPXE firmware images can be loaded from the TFTP server first. -To see sample iPXE scripts, please visit [Harvester iPXE Examples](https://github.com/harvester/ipxe-examples). +To see sample iPXE scripts, please visit [Hypervisor iPXE Examples](https://github.com/harvester/ipxe-examples). ## Prerequisite @@ -39,7 +39,7 @@ Let's assume the NGINX HTTP server's IP is `10.100.0.10`, and it serves the `/us ## Preparing Boot Files -- Download the required files from the [Harvester releases page](https://github.com/harvester/harvester/releases). +- Download the required files from the [Hypervisor releases page](https://github.com/harvester/harvester/releases). - The ISO: `harvester--amd64.iso` - The kernel: `harvester--vmlinuz-amd64` - The initrd: `harvester--initrd-amd64` @@ -61,10 +61,10 @@ Let's assume the NGINX HTTP server's IP is `10.100.0.10`, and it serves the `/us When performing an automatic installation, there are two modes: -- `CREATE`: we are installing a node to construct an initial Harvester cluster. -- `JOIN`: we are installing a node to join an existing Harvester cluster. +- `CREATE`: we are installing a node to construct an initial Hypervisor cluster. +- `JOIN`: we are installing a node to join an existing Hypervisor cluster. -Harvester v1.3.0 introduces roles that you can assign to nodes to support different scenarios. For more information, see [Harvester Configuration](harvester-configuration#installrole). + ### CREATE Mode @@ -74,7 +74,7 @@ Harvester v1.3.0 introduces roles that you can assign to nodes to support differ ::: -Create a [Harvester configuration file](./harvester-configuration.md) called `config-create.yaml` for `CREATE` mode. Modify the values as needed: +Create a [Hypervisor configuration file](./harvester-configuration.md) called `config-create.yaml` for `CREATE` mode. Modify the values as needed: ```YAML # cat /usr/share/nginx/html/harvester/config-create.yaml @@ -136,7 +136,7 @@ Use `ip=` parameter to designate the booting interface only, as we only support ::: -Create a [Harvester configuration file](./harvester-configuration.md) called `config-join.yaml` for `JOIN` mode. Modify the values as needed: +Create a [Hypervisor configuration file](./harvester-configuration.md) called `config-join.yaml` for `JOIN` mode. Modify the values as needed: ```YAML # cat /usr/share/nginx/html/harvester/config-join.yaml @@ -184,7 +184,7 @@ This assumes the iPXE script is stored in `/usr/share/nginx/html/harvester/ipxe- :::note -In the PXE installation scenario, 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 the PXE installation scenario, 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. In the ISO installation scenario, when the management network interface is in DHCP mode, you are also required to add the *routers* option (`option routers`) when configuring the DHCP server. @@ -335,9 +335,9 @@ The Internet Systems Consortium (ISC) announced the final [end-of-life (EOL) for ] ``` -## Harvester Configuration +## Hypervisor Configuration -For more information about Harvester configuration, please refer to the [Harvester configuration](./harvester-configuration.md) page. +For more information about Hypervisor configuration, please refer to the [Hypervisor configuration](./harvester-configuration.md) page. By default, the first node will be the management node of the cluster. When there are 3 nodes, the other 2 nodes added first are automatically promoted to management nodes to form an HA cluster. @@ -427,7 +427,7 @@ The parameter `initrd=harvester--initrd` is required. ## Tagged VLAN Network Boot -To perform PXE boot over tagged VLAN network, the Harvester hosts must be configured with the following BIOS/UEFI settings: +To perform PXE boot over tagged VLAN network, the Hypervisor hosts must be configured with the following BIOS/UEFI settings: - VLAN ID is set to the network identity - Boot protocol is set to `PXE` @@ -458,7 +458,7 @@ boot ## Useful Kernel Parameters -Besides the Harvester configuration, you can also specify other kernel parameters that are useful in different scenarios. +Besides the Hypervisor configuration, you can also specify other kernel parameters that are useful in different scenarios. See also [dracut.cmdline(7)](https://man7.org/linux/man-pages/man7/dracut.cmdline.7.html). ### `ip=dhcp` @@ -492,4 +492,4 @@ Specifies what teletype console to start the installer on. ### `net.ifnames=1` -Enables predictable network interface names in the installer, which will match the system default after Harvester is installed. This allows the system to utilize the correct interfaces. +Enables predictable network interface names in the installer, which will match the system default after Hypervisor is installed. This allows the system to utilize the correct interfaces. diff --git a/versioned_docs/version-v1.6/install/requirements.md b/versioned_docs/version-v1.6/install/requirements.md index 1215405..9a18e75 100644 --- a/versioned_docs/version-v1.6/install/requirements.md +++ b/versioned_docs/version-v1.6/install/requirements.md @@ -5,22 +5,22 @@ sidebar_label: Hardware and Network Requirements title: "Hardware and Network Requirements" keywords: - Installation Requirements -description: Outline the Harvester installation requirements +description: Outline the Hypervisor installation requirements --- -As an HCI solution on bare metal servers, there are minimum node hardware and network requirements for installing and running Harvester. +As an HCI solution on bare metal servers, there are minimum node hardware and network requirements for installing and running Hypervisor. -A three-node cluster is required to fully realize the multi-node features of Harvester. The first node that is added to the cluster is by default the management node. When the cluster has three or more nodes, the two nodes added after the first are automatically promoted to management nodes to form a high availability (HA) cluster. +A three-node cluster is required to fully realize the multi-node features of Hypervisor. The first node that is added to the cluster is by default the management node. When the cluster has three or more nodes, the two nodes added after the first are automatically promoted to management nodes to form a high availability (HA) cluster. -Certain versions of Harvester support the deployment of [single-node clusters](https://docs.harvesterhci.io/v1.3/advanced/singlenodeclusters). Such clusters do not support high availability, multiple replicas, and live migration. +Certain versions of Hypervisor support the deployment of [single-node clusters](https://docs.harvesterhci.io/v1.3/advanced/singlenodeclusters). Such clusters do not support high availability, multiple replicas, and live migration. ## Hardware Requirements -Harvester nodes have the following hardware requirements and recommendations for installation and testing. +Hypervisor nodes have the following hardware requirements and recommendations for installation and testing. | Hardware | Development/Testing | Production | | :--- | :--- | :--- | @@ -34,17 +34,17 @@ Harvester nodes have the following hardware requirements and recommendations for :::info important - Mixed-architecture clusters are not supported. Deploy separate clusters to avoid unexpected system behavior. -- For best results, use [YES-certified hardware](https://www.suse.com/partners/ihv/yes/) for SUSE Linux Enterprise Server (SLES) 15 SP3 or SP4. Harvester is built on SLE technology and YES-certified hardware has additional validation of driver and system board compatibility. Laptops and nested virtualization are not supported. -- Nested virtualization is not supported on virtual machines running on Harvester. +- For best results, use [YES-certified hardware](https://www.suse.com/partners/ihv/yes/) for SUSE Linux Enterprise Server (SLES) 15 SP3 or SP4. Hypervisor is built on SLE technology and YES-certified hardware has additional validation of driver and system board compatibility. Laptops and nested virtualization are not supported. +- Nested virtualization is not supported on virtual machines running on Hypervisor. - Each node must have a unique `product_uuid` (fetched from `/sys/class/dmi/id/product_uuid`) to prevent errors from occurring during VM live migration and other operations. For more information, see [Issue #4025](https://github.com/harvester/harvester/issues/4025). -- Harvester has a [built-in management cluster network](../networking/clusternetwork.md#built-in-cluster-network) (`mgmt`). To achieve high availability and the best performance in production environments, use at least two NICs in each node to set up a bonded NIC for the management network (see step 6 in [ISO Installation](../install/iso-install.md#installation-steps)). You can also create [custom cluster networks](../networking/clusternetwork.md#custom-cluster-network) for VM workloads. Each custom cluster network requires at least two additional NICs to set up a bonded NIC in every involved node of the Harvester cluster. The [witness node](../advanced/witness.md) does not require additional NICs. For more information, see [Cluster Network](../networking/clusternetwork.md#concepts). +- Hypervisor has a [built-in management cluster network](../networking/clusternetwork.md#built-in-cluster-network) (`mgmt`). To achieve high availability and the best performance in production environments, use at least two NICs in each node to set up a bonded NIC for the management network (see step 6 in [ISO Installation](../install/iso-install.md#installation-steps)). You can also create [custom cluster networks](../networking/clusternetwork.md#custom-cluster-network) for VM workloads. Each custom cluster network requires at least two additional NICs to set up a bonded NIC in every involved node of the Hypervisor cluster. The [witness node](../advanced/witness.md) does not require additional NICs. For more information, see [Cluster Network](../networking/clusternetwork.md#concepts). - During testing, you can use only one NIC for the [built-in management cluster network](../networking/clusternetwork.md#built-in-cluster-network) (`mgmt`), and for testing the [VM network](../networking/harvester-network.md#create-a-vm-network) that is also carried by `mgmt`. High availability and optimal performance are not guaranteed. - If the disk only meets the minimum required capacity, you may encounter issues related to the [free system partition space requirement](../upgrade/automatic.md#free-system-partition-space-requirement) during upgrades. ::: ### CPU Specifications -[Live Migration](../vm/live-migration.md) functions correctly only if the CPUs of all physical servers in the [Harvester cluster](../getting-started/glossary.md#harvester-cluster) have the same specifications. This requirement applies to all operations that rely on Live Migration functionality, such as automatic VM migration when [Maintenance Mode](../host/host.md#node-maintenance) is enabled. +[Live Migration](../vm/live-migration.md) functions correctly only if the CPUs of all physical servers in the [Hypervisor cluster](../getting-started/glossary.md#harvester-cluster) have the same specifications. This requirement applies to all operations that rely on Live Migration functionality, such as automatic VM migration when [Maintenance Mode](../host/host.md#node-maintenance) is enabled. Newer CPUs (even those from the same vendor, generation, and family) can have varying capabilities that may be exposed to VM operating systems. To ensure VM stability, Live Migration checks if the CPU capabilities are consistent, and blocks migration attempts when the source and destination are incompatible. @@ -52,60 +52,60 @@ When creating clusters, adding more hosts to a cluster, and replacing hosts, alw ## Network Requirements -Harvester nodes have the following network requirements for installation. +Hypervisor nodes have the following network requirements for installation. -### Port Requirements for Harvester Nodes + + +### Port Requirements for Integrating Hypervisor with Rancher + +If you want to [integrate Hypervisor with Rancher](../rancher/rancher-integration.md), you need to make sure that all Hypervisor nodes can connect to TCP port **443** of the Rancher load balancer. + +When provisioning VMs with Kubernetes clusters from Rancher into Hypervisor, you need to be able to connect to TCP port **443** of the Rancher load balancer. Otherwise, the cluster won't be manageable by Rancher. For more information, refer to [Rancher Architecture](https://ranchermanager.docs.rancher.com/v2.7/reference-guides/rancher-manager-architecture/communicating-with-downstream-user-clusters). ### Port Requirements for K3s or RKE2 Clusters -For the port requirements for guest clusters deployed inside Harvester VMs, refer to the following links: +For the port requirements for guest clusters deployed inside Hypervisor VMs, refer to the following links: - [K3s Networking](https://rancher.com/docs/k3s/latest/en/installation/installation-requirements/#networking) - [RKE2 Networking](https://docs.rke2.io/install/requirements#networking) ## Time Requirements -A reliable Network Time Protocol (NTP) server is critical for maintaining the correct system time across all nodes in a Kubernetes cluster, especially when running Harvester. Kubernetes relies on etcd, a distributed key-value store, which requires precise time synchronization to ensure data consistency and prevent issues with leader election, log replication, and cluster stability. +A reliable Network Time Protocol (NTP) server is critical for maintaining the correct system time across all nodes in a Kubernetes cluster, especially when running Hypervisor. Kubernetes relies on etcd, a distributed key-value store, which requires precise time synchronization to ensure data consistency and prevent issues with leader election, log replication, and cluster stability. Ensuring accurate and consistent time across the cluster is essential for reliability, security, and overall system integrity. diff --git a/versioned_docs/version-v1.6/install/update-harvester-configuration.md b/versioned_docs/version-v1.6/install/update-harvester-configuration.md index 6f735ec..2f06230 100644 --- a/versioned_docs/version-v1.6/install/update-harvester-configuration.md +++ b/versioned_docs/version-v1.6/install/update-harvester-configuration.md @@ -1,20 +1,20 @@ --- sidebar_position: 6 -sidebar_label: Update Harvester Configuration -title: "Update Harvester Configuration After Installation" +sidebar_label: Update Hypervisor Configuration +title: "Update Hypervisor Configuration After Installation" keywords: - - Harvester configuration + - Hypervisor configuration - Configuration -description: How to update Harvester configuration after installation +description: How to update Hypervisor configuration after installation --- -Harvester's OS has an immutable design, which means most files in the OS revert to their pre-configured state after a reboot. The Harvester OS loads the pre-configured values of system components from configuration files during the boot time. +Hypervisor's OS has an immutable design, which means most files in the OS revert to their pre-configured state after a reboot. The Hypervisor OS loads the pre-configured values of system components from configuration files during the boot time. -This page describes how to edit some of the most-requested Harvester configurations. To update a configuration, you must first update the runtime value in the system and then update configuration files to make the changes persistent between reboots. +This page describes how to edit some of the most-requested Hypervisor configurations. To update a configuration, you must first update the runtime value in the system and then update configuration files to make the changes persistent between reboots. :::note @@ -26,7 +26,7 @@ If you upgrade from a version before `v1.1.2`, the `cloud-init` file in examples ### Runtime change -1. Log in to a Harvester node and become root. See [how to log into a Harvester node](../troubleshooting/os.md#how-to-log-in-to-a-harvester-node) for more details. +1. Log in to a Hypervisor node and become root. See [how to log into a Hypervisor node](../troubleshooting/os.md#how-to-log-in-to-a-harvester-node) for more details. 1. Edit `/etc/sysconfig/network/config` and update the following line. Use a space to separate DNS server addresses if there are multiple servers. ``` @@ -55,9 +55,9 @@ If you upgrade from a version before `v1.1.2`, the `cloud-init` file in examples ### Configuration persistence -Beginning with v1.1.2, the persistent name of the cloud-init file is `/oem/90_custom.yaml`. Harvester now uses a newer version of Elemental, which creates the file during installation. +Beginning with v1.1.2, the persistent name of the cloud-init file is `/oem/90_custom.yaml`. Hypervisor now uses a newer version of Elemental, which creates the file during installation. -When upgrading from an earlier version to `v1.1.2` or later, Harvester retains the old file name (`/oem/99_custom.yaml`) to avoid confusion. You can manually rename the file to `/oem/90_custom.yaml` if necessary. +When upgrading from an earlier version to `v1.1.2` or later, Hypervisor retains the old file name (`/oem/99_custom.yaml`) to avoid confusion. You can manually rename the file to `/oem/90_custom.yaml` if necessary. 1. Backup the elemental `cloud-init` file `/oem/90_custom.yaml` as follows: @@ -76,20 +76,20 @@ When upgrading from an earlier version to `v1.1.2` or later, Harvester retains t - sed -i 's/^NETCONFIG_DNS_STATIC_SERVERS.*/NETCONFIG_DNS_STATIC_SERVERS="8.8.8.8 1.1.1.1"/' /etc/sysconfig/network/config ``` - Replace the DNS server addresses and save the file. Harvester sets up new servers after rebooting. + Replace the DNS server addresses and save the file. Hypervisor sets up new servers after rebooting. ## NTP servers -We introduce the new mechanism for the NTP configuration in Harvester v1.2.0. +We introduce the new mechanism for the NTP configuration in Hypervisor v1.2.0. -For more information about NTP settings in Harvester v1.2.0 and later versions, see the [NTP servers](../host/host.md#ntp-configuration). +For more information about NTP settings in Hypervisor v1.2.0 and later versions, see the [NTP servers](../host/host.md#ntp-configuration). ## Password of user `rancher` ### Runtime change -1. Log in to a Harvester node as user `rancher`. See [how to log into a Harvester node](../troubleshooting/os.md#how-to-log-in-to-a-harvester-node) for more details. +1. Log in to a Hypervisor node as user `rancher`. See [how to log into a Hypervisor node](../troubleshooting/os.md#how-to-log-in-to-a-harvester-node) for more details. 1. To reset the password for the user `rancher`, run the command `passwd`. ### Configuration persistence @@ -105,11 +105,11 @@ For more information about NTP settings in Harvester v1.2.0 and later versions, ## Bonding slaves -You can update the slave interfaces of Harvester's management bonding interface `mgmt-bo`. +You can update the slave interfaces of Hypervisor's management bonding interface `mgmt-bo`. ### Runtime change -1. Log in to a Harvester node and become root. See [how to log into a Harvester node](../troubleshooting/os.md#how-to-log-in-to-a-harvester-node) for more details. +1. Log in to a Hypervisor node and become root. See [how to log into a Hypervisor node](../troubleshooting/os.md#how-to-log-in-to-a-harvester-node) for more details. 1. Identify the interface names with the following command: ``` diff --git a/versioned_docs/version-v1.6/install/usb-install.md b/versioned_docs/version-v1.6/install/usb-install.md index 19a6e88..0eb9843 100644 --- a/versioned_docs/version-v1.6/install/usb-install.md +++ b/versioned_docs/version-v1.6/install/usb-install.md @@ -17,7 +17,7 @@ There are a couple of ways to create a USB installation flash drive. To resolve this, you can use the patched [ISO](https://releases.rancher.com/harvester/v1.2.0/harvester-v1.2.0-patch1-amd64.iso). This patched version only corrects the partition label, and there are no other changes. You can also use the related sha512 [file](https://releases.rancher.com/harvester/v1.2.0/harvester-v1.2.0-patch1-amd64.iso.sha512sum) to verify the ISO. -Refer to the [Harvester interactive ISO hangs with the USB installation method](#harvester-interactive-iso-hangs-with-the-usb-installation-method) for details and a workaround. +Refer to the [Hypervisor interactive ISO hangs with the USB installation method](#harvester-interactive-iso-hangs-with-the-usb-installation-method) for details and a workaround. No matter which tool you use, creating a bootable device erases your USB device data. Please back up all data on your USB device before making a bootable device. ::: @@ -27,7 +27,7 @@ No matter which tool you use, creating a bootable device erases your USB device [Rufus](https://rufus.ie/) allows you to create an ISO image on your USB flash drive on a Windows computer. 1. Open Rufus and insert a clean USB stick into your computer. 2. Rufus automatically detects your USB. Select the USB device you want to use from the **Device** drop-down menu. -3. For **Boot Selection**, choose **Select** and find the Harvester installation ISO image you want to burn onto the USB. +3. For **Boot Selection**, choose **Select** and find the Hypervisor installation ISO image you want to burn onto the USB. Rufus setup