Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions versioned_docs/version-v1.6/install/external-disk-support.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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.

Expand Down Expand Up @@ -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.

Expand Down
98 changes: 49 additions & 49 deletions versioned_docs/version-v1.6/install/harvester-configuration.md

Large diffs are not rendered by default.

26 changes: 13 additions & 13 deletions versioned_docs/version-v1.6/install/install-binaries-mode.md
Original file line number Diff line number Diff line change
@@ -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.
---

<head>
Expand All @@ -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:

Expand Down
40 changes: 20 additions & 20 deletions versioned_docs/version-v1.6/install/iso-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
---

<head>
<link rel="canonical" href="https://docs.harvesterhci.io/v1.7/install/index"/>
</head>

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.

Expand All @@ -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)

Expand All @@ -40,54 +40,54 @@ 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.

1. 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)

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.

1. Configure the `HostName` of the node.

![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)

:::note

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:
Expand Down Expand Up @@ -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)
Expand Down
Loading
Loading