Skip to main content
Version: v2.9 (Preview)

Rancher Vagrant Quick Start

The following steps quickly deploy a Rancher Server with a single node cluster attached.


The intent of these guides is to quickly launch a sandbox that you can use to evaluate Rancher. These guides are not intended for production environments. For comprehensive setup instructions, see Installation.


  • Vagrant: Vagrant is required as this is used to provision the machine based on the Vagrantfile.
  • Virtualbox: The virtual machines that Vagrant provisions need to be provisioned to VirtualBox.
  • At least 4GB of free RAM.


  • Vagrant will require plugins to create VirtualBox VMs. Install them with the following commands:

    vagrant plugin install vagrant-vboxmanage

    vagrant plugin install vagrant-vbguest

Getting Started

  1. Clone Rancher Quickstart to a folder using git clone

  2. Go into the folder containing the Vagrantfile by executing cd quickstart/rancher/vagrant.

  3. Optional: Edit config.yaml to:

    • Change the number of nodes and the memory allocations, if required. (node.count, node.cpus, node.memory)
    • Change the password of the admin user for logging into Rancher. (admin_password)
  4. To initiate the creation of the environment run, vagrant up --provider=virtualbox.

  5. Once provisioning finishes, go to in the browser. The default user/password is admin/adminPassword.

Result: Rancher Server and your Kubernetes cluster is installed on VirtualBox.

What's Next?

Use Rancher to create a deployment. For more information, see Creating Deployments.

Destroying the Environment

  1. From the quickstart/rancher/vagrant folder execute vagrant destroy -f.

  2. Wait for the confirmation that all resources have been destroyed.