vCluster Templates

What vCluster templates are

A vCluster template (VirtualClusterTemplate) is a pre-defined, standardized configuration that Kosmos uses to provision virtual clusters. Templates let platform administrators bake in consistent settings — Helm chart version, sync behavior, access points, and more — so that every virtual cluster created from a given template behaves the same way.

DevSpace owners can restrict which templates their members are allowed to use via allowedTemplates on the DevSpace, giving administrators control over cluster configuration, resource usage, and deployment patterns across their DevSpace.

Template definition

Templates are created with kosmos create vclustertemplate and are defined declaratively as a VirtualClusterTemplate custom resource:

apiVersion: storage.kosmos.spcplatform.com/v1
kind: VirtualClusterTemplate
metadata:
  name: <template-name>
spec:
  displayName: <template-name>
  description: <description>
  template:
    accessPoint:
      ingress:
        enabled: <true|false>
    helmRelease:
      chart:
        version: <int>
      values: |
        sync:
          toHost:
            ingresses:
              enabled: <true|false>
          fromHost:
            nodes:
              enabled: <true|false>
            ingressClasses:
              enabled: <true|false>

A virtual cluster references its template (and version) via spec.templateRef when it’s created — see Getting started with vClusters for the full creation flow.

The vcluster-pro template

vcluster-pro is the standard Kosmos-managed template used for most virtual clusters. Starting with v1.3.0, it includes two behaviors that are already enabled by default and don’t require any additional configuration:

Both of these are specific to vcluster-pro v1.3.0+. Virtual clusters created from older template versions, or from the OSS/community template, will not have them.

In this section

Edit this page on GitHub