Skip to content

Harvester Node Driver

Available as of v0.2.0

The Harvester node driver is used to provision VMs in the Harvester cluster. In this section, you'll learn how to configure Rancher to use the Harvester node driver to launch and manage Kubernetes clusters.

A node driver is the same as a Docker Machine driver, and the project repo is available at harvester/docker-machine-driver-harvester.

Create Cluster

Now users can access the Rancher UI from Harvester, spin up Kubernetes clusters on top of the Harvester cluster, and manage them there.


VLAN network is required for Harvester node driver.

  1. From the Global view, click Add Cluster.
  2. Click Harvester.
  3. Select a Template.
  4. Fill out the rest of the form for creating a cluster.
  5. Click Create.

See launching kubernetes and provisioning nodes in an infrastructure provider for more info.

Create Node Template

You can use the Harvester node driver to create node templates and eventually node pools for your Kubernetes cluster.

  1. Configure Account Access. For Harvester embedding Rancher, you can choose Internal Harvester, which will use the harvester.harvester-system as the default Host, 8443 as the default Port.
  2. Configure Instance Options
    • Configure the CPU, memory, disk, and disk bus.
    • Select an OS image that is compatible with the cloud-init config.
    • Select a network that the node driver is able to connect to, currently only VLAN is supported.
    • Enter the SSH User, the username will be used to ssh to nodes. For example, a default user of the Ubuntu cloud image will be ubuntu.
  3. Enter a RANCHER TEMPLATE name.

See nodes hosted by an infrastructure provider for more info.

How to add Harvester Node Driver in dev mode

Developer mode doesn't come with Harvester node driver pre-installed. Following the steps below to install it:

  1. Navigate to the Rancher UI.
  2. From the Global view, choose Tools > Drivers in the navigation bar. From the Drivers page, select the Node Drivers tab. In versions before v2.2.0, you can select Node Drivers directly in the navigation bar.
  3. Click Add Node Driver.
  4. Enter Download URL(docker-machine-driver-harvester) and Custom UI URL(ui-driver-harvester).
  5. Add domains to the Whitelist Domains (e.g
  6. Click Create.