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
Binary file added static/img/v1.2/vm-hv/access-to-vm.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/vm-hv/add-volume-button.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/vm-hv/add-volume-panel.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/vm-hv/backuptarget-nfs.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/vm-hv/backuptarget-s3.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/vm-hv/check-schadule-backups.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/vm-hv/check-schadule-basic.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/vm-hv/clone-vm-with-data.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/vm-hv/clone-vm-without-data.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/vm-hv/configure-schedule.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/vm-hv/create-backup.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/vm-hv/create-schadule.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/vm-hv/create-snapshot.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/vm-hv/download-vm-image.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.
Binary file added static/img/v1.2/vm-hv/edit-quota-namespace.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/vm-hv/edit-quota-vm-read.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/vm-hv/edit-quota-vm-save.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/vm-hv/edit-quota-vm.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/vm-hv/edit-schedule-config.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/vm-hv/fs-freeze-fail.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/vm-hv/overcommit-page.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/vm-hv/overcommit-panel.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/vm-hv/restore-vm-snapshot.png
Binary file added static/img/v1.2/vm-hv/restore-vm.png
Binary file added static/img/v1.2/vm-hv/vm-backup-results.png
Binary file added static/img/v1.2/vm-hv/vm-backup.png
Binary file added static/img/v1.2/vm-hv/vm-overcommit-config.png
Binary file added static/img/v1.2/vm-hv/vm-restore-existing.png
Binary file added static/img/v1.2/vm-hv/vm-snapshot-results.png
Binary file added static/img/v1.2/vm-hv/vm-snapshot.png
Binary file added static/img/v1.2/vm-hv/vm-ssh-keys.png
Binary file added static/img/v1.4/cpu-pinning-hv/create-vm.png
20 changes: 10 additions & 10 deletions versioned_docs/version-v1.6/vm/access-to-the-vm.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,39 +3,39 @@ sidebar_position: 5
sidebar_label: Access to the Virtual Machine
title: "Access to the Virtual Machine"
keywords:
- Harvester
- Hypervisor
- harvester
- Rancher
- rancher
- Access to the VM
description: Once the VM is up and running, it can be accessed using either VNC or the serial console from the Harvester UI.
description: Once the VM is up and running, it can be accessed using either VNC or the serial console from the Hypervisor UI.
---

<head>
<link rel="canonical" href="https://docs.harvesterhci.io/v1.6/vm/access-to-the-vm"/>
</head>

Once the VM is up and running, you can access it using either the Virtual Network Computing (VNC) client or the serial console from the Harvester UI.
Once the VM is up and running, you can access it using either the Virtual Network Computing (VNC) client or the serial console from the Hypervisor UI.

Additionally, you can connect directly from your computer's SSH client.

## Access with the Harvester UI
## Access with the Hypervisor UI

VMs can be accessed from the UI directly using either VNC or the serial console.

If the VGA display is not enabled on the VM, e.g., the `Ubuntu-Minimal-Cloud` image, the VM can only be accessed with the serial console.

![](/img/v1.2/vm/access-to-vm.png)
![](/img/v1.2/vm-hv/access-to-vm.png)

## SSH Access

Harvester provides two ways to inject SSH public keys into virtual machines. Generally, these methods fall into two categories. [Static key injection](#static-ssh-key-injection-via-cloud-init), which places keys in the cloud-init script when the virtual machine is first powered on; [dynamic injection](#dynamic-ssh-key-injection-via-qemu-guest-agent), which allows keys or basic auth to be updated dynamically at runtime.
Hypervisor provides two ways to inject SSH public keys into virtual machines. Generally, these methods fall into two categories. [Static key injection](#static-ssh-key-injection-via-cloud-init), which places keys in the cloud-init script when the virtual machine is first powered on; [dynamic injection](#dynamic-ssh-key-injection-via-qemu-guest-agent), which allows keys or basic auth to be updated dynamically at runtime.

### Static SSH Key Injection via cloud-init

You can provide ssh keys to your virtual machines during the creation time on the `Basics` tab. Additionally, you can place the public ssh keys into your cloud-init script to allow it to take place.

![](/img/v1.2/vm/vm-ssh-keys.png)
![](/img/v1.2/vm-hv/vm-ssh-keys.png)

#### Example of SSH key cloud-init configuration:
```yaml
Expand All @@ -49,7 +49,7 @@ ssh_authorized_keys:

_Available as of v1.0.1_

Harvester supports dynamically injecting public ssh keys at run time through the use of the [qemu guest agent](https://wiki.qemu.org/Features/GuestAgent). This is achieved through the `qemuGuestAgent` propagation method.
Hypervisor supports dynamically injecting public ssh keys at run time through the use of the [qemu guest agent](https://wiki.qemu.org/Features/GuestAgent). This is achieved through the `qemuGuestAgent` propagation method.

:::note

Expand All @@ -59,7 +59,7 @@ When using `qemuGuestAgent` propagation, the `/home/$USER/.ssh/authorized_keys`

:::

You can inject your access credentials via the Harvester dashboard as below:
You can inject your access credentials via the Hypervisor dashboard as below:

1. Select the VM and click `⋮` button.
2. Click the `Edit Config` button and go to the `Access Credentials` tab.
Expand All @@ -73,7 +73,7 @@ You need to enter the VM to edit password or remove SSH-Key after deleting the c

:::

![](/img/v1.2/vm/vm-add-access-credentails.png)
![](/img/v1.2/vm-hv/vm-add-access-credentails.png)



Expand Down
88 changes: 44 additions & 44 deletions versioned_docs/version-v1.6/vm/backup-restore.md

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions versioned_docs/version-v1.6/vm/clone-vm.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ sidebar_position: 10
sidebar_label: Clone VM
title: "Clone VM"
keywords:
- Harvester
- Hypervisor
- harvester
- Rancher
- rancher
Expand All @@ -23,7 +23,7 @@ VM can be cloned with/without data. This function doesn't need to take a VM snap

1. On the `Virtual Machines` page, click `Clone` of the VM actions.
1. Set a new VM name and click `Create` to create a new VM.
![clone-vm-with-data.png](/img/v1.2/vm/clone-vm-with-data.png)
![clone-vm-with-data.png](/img/v1.2/vm-hv/clone-vm-with-data.png)

## Clone VM without volume data

Expand All @@ -32,4 +32,4 @@ Cloning a VM without volume data creates a new VM with the same configuration as
1. On the `Virtual Machines` page, click `Clone` of the VM actions.
1. Unclick the `clone volume data` checkbox.
1. Set a new VM name and click `Create` to create a new VM.
![clone-vm-without-data.png](/img/v1.2/vm/clone-vm-without-data.png)
![clone-vm-without-data.png](/img/v1.2/vm-hv/clone-vm-without-data.png)
14 changes: 7 additions & 7 deletions versioned_docs/version-v1.6/vm/cpu-memory-hotplug.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ sidebar_position: 12
sidebar_label: CPU and Memory Hotplug
title: "CPU and Memory Hotplug"
keywords:
- Harvester
- Hypervisor
- harvester
- Virtual Machine
- virtual machine
Expand All @@ -30,27 +30,27 @@ ARM64 architecture only supports memory hotplug. CPU hotplug operations require

:::

Harvester supports CPU and memory hotplug for virtual machines. This feature allows you to increase the CPU and memory resources of a running virtual machine without requiring a reboot.
Hypervisor supports CPU and memory hotplug for virtual machines. This feature allows you to increase the CPU and memory resources of a running virtual machine without requiring a reboot.

## Enable CPU and Memory Hotplug During Virtual Machine Creation

1. On the **Virtual Machine:Create** screen, specify the number of CPU cores and memory to be allocated.

![Enable CPU and Memory Hotplug](/img/v1.6/cpu-memory-hotplug/enable-cpu-and-memory-hotplug.png)
![Enable CPU and Memory Hotplug](/img/v1.6/cpu-memory-hotplug-hv/enable-cpu-and-memory-hotplug.png)

1. Select **Enable CPU and memory hotplug**.

Harvester automatically populates the **Maximum CPU** and **Maximum Memory** fields based on the `max-hotplug-ratio` setting. These values represent the maximum amount of CPU and memory resources that are available to the virtual machine during runtime. You can change these values, if necessary.
Hypervisor automatically populates the **Maximum CPU** and **Maximum Memory** fields based on the `max-hotplug-ratio` setting. These values represent the maximum amount of CPU and memory resources that are available to the virtual machine during runtime. You can change these values, if necessary.

1. Complete the rest of the virtual machine creation steps.

## Trigger CPU and Memory Hotplug Action

After the virtual machine is created, you can dynamically add CPU and memory resources using the **Edit CPU and Memory** button.

![Edit CPU and Memory](/img/v1.6/cpu-memory-hotplug/edit-cpu-and-memory.png)
![Edit CPU and Memory](/img/v1.6/cpu-memory-hotplug-hv/edit-cpu-and-memory.png)

Once you click **Apply**, Harvester [migrates the virtual machine](./live-migration.md#prerequisites) to a node with the configured CPU and memory amounts.
Once you click **Apply**, Hypervisor [migrates the virtual machine](./live-migration.md#prerequisites) to a node with the configured CPU and memory amounts.

:::note

Expand All @@ -75,4 +75,4 @@ The `max-hotplug-ratio` is set to `4`.
| CPU cores | `1` | `4` |
| Memory (Gi) | `2` | `8` |

![Edit max-hotplug-ratio](/img/v1.6/cpu-memory-hotplug/edit-max-hotplug-ratio.png)
![Edit max-hotplug-ratio](/img/v1.6/cpu-memory-hotplug-hv/edit-max-hotplug-ratio.png)
24 changes: 12 additions & 12 deletions versioned_docs/version-v1.6/vm/cpu-pinning.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ sidebar_position: 11
sidebar_label: CPU Pinning
title: "CPU Pinning"
keywords:
- Harvester
- Hypervisor
- harvester
- Virtual Machine
- virtual machine
Expand All @@ -24,20 +24,20 @@ description: Create VM with CPU pinning

_Available as of v1.4.0_

Harvester supports VM CPU pinning. To use this feature, you must first enable the CPU Manager on the nodes, and then enable CPU pinning when you create the VM.
Hypervisor supports VM CPU pinning. To use this feature, you must first enable the CPU Manager on the nodes, and then enable CPU pinning when you create the VM.

## Kubernetes CPU Manager

The [CPU Manager](https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/) feature improves CPU resource allocation in Kubernetes clusters, ensuring that workloads with strict performance needs receive stable and predictable CPU resources. This is especially important for high-performance and latency-sensitive applications.

Harvester uses the `static` CPU Manager policy when the CPU Manager is enabled. This policy manages a shared pool of CPUs that initially includes all CPUs on nodes with the following configuration:
Hypervisor uses the `static` CPU Manager policy when the CPU Manager is enabled. This policy manages a shared pool of CPUs that initially includes all CPUs on nodes with the following configuration:

- Pods in the [`Guaranteed`](https://kubernetes.io/docs/concepts/workloads/pods/pod-qos/#guaranteed) quality of service (QoS) class that request whole CPU cores (for example, CPU: "2") are assigned dedicated CPUs. These CPUs are "pinned" to the pod and are removed from the shared CPU pool.
- Pods in the [`Burstable`](https://kubernetes.io/docs/concepts/workloads/pods/pod-qos/#burstable) and [`BestEffort`](https://kubernetes.io/docs/concepts/workloads/pods/pod-qos/#besteffort) QoS classes share the remaining CPUs in the shared pool.

### Calculation of Shared CPU Pool

Harvester reserves CPU resources for system-level operations based on the [GKE formula](https://cloud.google.com/kubernetes-engine/docs/concepts/plan-node-sizes#cpu_reservations), with the [`systemReserved`](https://kubernetes.io/docs/tasks/administer-cluster/reserve-compute-resources/#system-reserved) and [`kubeReserved`](https://kubernetes.io/docs/tasks/administer-cluster/reserve-compute-resources/#kube-reserved) values allocated in a 2:3 ratio.
Hypervisor reserves CPU resources for system-level operations based on the [GKE formula](https://cloud.google.com/kubernetes-engine/docs/concepts/plan-node-sizes#cpu_reservations), with the [`systemReserved`](https://kubernetes.io/docs/tasks/administer-cluster/reserve-compute-resources/#system-reserved) and [`kubeReserved`](https://kubernetes.io/docs/tasks/administer-cluster/reserve-compute-resources/#kube-reserved) values allocated in a 2:3 ratio.

Example (node with 16 CPU cores):
```
Expand All @@ -50,18 +50,18 @@ When a VM (pod) in the Guaranteed QoS class requests 4 CPUs, 4 cores are dedicat

## Enable and Disable CPU Manager

When you enable the CPU Manager, Harvester sets the CPU Manager policy to `static`. When you disable the feature, Harvester switches the CPU Manager policy back to `none`.
When you enable the CPU Manager, Hypervisor sets the CPU Manager policy to `static`. When you disable the feature, Hypervisor switches the CPU Manager policy back to `none`.

You must enable or disable the CPU Manager on each node separately.

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

1. Locate the node in the list, and then select **⋮** > **Enable CPU Manager** or **Disable CPU Manager**.

Allow some time for Harvester to apply the corresponding CPU Manager policy.
Allow some time for Hypervisor to apply the corresponding CPU Manager policy.

![enable-cpu-manager](/img/v1.4/cpu-pinning/enable-cpu-manager.png)
![disable-cpu-manager](/img/v1.4/cpu-pinning/disable-cpu-manager.png)
![enable-cpu-manager](/img/v1.4/cpu-pinning-hv/enable-cpu-manager.png)
![disable-cpu-manager](/img/v1.4/cpu-pinning-hv/disable-cpu-manager.png)

### Limitations

Expand All @@ -85,11 +85,11 @@ Allow some time for Harvester to apply the corresponding CPU Manager policy.

1. Click **Create**.

![create-vm](/img/v1.4/cpu-pinning/create-vm.png)
![create-vm](/img/v1.4/cpu-pinning-hv/create-vm.png)

1. On the **Advanced Options** tab, select **Enable CPU Pinning**.

![vm-advanced-options](/img/v1.4/cpu-pinning/vm-advanced-options.png)
![vm-advanced-options](/img/v1.4/cpu-pinning-hv/vm-advanced-options.png)

1. Click **Save**.

Expand All @@ -109,4 +109,4 @@ VMs with CPU pinning enabled can be migrated only if the CPU Manager is enabled

## Upgrades

When upgrading a node, Harvester drains all pods and live migrates VMs to another node. To avoid interruptions to the upgrade process, ensure that the CPU Manager is enabled on other nodes and sufficient resources are available whenever you use VMs with CPU pinning enabled.
When upgrading a node, Hypervisor drains all pods and live migrates VMs to another node. To avoid interruptions to the upgrade process, ensure that the CPU Manager is enabled on other nodes and sufficient resources are available whenever you use VMs with CPU pinning enabled.
4 changes: 2 additions & 2 deletions versioned_docs/version-v1.6/vm/create-vm.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_position: 2
sidebar_label: Create a Virtual Machine
title: "Create a Virtual Machine"
keywords:
- Harvester
- Hypervisor
- harvester
- Rancher
- rancher
Expand Down Expand Up @@ -93,7 +93,7 @@ For more information, see the [API reference](../api/create-namespaced-virtual-m
</TabItem>
<TabItem value="terraform" label="Terraform">

To create a virtual machine using the [Harvester Terraform Provider](https://registry.terraform.io/providers/harvester/harvester/latest),
To create a virtual machine using the [Hypervisor Terraform Provider](https://registry.terraform.io/providers/harvester/harvester/latest),
define a `harvester_virtualmachine` resource block:

```hcl
Expand Down
6 changes: 3 additions & 3 deletions versioned_docs/version-v1.6/vm/create-windows-vm.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ sidebar_position: 3
sidebar_label: Create a Windows Virtual Machine
title: "Create a Windows Virtual Machine"
keywords:
- Harvester
- Hypervisor
- harvester
- Rancher
- rancher
Expand Down Expand Up @@ -83,7 +83,7 @@ The `bootOrder` values need to be set with the installation image first. If you
1. The **Management Network** is added by default with the following values:
1. `Name`: The value `default` is set by default. You can keep it or change it.
2. `Model`: The value `e1000` is set by default. You can keep it or change it to the other available options from the dropdown.
3. `Network`: The value `management Network` is set by default. You can't change this option if no other network has been created. See [Harvester Network](../networking/harvester-network.md) for the full description on how to create new networks.
3. `Network`: The value `management Network` is set by default. You can't change this option if no other network has been created. See [Hypervisor Network](../networking/harvester-network.md) for the full description on how to create new networks.
4. `Type`: The value `masquerade` is set by default. You can keep it or change it to the other available option, `bridge`.
2. You can add additional networks by clicking `Add Network`.

Expand Down Expand Up @@ -202,7 +202,7 @@ There is a known issue with Windows VM using Windows Server 2016 and above, a BS
As a workaround, you can create or modify the file `/etc/modprobe.d/kvm.conf` within the installation of Hypervisor by updating `/oem/99_custom.yaml` like below:

```YAML
name: Harvester Configuration
name: Hypervisor Configuration
stages:
initramfs:
- commands: # ...
Expand Down
4 changes: 2 additions & 2 deletions versioned_docs/version-v1.6/vm/edit-vm.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@ sidebar_position: 4
sidebar_label: Edit a Virtual Machine
title: "Edit a Virtual Machine"
keywords:
- Harvester
- Hypervisor
- harvester
- Rancher
- rancher
- Virtual Machine
- virtual machine
- Edit a VM
description: Edit Virtual Machines from the Harvester VM page.
description: Edit Virtual Machines from the Hypervisor VM page.
---

<head>
Expand Down
8 changes: 4 additions & 4 deletions versioned_docs/version-v1.6/vm/hotplug-volume.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ sidebar_position: 8
sidebar_label: Hot-Plug Volumes
title: "Hot-Plug Volumes"
keywords:
- Harvester
- Hypervisor
- Hot-plug
- Volume
description: Adding hot-plug volumes to a running VM.
Expand All @@ -13,7 +13,7 @@ description: Adding hot-plug volumes to a running VM.
<link rel="canonical" href="https://docs.harvesterhci.io/v1.6/vm/hotplug-volume"/>
</head>

Harvester supports adding hot-plug volumes to a running VM.
Hypervisor supports adding hot-plug volumes to a running VM.

:::info

Expand All @@ -28,9 +28,9 @@ The following steps assume that you have a running VM and a ready volume:
1. Go to the **Virtual Machines** page.
1. Find the VM that you want to add a volume to and select **⋮ > Add Volume**.

![Add Volume Button](/img/v1.2/vm/add-volume-button.png)
![Add Volume Button](/img/v1.2/vm-hv/add-volume-button.png)

1. Enter the **Name** and select the **Volume**.
1. Click **Apply**.

![Add Volume Panel](/img/v1.2/vm/add-volume-panel.png)
![Add Volume Panel](/img/v1.2/vm-hv/add-volume-panel.png)
Loading
Loading