Skip to main content
Version: main 🚧

apiKey


Pro Feature

This feature is available in the vCluster Pro tier. Contact us for more details and to start a trial.

This provides a way to connect directly to the vCluster Platform.

Example​

external:
  platform:
    apiKey:
      secretName: # Defaults to vcluster-platform-api-key if undefined
      namespace: # Namespace to search for the secret. If undefined, it searches the namespace that the vCluster is deployed in. If different than the namespace of the vCluster deployment, then vCluster needs access to that namespace.
      createRBAC: # Default enabled to create the necessary RBAC roles and role bindings in order to find the secret

Config reference​

apiKey required object pro​

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

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

secretName required string pro​

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 pro​

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 pro​

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.