Skip to main content
Version: v0.32 Stable

Platform

You can connect to vCluster Platform through the vcluster.yaml and configure different vCluster Platform settings that work with the virtual cluster.

Config reference​

platform required object ​

Platform holds vCluster Platform specific configuration.

apiKey required object ​

APIKey defines where to find the platform access key and host. By default, vCluster will search in the following locations in this precedence:

  • environment variable called LICENSE
  • secret specified under platform.apiKey.secretName
  • secret called "vcluster-platform-api-key" in the vCluster namespace

secretName required string ​

SecretName is the name of the secret where the platform access key is stored. This defaults to vcluster-platform-api-key if undefined.

namespace required string ​

Namespace defines the namespace where the access key secret should be retrieved from. If this is not equal to the namespace where the vCluster instance is deployed, you need to make sure vCluster has access to this other namespace.

createRBAC required boolean ​

CreateRBAC will automatically create the necessary RBAC roles and role bindings to allow vCluster to read the secret specified in the above namespace, if specified. This defaults to true.

project required string ​

Project specifies which platform project the vcluster should be imported to