Skip to main content

Virtual Cluster Config

Virtual clusters managed by vCluster.Pro have 100% feature parity with the open-source vCluster project, that is, any configuration options available in the vCluster project are available for configuration from within your vCluster.Pro deployment.

There are three primary configuration components for virtual clusters, the distribution, the vcluster version, and any values that should be passed to the vCluster deployment.

Distributions

The distribution of a vCluster is the actual Kubernetes distribution that is deployed in the virtual cluster. By default, this is k3s, however other distributions are supported. Please see the vCluster documentation for additional information pertaining to virtual cluster distributions.

In the context of vCluster.Pro, virtual cluster distributions can be configured when deploying virtual clusters via the vCluster.Pro UI as follows.

  1. Select the Projects field on the left menu bar.
  2. Select the project you'd like to create the virtual cluster instance in from the Project drop down menu.
  3. Click the button.
  4. Click the button to skip selecting a virtual cluster template.
  5. In the drawer that appears from the right, you should see a Virtual Kubernetes Distribution drop down box. Select your desired distribution from this drop down box.
  6. Finish configuring anything else you'd like on your virtual cluster, then click the button.
Virtual Cluster Templates

The distribution can also be set in virtual cluster templates!

vCluster Version

The vCluster Version is the actual version of the vCluster project to use in the virtual cluster. You can check out the vCluster releases on the vCluster release page.

Providing the vCluster version is optional, if you do not provide a version, the vCluster.Pro will create the virtual cluster with the default version associated with current version of vCluster.Pro.

  1. Select the Projects field on the left menu bar.
  2. Select the project you'd like to create the virtual cluster instance in from the Project drop down menu.
  3. Click the button.
  4. Click the button to skip selecting a virtual cluster template.
  5. In the drawer that appears from the right, you should see a Virtual Cluster Version text box. Enter the desired version in the format `vX.Y.Z`, for example `v0.13.0`.
  6. Finish configuring anything else you'd like on your virtual cluster, then click the button.
Virtual Cluster Templates

The version can also be set in virtual cluster templates!

vCluster Values

Virtual clusters settings are configurable via helm values. Virtual clusters created via vCluster.Pro can be provided any desired helm values. Please refer to your distribution of choice's helm values in the vCluster repository helm charts directory.

  1. Select the Projects field on the left menu bar.
  2. Select the project you'd like to create the virtual cluster instance in from the Project drop down menu.
  3. Click the button.
  4. Click the button to skip selecting a virtual cluster template.
  5. In the drawer that appears from the right, you should see a Helm Values for Virtual Cluster Chart text box. Enter any desired helm values in this field -- note that the text entered must be valid YAML, and the values should correspond to appropriate value fields in your charts values!
  6. Finish configuring anything else you'd like on your virtual cluster, then click the button.
Virtual Cluster Templates

The values can also be set in virtual cluster templates!

Last updated on