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: 9 additions & 1 deletion src/css/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -188,4 +188,12 @@ a.btn.navbar__github::before {

.openapi-left-panel__container{
border-right: 0px !important;
}
}
/* Hide items with hide-sidebar-item class (used to hide Upgrade section) */
.menu__list-item.hide-sidebar-item { display: none !important; }

/* Hide Troubleshooting > Rancher doc entry explicitly */
.menu__list-item a.menu__link[href*="/troubleshooting/rancher"] {
display: none !important;
}

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.
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.
111 changes: 0 additions & 111 deletions static/img/v1.2/advanced-hv/customsuseimages.md

This file was deleted.

Binary file added static/img/v1.2/advanced-hv/kubeovn-operator.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.2/advanced-hv/no-uplink.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.
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.
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.
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.
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.
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.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16 changes: 8 additions & 8 deletions versioned_docs/version-v1.6/advanced/addons/kubeovn-operator.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,19 +10,19 @@ title: "Kube-OVN Operator"

_Available as of v1.6.0_

[`kubeovn-operator`](https://github.com/harvester/kubeovn-operator) is used to manage the lifecycle of [Kube-OVN](https://github.com/kubeovn/kube-ovn) as a secondary CNI on underlying Harvester clusters.
[`kubeovn-operator`](https://github.com/harvester/kubeovn-operator) is used to manage the lifecycle of [Kube-OVN](https://github.com/kubeovn/kube-ovn) as a secondary CNI on underlying Hypervisor clusters.

## Enabling `kubeovn-operator`

You must enable `kubeovn-operator` to deploy Kube-OVN to a Harvester cluster for advanced SDN capabilities such as virtual private cloud (VPC) and subnets for virtual machine workloads.
You must enable `kubeovn-operator` to deploy Kube-OVN to a Hypervisor cluster for advanced SDN capabilities such as virtual private cloud (VPC) and subnets for virtual machine workloads.

1. On the Harvester UI, go to **Advanced** > **Add-ons**.
1. On the Hypervisor UI, go to **Advanced** > **Add-ons**.

1. Select **kubeovn-operator (Experimental)**, and then select **⋮** > **Enable**.

![](/img/kubeovn-operator.png)
![](/img/v1.2/advanced-hv/kubeovn-operator.png)

The add-on deploys `kubeovn-operator` and creates the default `Configuration` object named `configuration.kubeovn.io`, which uses sane Harvester-specific defaults for configuring the Kube-OVN CNI.
The add-on deploys `kubeovn-operator` and creates the default `Configuration` object named `configuration.kubeovn.io`, which uses sane Hypervisor-specific defaults for configuring the Kube-OVN CNI.

The following is an example of a `Configuration` object:

Expand Down Expand Up @@ -181,13 +181,13 @@ spec:

:::info important

Ensure that the Kube-OVN IPv4 pod and service CIDR blocks do not overlap with the Harvester pod and service CIDR blocks.
Ensure that the Kube-OVN IPv4 pod and service CIDR blocks do not overlap with the Hypervisor pod and service CIDR blocks.

:::

:::caution

This `Configuration` object has been validated against Harvester installations. You can fine-tune the object by editing the `kubeovn-operator` add-on YAML, but exercise caution when making changes to the `configurationSpec` field.
This `Configuration` object has been validated against Hypervisor installations. You can fine-tune the object by editing the `kubeovn-operator` add-on YAML, but exercise caution when making changes to the `configurationSpec` field.

:::

Expand Down Expand Up @@ -250,4 +250,4 @@ done

You must reboot each node to complete the uninstallation process.

Once the nodes are rebooted, you can disable the `kubeovn-operator` add-on from the Harvester UI.
Once the nodes are rebooted, you can disable the `kubeovn-operator` add-on from the Hypervisor UI.
22 changes: 11 additions & 11 deletions versioned_docs/version-v1.6/advanced/addons/lvm-local-storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,25 +10,25 @@ title: "Local Storage Support (Experimental)"

:::note

**harvester-csi-driver-lvm** is an *experimental* add-on. It is not included in the Harvester ISO, but you can download it from the [experimental-addons repository](https://github.com/harvester/experimental-addons). For more information about experimental features, see [Feature Labels](../../getting-started/document-conventions.md#feature-labels).
**harvester-csi-driver-lvm** is an *experimental* add-on. It is not included in the Hypervisor ISO, but you can download it from the [experimental-addons repository](https://github.com/harvester/experimental-addons). For more information about experimental features, see [Feature Labels](../../getting-started/document-conventions.md#feature-labels).

:::

Harvester allows you to use local storage on the host to create persistent volumes for your workloads with better performance and latency. This functionality is made possible by LVM, which provides logical volume management facilities on Linux.
Hypervisor allows you to use local storage on the host to create persistent volumes for your workloads with better performance and latency. This functionality is made possible by LVM, which provides logical volume management facilities on Linux.

The **harvester-csi-driver-lvm** add-on is a CSI driver that supports local path provisioning through LVM.

## Installing and Enabling the Add-on

If you are using the Harvester kubeconfig file, you can install the add-on by performing the following steps:
If you are using the Hypervisor kubeconfig file, you can install the add-on by performing the following steps:

1. Install the add-on by running the following command:

```
# kubectl apply -f https://raw.githubusercontent.com/harvester/experimental-addons/main/harvester-csi-driver-lvm/harvester-csi-driver-lvm.yaml
```

1. On the Harvester UI, go to **Advanced** > **Add-ons**.
1. On the Hypervisor UI, go to **Advanced** > **Add-ons**.

1. Select **harvester-csi-driver-lvm (Experimental)**, and then select **⋮** > **Enable**.

Expand All @@ -40,13 +40,13 @@ A volume group combines physical volumes to create a single storage structure th

:::note

Harvester currently does not allow you to modify the volume group composition (add or remove disks) after you create a logical volume. This issue will be addressed in a future release.
Hypervisor currently does not allow you to modify the volume group composition (add or remove disks) after you create a logical volume. This issue will be addressed in a future release.

:::

1. Verify that the **harvester-csi-driver-lvm** add-on is installed.

1. On the Harvester UI, go to the **Hosts** screen.
1. On the Hypervisor UI, go to the **Hosts** screen.

1. Select the target host, and then select **⋮** > **Edit Config**.

Expand Down Expand Up @@ -80,7 +80,7 @@ You can only use one type of local volume in each volume group. If necessary, cr

:::

1. On the Harvester UI, go to the **Storage** screen.
1. On the Hypervisor UI, go to the **Storage** screen.

1. Create a new StorageClass and select **LVM** in the **Provisioner** list.

Expand All @@ -96,7 +96,7 @@ You can only use one type of local volume in each volume group. If necessary, cr

![](/img/v1.4/csi-driver-lvm/create-lvm-sc-03.png)

- **Volume Group Type**: Select the type of local volume that matches your requirements. Harvester currently supports **striped** and **dm-thin**.
- **Volume Group Type**: Select the type of local volume that matches your requirements. Hypervisor currently supports **striped** and **dm-thin**.

![](/img/v1.4/csi-driver-lvm/create-lvm-sc-04.png)

Expand All @@ -110,15 +110,15 @@ For more information, see [StorageClass](../storageclass.md).

## Creating a Volume with LVM

1. On the Harvester UI, go to the **Volumes** screen.
1. On the Hypervisor UI, go to the **Volumes** screen.

1. Create a new volume using the LVM StorageClass that you created.

![](/img/v1.4/csi-driver-lvm/create-lvm-volume-01.png)

:::note

The status **Not Ready** is normal because Harvester creates the LVM volume only when the first workload is created.
The status **Not Ready** is normal because Hypervisor creates the LVM volume only when the first workload is created.

:::

Expand Down Expand Up @@ -146,7 +146,7 @@ You can also create a new virtual machine with the volume of the LVM StorageClas

## Creating Snapshots for an LVM Volume

1. On the Harvester UI, go to the **Settings** screen.
1. On the Hypervisor UI, go to the **Settings** screen.

1. In the **csi-driver-config** section, select **⋮** > **Edit Setting**.

Expand Down
12 changes: 6 additions & 6 deletions versioned_docs/version-v1.6/advanced/addons/managed-dhcp.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,15 @@ title: "Managed DHCP (Experimental)"

:::note

**harvester-vm-dhcp-controller** is an *experimental* add-on. It is not included in the Harvester ISO, but you can download it from the [experimental-addons repository](https://github.com/harvester/experimental-addons). For more information about experimental features, see [Feature Labels](../../getting-started/document-conventions.md#feature-labels).
**harvester-vm-dhcp-controller** is an *experimental* add-on. It is not included in the Hypervisor ISO, but you can download it from the [experimental-addons repository](https://github.com/harvester/experimental-addons). For more information about experimental features, see [Feature Labels](../../getting-started/document-conventions.md#feature-labels).

:::

You can configure IP pool information and serve IP addresses to VMs running on Harvester clusters using the embedded Managed DHCP feature. This feature, which is an alternative to the standalone DHCP server, leverages the [harvester-vm-dhcp-controller](https://github.com/harvester/vm-dhcp-controller) add-on to simplify guest cluster deployment.
You can configure IP pool information and serve IP addresses to VMs running on Hypervisor clusters using the embedded Managed DHCP feature. This feature, which is an alternative to the standalone DHCP server, leverages the [harvester-vm-dhcp-controller](https://github.com/harvester/vm-dhcp-controller) add-on to simplify guest cluster deployment.

:::note

Harvester uses the planned infrastructure network so you must ensure that network connectivity is available and plan the IP pools in advance.
Hypervisor uses the planned infrastructure network so you must ensure that network connectivity is available and plan the IP pools in advance.

:::

Expand Down Expand Up @@ -72,13 +72,13 @@ kubectl -n kube-system get pods -l component=kube-apiserver -o yaml | grep "serv

:::

After installation, enable the add-on on the **Dashboard** screen of the Harvester UI or using the command-line tool kubectl.
After installation, enable the add-on on the **Dashboard** screen of the Hypervisor UI or using the command-line tool kubectl.

![](/img/v1.3/vm-dhcp-controller/enable-addon.png)

## Using the Add-on

1. On the **Dashboard** screen of the Harvester UI, [create a VM Network](../../networking/harvester-network.md#create-a-vm-network).
1. On the **Dashboard** screen of the Hypervisor UI, [create a VM Network](../../networking/harvester-network.md#create-a-vm-network).

![](/img/v1.3/vm-dhcp-controller/vm-network.png)

Expand Down Expand Up @@ -233,7 +233,7 @@ The add-on introduces the following new CRDs:
The IPPool CRD allows you to define IP pool information. You must map each IPPool object to a specific NetworkAttachmentDefinition (NAD) object, which must be created beforehand.

:::note
Multiple CRDs named "IPPool" are used in the Harvester ecosystem, including a similarly-named CRD in the `loadbalancer.harvesterhci.io` API group. To avoid issues, ensure that you are working with the **IPPool CRD in the `network.harvesterhci.io` API group**. For more information about IPPool CRD operations in relation to load balancers, see [IP Pool](../../networking/ippool.md).
Multiple CRDs named "IPPool" are used in the Hypervisor ecosystem, including a similarly-named CRD in the `loadbalancer.harvesterhci.io` API group. To avoid issues, ensure that you are working with the **IPPool CRD in the `network.harvesterhci.io` API group**. For more information about IPPool CRD operations in relation to load balancers, see [IP Pool](../../networking/ippool.md).
:::

Example:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,18 @@ title: "NVIDIA Driver Toolkit"

_Available as of v1.3.0_

nvidia-driver-toolkit is an add-on that allows you to deploy out-of-band NVIDIA GRID KVM drivers to your existing Harvester clusters.
nvidia-driver-toolkit is an add-on that allows you to deploy out-of-band NVIDIA GRID KVM drivers to your existing Hypervisor clusters.

:::note
The toolkit only includes the correct Harvester OS image, build utilities, and kernel headers that allow NVIDIA drivers to be compiled and loaded from the container. You must download the NVIDIA KVM drivers using a valid NVIDIA subscription. For guidance on identifying the correct driver for your NVIDIA GPU, see the [NVIDIA documentation](https://www.nvidia.com/en-au/drivers/vgpu-software-driver/).
The toolkit only includes the correct Hypervisor OS image, build utilities, and kernel headers that allow NVIDIA drivers to be compiled and loaded from the container. You must download the NVIDIA KVM drivers using a valid NVIDIA subscription. For guidance on identifying the correct driver for your NVIDIA GPU, see the [NVIDIA documentation](https://www.nvidia.com/en-au/drivers/vgpu-software-driver/).
:::

The Harvester ISO does not include the nvidia-driver-toolkit container image. Because of its size, the image is pulled from Docker Hub by default. If you have an air-gapped environment, you can download and push the image to your private registry. The **Image Repository** and **Image Tag** fields on the **nvidia-driver-toolkit** screen provide information about the image that you must download.
The Hypervisor ISO does not include the nvidia-driver-toolkit container image. Because of its size, the image is pulled from Docker Hub by default. If you have an air-gapped environment, you can download and push the image to your private registry. The **Image Repository** and **Image Tag** fields on the **nvidia-driver-toolkit** screen provide information about the image that you must download.

![](/img/v1.3/advanced/nvidia-driver-toolkit.png)
![](/img/v1.2/advanced-hv/nvidia-driver-toolkit.png)

:::note
Each new Harvester version will be released with the correct nvidia-driver-toolkit image to ensure that all dependencies required to install the NVIDIA vGPU KVM drivers are available in the image.
Each new Hypervisor version will be released with the correct nvidia-driver-toolkit image to ensure that all dependencies required to install the NVIDIA vGPU KVM drivers are available in the image.
:::

To enable the addon, users need to perform the following:
Expand Down
Loading
Loading