Skip to main content

Rancher

The Rancher integration creates a seamless experience that enables self-service virtual cluster creation and management for teams already using Rancher to manage their Kubernetes fleet. Now you can provision and manage the entire lifecycle of virtual clusters in Rancher the same way you would any traditional Kubernetes cluster.

The vCluster Rancher integration enables organizations to:

  • Unify management of virtual clusters and regular clusters within Rancher alongside each other
  • Enable virtual cluster self-service for Rancher users within guardrails defined by Rancher admins
  • Continue using Rancher for user management while syncing permissions between Rancher and vCluster.Pro

Prerequisites​

Before you begin, make sure you have the following:

  • A running vCluster.Pro Platform
  • A running Rancher Server
  • vCluster.Pro Rancher Extension configured with the vCluster.Pro Platform

See the Rancher Guide for setup instructions

Using The Integration​

After configuring the Rancher integration, you can now create and delete virtual clusters from the Rancher UI. Additionally, you can also access the vCluster Platform directly from the Rancher UI.

Creating a virtual cluster​

  1. In the Rancher UI, click on .
  2. Enter a name for the virtual cluster and select the vCluster.Pro Project in which you wish to create the virtual cluster. Only projects which have the Rancher Integration enabled would be displayed in the list.
  3. Click which will redirect you to the vCluster.Pro Platform to complete the creation process. At this point, you can optionally select a template and click and then click on the Rancher configuration tab and slide the Add to Rancher toggle to enabled. Click to finish creating the virtual cluster.
  4. Navigate back to the Rancher UI and you should see the newly created virtual cluster available and in Activestate.

Deleting a virtual cluster​

  1. In the Rancher UI, click on the Delete icon for the virtual cluster you want to delete.
  2. You will be redirected to the platform's VirtualClusterInstance Page for confirmation.
  3. Click on the to confirm. The virtual cluster will be deleted from Rancher.

Importing virtual clusters into Rancher​

Once a project has Rancher integration enabled, virtual clusters within that project are eligible to be synced into Rancher. You can enable virtual cluster import into Rancher during the virtual cluster creation step, or by enabling this feature on existing virtual clusters.

  1. From the Projects Navigator in the left hand pane, switch to the desired Project and click on Virtual Clusters. Then click .
  2. In the popup, optionally select the virtual cluster template, then click the button.
  3. Click the Rancher configuration tab and slide the Add to Rancher toggle to enabled.
  4. Finish configuring anything else you'd like on your virtual cluster, then click.
Disabling Rancher Integration

You can disable the Rancher integration per virtual cluster or per project by toggling the same sliders used to enable it. Disabling the integration at the virtual cluster level simply removes it in Rancher. Disabling the integration at the project level removes all virtual clusters from Rancher, so be careful when disabling at this level.

Last updated on