Skip to main content
Version: main 🚧

platform

The platform key configures the connection to vCluster Platform, such as the API key and project. To create the access key it uses, see Access keys in the Platform docs.

platform object ​

Platform holds vCluster Platform specific configuration.

apiKey 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 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 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 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 string ​

Project specifies which platform project the vcluster should be imported to