Harvester UI Extension

Rancher 2.10.0 and later versions integrate with Harvester using the Harvester UI Extension, which is built on the@rancher/shell library.

note

The current Harvester UI will continue to support Harvester v1.3.x and v1.4.x releases. New features in later releases will be implemented in the Harvester UI Extension.

Support Matrix

Versions of the Harvester operating system and the Harvester UI Extension will align starting with v1.5.0.

Harvester Cluster	Harvester UI Extension	Minimum supported Rancher
v1.3.0, v1.3.1, v1.3.2	v1.0.2	Rancher 2.10.1
v1.4.1	v1.0.3	Rancher 2.10.1
v1.4.2	v1.0.4	Rancher 2.10.1
v1.5.0	v1.5.0	Rancher 2.11.0

Installation on Rancher 2.10

Automatic Installation

You can install the Harvester UI Extension with a single click.

1. On the Rancher UI, go to Virtualization Management.

2. On the Harvester Clusters tab, click Install.

   Allow some time for the extension to be installed. The screen is automatically refreshed once the installation is completed.

   important

   Do not navigate away from the screen during the installation process.

   

Manual Installation

If the automatic installation fails, you can specify the Harvester UI Extension repository URL and then install the extension.

1. On the Rancher UI, go to local > Apps > Repositories, and then click Create.

   

2. Configure the following settings:

   • Name: Specify a name for the repository.
   • Target: Select Git repository containing Helm chart or cluster template definitions.
   • Git Repo URL: Specify https://github.com/harvester/harvester-ui-extension.
   • Git Branch: Specify gh-pages.

3. Click Create.

4. Go to Extensions > Available.

5. Locate the extension named Harvester, and then click Install.

Upgrades

Automatic Upgrade

The Update button appears whenever a new version of the extension is available.

1. On the Rancher UI, go to Virtualization Management.

   

2. Click Update. Allow some time for the extension to be upgraded. The screen is automatically refreshed once the upgrade is completed.

Manual Upgrades

1. On the Rancher UI, go to local > Apps > Repositories.

2. Locate the repository with the following settings, and then select ⋮ > Refresh.

   • URL: https://github.com/harvester/harvester-ui-extension
   • Branch: gh-pages

   

3. Go to Extensions > Installed.

4. Locate the extension named Harvester, and then click Update.

5. Select the new version, and then click Update.

   

6. Allow some time for the extension to be upgraded, and then refresh the screen.