Skip to content
Switch branches/tags
This branch is up to date with develop.

Latest commit


Git stats


Failed to load latest commit information.
Latest commit message
Commit time

UpCloud Rancher UI Driver


Rancher UI driver for UpCloud


Set up the driver

This driver is meant to be used with the docker-machine-driver-upcloud.

On your Rancher cluster, go to, and select Add Node Driver.

Driver Link
Download URL
Custom UI URL
Whitelist Domains

Press Create and wait for the Rancher node to download the docker-machine driver. Once that's done, you should see the driver status as Active. Then you're good to go.

Create a cluster

On the Global cluster page, click Add Cluster and Select UpCloud image

Under the Node Pools section, create a new node template. This will prompt you to authenticate your UpCloud user. Neither we nor Rancher store any of this information, this is used only for the interactions with the API.


After you authenticate yourself, select the configuration for the instance. It can be either a predefined plan or a custom configuration.


Then, proceed to select the region for the nodes to run in. The default region is FRA-1. Once you're done with this, specify a name for the node template and you're good to go! 🙌


This package contains a small web-server that will serve up the custom driver UI at http://localhost:3000/component.js. You can run this while developing and point the Rancher settings there.

  • npm start
  • The driver name can be optionally overridden: npm start -- --name=DRIVERNAME
  • The compiled files are viewable at http://localhost:3000.
    • To be accessible to a live Rancher cluster, use a tunnel to localhost, like ngrok or localtunnel.
  • Do not use the model.<drivername>Confg signature to access your driver config in the template file, use the config alias that is already setup in the component


For other users to see your driver, you need to build it and host the output on a server accessible from their browsers.

  • npm run build
  • Copy the contents of the dist directory onto a webserver.
    • If your Rancher is configured to use HA or SSL, the server must also be available via HTTPS.