Manually Configure a Virtual Cluster

Each virtual cluster that is created in the platform belongs to a project. There are two primary ways which virtual clusters can be created: from a template or manually.

Virtual clusters created from a template settings. Standard project users (non project admins) are only allowed to create virtual clusters from templates that the project admin has allowed. This ensures that virtual clusters in each project adhere to the standards set by the project admin.

Project admins and platform admins can create virtual clusters manually, that is without a template.

Create Without Template

Only project admins or platform admins can create a virtual cluster without a template:

Form

1. From the project drop-down menu (top left corner), select the project you'd like to create the virtual cluster in.

2. Click on Virtual Clusters.

3. Click the button.

4. In the popup, confirm that the virtual cluster template field is empty.

5. [Optional] Select the cluster in which to create the virtual cluster.

6. [Optional] Add a name for your virtual cluster.

7. Click the to continue.

8. In the drawer that appears from the right, update the virtual cluster with any additional desired configuration options.

   1. The Definition tab contains settings relating to the virtual cluster deployment itself, here you can provide Helm values to be used when deploying the virtual cluster, select the virtual cluster distribution (e.g. k8s (default), k3s, k0s), as well as configurations for sleep mode and ingress access.

   2. Objects is where you can define Kubernetes manifests that should be created in the virtual cluster.

   3. Apps allows you to select any pre-defined 'applications' (e.g. Cert Manager) that should be installed into the virtual cluster.

   4. Permissions are additional access rules that can be defined for the virtual cluster instance.

   5. Advanced Options allow for advanced configuration different resources.

   tip

   All configuration options in a vCluster defined in the vcluster.yaml can be manually configured when creating any virtual cluster. Read more about the vcluster.yaml configuration options.

9. Click the button.

10. Retrieve a kube-context for a virtual cluster using the CLI:

    vcluster connect [vcluster-name] --project [project-name] --driver platform

YAML

1. From the project drop-down menu (top left corner), select the project you'd like to create the virtual cluster in.

2. Click on Virtual Clusters.

3. Click the button.

4. In the popup, confirm that the virtual cluster template field is empty.

5. [Optional] Select the cluster in which to create the virtual cluster.

6. [Optional] Add a name for your virtual cluster.

7. Click the to continue.

8. In the drawer that appears from the right, click the Show YAML at the bottom left corner of the drawer.

9. Configure your virtual cluster with options in the values section. Read more about what values can be used as it is the equivalent of the vcluster.yaml.

10. Click the button.

11. Retrieve a kube-context for a virtual cluster using the CLI:

    vcluster connect [vcluster-name] --project [project-name] --driver platform