Skip to main content

Platform

Configure connections to your vCluster Platform installation.

Config reference​

platform required object pro​

Platform holds options for connecting to vCluster Platform.

apiKey required object pro​

APIKey defines how vCluster can find the api key used for the platform.

value required string pro​

Value specifies the api key as a regular text value.

secretRef required object pro​

SecretRef defines where to find the platform api key. By default vCluster will search in the following locations in this precedence:

  • platform.apiKey.value
  • environment variable called LICENSE
  • secret specified under platform.secret.name
  • secret called "vcluster-platform-api-key" in the vCluster namespace
name required string pro​

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

namespace required string pro​

Namespace defines the namespace where the api 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.

name required string pro​

Name is the name of the vCluster instance in the vCluster platform

owner required object pro​

Owner is the desired owner of the vCluster instance within the vCluster platform. If empty will take the current user.

user required string pro​

User is the user id within the platform. This is mutually exclusive with team.

team required string pro​

Team is the team id within the platform. This is mutually exclusive with user.

project required string pro​

Project is the project within the platform where the vCluster instance should connect.