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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/v1.0/install-hv/config-dns-server.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/v1.0/install-hv/config-hostname.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/v1.0/install-hv/config-ntp-server.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/v1.0/install-hv/config-password.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/v1.0/install-hv/config-proxy.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/v1.0/install-hv/edit-menu-entry.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/v1.0/install-hv/force-resolution.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/v1.0/install-hv/grub-menu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/v1.0/install-hv/import-ssh-keys.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/v1.0/install-hv/remote-config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/v1.2/cluster-resource-usage.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/v1.2/host-resource-usage.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 3 additions & 3 deletions versioned_docs/version-v1.6/install/external-disk-support.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
---


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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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`

Expand Down
70 changes: 35 additions & 35 deletions versioned_docs/version-v1.6/install/iso-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
<!-- The following [video](https://youtu.be/X0VIGZ_lExQ) shows a quick overview of an ISO installation.

<div class="text-center">
<iframe width="800" height="400" src="https://www.youtube.com/embed/X0VIGZ_lExQ" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
</div>
</div> -->

## Installation Steps

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

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

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

Expand All @@ -89,18 +89,18 @@ 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
default via 192.168.122.1 dev mgmt-br proto dhcp
```
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.

Expand All @@ -120,55 +120,55 @@ 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.
:::

![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/<username>.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/<username>.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.
:::

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

Expand All @@ -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.
<!-- In some cases, if you are using an older graphics card/monitor, you may encounter a `panic: invalid dimensions` error during ISO installation.

![invalid-dimensions.png](/img/v1.2/install/invalid-dimensions.png)
![invalid-dimensions.png](/img/v1.2/install/invalid-dimensions.png) -->

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.

Expand All @@ -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.
4 changes: 2 additions & 2 deletions versioned_docs/version-v1.6/install/management-address.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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)
12 changes: 6 additions & 6 deletions versioned_docs/version-v1.6/install/post-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_label: Post-installation steps
title: "Post-Installation Steps"
draft: true
keywords:
- Harvester
- Hypervisor
- Installation
description: Post-installation steps.
---
Expand All @@ -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 <<EOF | kubectl apply -f -
Expand All @@ -30,7 +30,7 @@ metadata:
name: ssh-config
spec:
matchSelector:
harvesterhci.io/managed: "true" # apply to all Harvester nodes
harvesterhci.io/managed: "true" # apply to all Hypervisor nodes
filename: 99-ssh-config
contents: |
stages:
Expand All @@ -47,12 +47,12 @@ EOF

:::note

- The `matchSelector` field is used to select Harvester nodes with specific labels.
- The `matchSelector` field is used to select Hypervisor nodes with specific labels.
- All the affected nodes must be rebooted for the `CloudInit` configuration to take effect.

:::

Once the configuration is applied, any attempts to access the Harvester nodes with the SSH password are denied.
Once the configuration is applied, any attempts to access the Hypervisor nodes with the SSH password are denied.

```sh
$ ssh -o PreferredAuthentications=password rancher@<node-ip>
Expand Down
14 changes: 7 additions & 7 deletions versioned_docs/version-v1.6/install/pxe-boot-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
---

<head>
Expand Down Expand Up @@ -103,7 +103,7 @@ install:
iso_url: http://10.100.0.10/harvester/harvester-<version>-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
```
Expand Down Expand Up @@ -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
```

Expand Down
Loading
Loading