diff --git a/static/img/v1.2/air-gapped-hv/iso-proxy.png b/static/img/v1.2/air-gapped-hv/iso-proxy.png new file mode 100644 index 0000000..ad8bf93 Binary files /dev/null and b/static/img/v1.2/air-gapped-hv/iso-proxy.png differ diff --git a/static/img/v1.2/air-gapped-hv/proxy-setting.png b/static/img/v1.2/air-gapped-hv/proxy-setting.png new file mode 100644 index 0000000..5aef9d5 Binary files /dev/null and b/static/img/v1.2/air-gapped-hv/proxy-setting.png differ diff --git a/static/img/v1.2/faq-hv/harvester-kubeconfig.jpeg b/static/img/v1.2/faq-hv/harvester-kubeconfig.jpeg new file mode 100644 index 0000000..705bd5d Binary files /dev/null and b/static/img/v1.2/faq-hv/harvester-kubeconfig.jpeg differ diff --git a/static/img/v1.2/faq-hv/harvester-kubeconfig.png b/static/img/v1.2/faq-hv/harvester-kubeconfig.png new file mode 100644 index 0000000..b57f9c4 Binary files /dev/null and b/static/img/v1.2/faq-hv/harvester-kubeconfig.png differ diff --git a/versioned_docs/version-v1.6/airgap.md b/versioned_docs/version-v1.6/airgap.md index b77db39..53cfba0 100644 --- a/versioned_docs/version-v1.6/airgap.md +++ b/versioned_docs/version-v1.6/airgap.md @@ -4,7 +4,7 @@ sidebar_position: 3 sidebar_label: Air Gapped Environment title: "Air Gapped Environment" keywords: -- Harvester +- Hypervisor - offline - Air-gap - HTTP proxy @@ -14,9 +14,9 @@ keywords: -This section describes how to use Harvester in an air gapped environment. Some use cases could be where Harvester will be installed offline, behind a firewall, or behind a proxy. +This section describes how to use Hypervisor in an air gapped environment. Some use cases could be where Hypervisor will be installed offline, behind a firewall, or behind a proxy. -The Harvester ISO image contains all the packages to make it work in an air gapped environment. +The Hypervisor ISO image contains all the packages to make it work in an air gapped environment. ## Working Behind an HTTP Proxy @@ -26,21 +26,21 @@ In some environments, the connection to external services, from the servers or V You can configure the HTTP(S) proxy during the [ISO installation](./install/iso-install.md) as shown in picture below: -![iso-proxy](/img/v1.2/iso-proxy.png) +![iso-proxy](/img/v1.2/air-gapped-hv/iso-proxy.png) -### Configure an HTTP Proxy in Harvester Settings +### Configure an HTTP Proxy in Hypervisor Settings -You can configure the HTTP(S) proxy in the settings page of the Harvester dashboard: +You can configure the HTTP(S) proxy in the settings page of the Hypervisor dashboard: -1. Go to the settings page of the Harvester UI. +1. Go to the settings page of the Hypervisor UI. 1. Find the `http-proxy` setting, click **⋮ > Edit setting** 1. Enter the value(s) for `http-proxy`, `https-proxy` and `no-proxy`. -![proxy-setting](/img/v1.2/proxy-setting.png) +![proxy-setting](/img/v1.2/air-gapped-hv/proxy-setting.png) :::note -Harvester appends necessary addresses to user configured `no-proxy` to ensure the internal traffic works. +Hypervisor appends necessary addresses to user configured `no-proxy` to ensure the internal traffic works. i.e., `localhost,127.0.0.1,0.0.0.0,10.0.0.0/8,longhorn-system,cattle-system,cattle-system.svc,harvester-system,.svc,.cluster.local`. `harvester-system` was added into the list since v1.1.2. When the nodes in the cluster do not use a proxy to communicate with each other, the CIDR needs to be added to `http-proxy.noProxy` after the first node is installed successfully. Please refer to [fail to deploy a multi-node cluster](./troubleshooting/harvester.md#fail-to-deploy-a-multi-node-cluster-due-to-incorrect-http-proxy-setting). @@ -49,37 +49,37 @@ When the nodes in the cluster do not use a proxy to communicate with each other, ## Guest Cluster Images -All necessary images to install and run Harvester are conveniently packaged into the ISO, eliminating the need to pre-load images on bare-metal nodes. A Harvester cluster manages them independently and effectively behind the scenes. +All necessary images to install and run Hypervisor are conveniently packaged into the ISO, eliminating the need to pre-load images on bare-metal nodes. A Hypervisor cluster manages them independently and effectively behind the scenes. -However, it's essential to understand a guest K8s cluster (e.g., RKE2 cluster) created by the [Harvester node driver](./rancher/node/node-driver.md) is a distinct entity from a Harvester cluster. A guest cluster operates within VMs and requires pulling images either from the internet or a [private registry](https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/global-default-private-registry#configure-a-private-registry-with-credentials-when-creating-a-cluster). +However, it's essential to understand a guest K8s cluster (e.g., RKE2 cluster) created by the [Hypervisor node driver](./rancher/node/node-driver.md) is a distinct entity from a Hypervisor cluster. A guest cluster operates within VMs and requires pulling images either from the internet or a [private registry](https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/global-default-private-registry#configure-a-private-registry-with-credentials-when-creating-a-cluster). -If the **Cloud Provider** option is configured to **Harvester** in a guest K8s cluster, it deploys the Harvester cloud provider and Container Storage Interface (CSI) driver. +If the **Cloud Provider** option is configured to **Hypervisor** in a guest K8s cluster, it deploys the Hypervisor cloud provider and Container Storage Interface (CSI) driver. ![cluster-registry](/img/v1.2/cluster-registry.png) -As a result, we recommend monitoring each [RKE2 release](https://github.com/rancher/rke2/releases) in your air gapped environment and pulling the required images into your private registry. Please refer to the **Harvester CCM & CSI Driver** with RKE2 Releases section on the [Harvester support matrix page](https://www.suse.com/suse-harvester/support-matrix/all-supported-versions/harvester-v1-1-2/) for the best Harvester cloud provider and CSI driver capability support. +As a result, we recommend monitoring each [RKE2 release](https://github.com/rancher/rke2/releases) in your air gapped environment and pulling the required images into your private registry. Please refer to the **Hypervisor CCM & CSI Driver** with RKE2 Releases section on the [Hypervisor support matrix page](https://www.suse.com/suse-harvester/support-matrix/all-supported-versions/harvester-v1-1-2/) for the best Hypervisor cloud provider and CSI driver capability support. -## Integrate with an External Rancher + \ No newline at end of file diff --git a/versioned_docs/version-v1.6/authentication.md b/versioned_docs/version-v1.6/authentication.md index 54fb6b6..66d29dc 100644 --- a/versioned_docs/version-v1.6/authentication.md +++ b/versioned_docs/version-v1.6/authentication.md @@ -4,7 +4,7 @@ sidebar_position: 5 sidebar_label: Authentication title: "Authentication" keywords: - - Harvester + - Hypervisor - harvester - Rancher - rancher @@ -18,7 +18,7 @@ description: With ISO installation mode, user will be prompted to set the passwo After installation, user will be prompted to set the password for the default `admin` user on the first-time login. -![auth](/img/v1.2/install/first-time-login.png) +![auth](\img\v1.0\install-hv\first-time-login.png) :::note diff --git a/versioned_docs/version-v1.6/faq.md b/versioned_docs/version-v1.6/faq.md index ccca67d..0f6814f 100644 --- a/versioned_docs/version-v1.6/faq.md +++ b/versioned_docs/version-v1.6/faq.md @@ -9,25 +9,25 @@ title: "FAQ" -This FAQ is a work in progress designed to answer the questions our users most frequently ask about Harvester. +This FAQ is a work in progress designed to answer the questions our users most frequently ask about Hypervisor. -### How can I ssh login to the Harvester node? +### How can I ssh login to the Hypervisor node? ```shell $ ssh rancher@node-ip ``` -### What is the default login username and password of the Harvester dashboard? +### What is the default login username and password of the Hypervisor dashboard? ```shell username: admin password: # you will be promoted to set the default password when logging in for the first time ``` -### How can I access the kubeconfig file of the Harvester cluster? +### How can I access the kubeconfig file of the Hypervisor cluster? -Option 1. You can download the kubeconfig file from the support page of the Harvester dashboard. -![harvester-kubeconfig.png](/img/v1.2/harvester-kubeconfig.png) +Option 1. You can download the kubeconfig file from the support page of the Hypervisor dashboard. +![harvester-kubeconfig.png](/img/v1.2/faq-hv/harvester-kubeconfig.png) -Option 2. You can get the kubeconfig file from one of the Harvester management nodes. E.g., +Option 2. You can get the kubeconfig file from one of the Hypervisor management nodes. E.g., ```shell $ sudo su $ cat /etc/rancher/rke2/rke2.yaml @@ -52,19 +52,19 @@ New password for default administrator (user-xxxxx): ### I added an additional disk with partitions. Why is it not getting detected? -As of Harvester v1.0.2, we no longer support adding additional partitioned disks, so be sure to delete all partitions first (e.g., using `fdisk`). +As of Hypervisor v1.0.2, we no longer support adding additional partitioned disks, so be sure to delete all partitions first (e.g., using `fdisk`). -### Why are there some Harvester pods that become ErrImagePull/ImagePullBackOff? +### Why are there some Hypervisor pods that become ErrImagePull/ImagePullBackOff? -This is likely because your Harvester cluster is an air-gapped setup, and some pre-loaded container images are missing. Kubernetes has a mechanism that does garbage collection against bloated image stores. When the partition which stores container images is over 85% full, `kubelet` tries to prune the images based on the last time they were used, starting with the oldest, until the occupancy is lower than 80%. These numbers (85% and 80%) are default High/Low thresholds that come with Kubernetes. +This is likely because your Hypervisor cluster is an air-gapped setup, and some pre-loaded container images are missing. Kubernetes has a mechanism that does garbage collection against bloated image stores. When the partition which stores container images is over 85% full, `kubelet` tries to prune the images based on the last time they were used, starting with the oldest, until the occupancy is lower than 80%. These numbers (85% and 80%) are default High/Low thresholds that come with Kubernetes. To recover from this state, do one of the following depending on the cluster's configuration: - Pull the missing images from sources outside of the cluster (if it's an air-gapped environment, you might need to set up an HTTP proxy beforehand). -- Manually import the images from the Harvester ISO image. +- Manually import the images from the Hypervisor ISO image. :::note -Take v1.1.2 as an example, download the Harvester ISO image from the official URL. Then extract the image list from the ISO image to decide which image tarball we're going to import. For instance, we want to import the missing container image `rancher/harvester-upgrade` +Take v1.1.2 as an example, download the Hypervisor ISO image from the official URL. Then extract the image list from the ISO image to decide which image tarball we're going to import. For instance, we want to import the missing container image `rancher/harvester-upgrade` ```shell $ curl -sfL https://releases.rancher.com/harvester/v1.1.2/harvester-v1.1.2-amd64.iso -o harvester.iso @@ -83,7 +83,7 @@ $ xorriso -osirrox on -indev harvester.iso -extract /bundle/harvester/images/har $ zstd -d --rm harvester.tar.zst ``` -Upload the image tarball to the Harvester nodes that need recover. Finally, execute the following command to import the container images on each of them. +Upload the image tarball to the Hypervisor nodes that need recover. Finally, execute the following command to import the container images on each of them. ```shell $ ctr -n k8s.io images import harvester.tar @@ -94,7 +94,7 @@ $ rm harvester.tar - Find the missing images on that node from the other nodes, then export the images from the node where the images still exist and import them on the missing node. -To prevent this from happening, we recommend cleaning up unused container images from the previous version after each successful Harvester upgrade if the image store disk space is stressed. We provided a [harv-purge-images script](https://github.com/harvester/upgrade-helpers/blob/main/bin/harv-purge-images.sh) that makes cleaning up disk space easy, especially for container image storage. The script has to be executed on each Harvester node. For example, if the cluster was originally in v1.1.2, and now it gets upgraded to v1.2.0, you can do the following to discard the container images that are only used in v1.1.2 but no longer needed in v1.2.0: +To prevent this from happening, we recommend cleaning up unused container images from the previous version after each successful Hypervisor upgrade if the image store disk space is stressed. We provided a [harv-purge-images script](https://github.com/harvester/upgrade-helpers/blob/main/bin/harv-purge-images.sh) that makes cleaning up disk space easy, especially for container image storage. The script has to be executed on each Hypervisor node. For example, if the cluster was originally in v1.1.2, and now it gets upgraded to v1.2.0, you can do the following to discard the container images that are only used in v1.1.2 but no longer needed in v1.2.0: ```shell # on each node diff --git a/versioned_docs/version-v1.6/index.md b/versioned_docs/version-v1.6/index.md index 34d28d1..c1e1622 100644 --- a/versioned_docs/version-v1.6/index.md +++ b/versioned_docs/version-v1.6/index.md @@ -1,49 +1,49 @@ --- sidebar_position: 1 -sidebar_label: Harvester Overview +sidebar_label: Hypervisor Overview slug: / -title: "Harvester Overview" +title: "Hypervisor Overview" keywords: - - Harvester + - Hypervisor - harvester - Rancher - rancher - - Harvester Intro -description: Harvester is an open source hyper-converged infrastructure (HCI) software built on Kubernetes. It is an open source alternative to vSphere and Nutanix. + - Hypervisor Intro +description: Hypervisor is an open source hyper-converged infrastructure (HCI) software built on Kubernetes. It is an open source alternative to vSphere and Nutanix. --- -[Harvester](https://harvesterhci.io/) is a modern, open, interoperable, [hyperconverged infrastructure (HCI)](https://en.wikipedia.org/wiki/Hyper-converged_infrastructure) solution built on Kubernetes. It is an open-source alternative designed for operators seeking a [cloud-native](https://about.gitlab.com/topics/cloud-native/) HCI solution. Harvester runs on bare metal servers and provides integrated virtualization and distributed storage capabilities. In addition to traditional virtual machines (VMs), Harvester supports containerized environments automatically through integration with [Rancher](https://ranchermanager.docs.rancher.com/integrations-in-rancher/harvester). It offers a solution that unifies legacy virtualized infrastructure while enabling the adoption of containers from core to edge locations. +[Hypervisor](https://harvesterhci.io/) is a modern, open, interoperable, [hyperconverged infrastructure (HCI)](https://en.wikipedia.org/wiki/Hyper-converged_infrastructure) solution built on Kubernetes. It is an open-source alternative designed for operators seeking a [cloud-native](https://about.gitlab.com/topics/cloud-native/) HCI solution. Hypervisor runs on bare metal servers and provides integrated virtualization and distributed storage capabilities. In addition to traditional virtual machines (VMs), Hypervisor supports containerized environments automatically through integration with [Rancher](https://ranchermanager.docs.rancher.com/integrations-in-rancher/harvester). It offers a solution that unifies legacy virtualized infrastructure while enabling the adoption of containers from core to edge locations. -## Harvester Architecture +## Hypervisor Architecture -The Harvester architecture consists of cutting-edge open-source technologies: -- **Linux OS.** [Elemental](https://github.com/rancher/elemental-toolkit) for SUSE Linux Enterprise Micro 5.5 is at the core of Harvester and is an immutable Linux distribution designed to remove as much OS maintenance as possible in a Kubernetes cluster. -- **Built on top of Kubernetes.** [Kubernetes](https://kubernetes.io/) has become the predominant infrastructure language across all form factors, and Harvester is an HCI solution with Kubernetes under the hood. +The Hypervisor architecture consists of cutting-edge open-source technologies: +- **Linux OS.** [Elemental](https://github.com/rancher/elemental-toolkit) for SUSE Linux Enterprise Micro 5.5 is at the core of Hypervisor and is an immutable Linux distribution designed to remove as much OS maintenance as possible in a Kubernetes cluster. +- **Built on top of Kubernetes.** [Kubernetes](https://kubernetes.io/) has become the predominant infrastructure language across all form factors, and Hypervisor is an HCI solution with Kubernetes under the hood. - **Virtualization management with KubeVirt.** [KubeVirt](https://kubevirt.io/) provides virtualization management using KVM on top of Kubernetes. - **Storage management with Longhorn.** [Longhorn](https://longhorn.io/) provides distributed block storage and tiering. - **Observability with Grafana and Prometheus.** [Grafana](https://grafana.com/) and [Prometheus](https://prometheus.io/) provide robust monitoring and logging. ![](/img/v1.2/architecture.svg) -## Harvester Features +## Hypervisor Features -Harvester is an enterprise-ready, easy-to-use infrastructure platform that leverages local, direct attached storage instead of complex external SANs. It utilizes Kubernetes API as a unified automation language across container and VM workloads. Some key features of Harvester include: -- **Easy to get started.** Since Harvester ships as a bootable appliance image, you can install it directly on a bare metal server with the [ISO image](https://github.com/harvester/harvester/releases) or automatically install it using [iPXE](./install/pxe-boot-install.md) scripts. +Hypervisor is an enterprise-ready, easy-to-use infrastructure platform that leverages local, direct attached storage instead of complex external SANs. It utilizes Kubernetes API as a unified automation language across container and VM workloads. Some key features of Hypervisor include: +- **Easy to get started.** Since Hypervisor ships as a bootable appliance image, you can install it directly on a bare metal server with the [ISO image](https://github.com/harvester/harvester/releases) or automatically install it using [iPXE](./install/pxe-boot-install.md) scripts. - **VM lifecycle management.** Easily create, edit, clone, and delete VMs, including SSH-Key injection, cloud-init, and graphic and serial port console. - **VM live migration.** Move a VM to a different host or node with zero downtime. - **VM backup, snapshot, and restore.** Back up your VMs from NFS, S3 servers, or NAS devices. Use your backup to restore a failed VM or create a new VM on a different cluster. -- **Storage management.** Harvester supports distributed block storage and tiering. Volumes represent storage; you can easily create, edit, clone, or export a volume. +- **Storage management.** Hypervisor supports distributed block storage and tiering. Volumes represent storage; you can easily create, edit, clone, or export a volume. - **Network management.** Supports using a virtual IP (VIP) and multiple Network Interface Cards (NICs). If your VMs need to connect to the external network, create a VLAN or untagged network. -- **Integration with Rancher.** Access Harvester directly within Rancher through Rancher’s Virtualization Management page and manage your VM workloads alongside your Kubernetes clusters. +- **Integration with Rancher.** Access Hypervisor directly within Rancher through Rancher’s Virtualization Management page and manage your VM workloads alongside your Kubernetes clusters. -## Harvester UI +## Hypervisor UI -Harvester provides a powerful and easy-to-use web-based interface for visualizing and managing your infrastructure. Once you install Harvester, you can access the IP address for the Harvester UI from the node's terminal. +Hypervisor provides a powerful and easy-to-use web-based interface for visualizing and managing your infrastructure. Once you install Hypervisor, you can access the IP address for the Hypervisor UI from the node's terminal. -
+