Skip to main content
Version: v0.38 Stable

External Secrets Operator

Enterprise
Available in these plansFreeDevProdScale
External Secrets Integration

Free, Dev, Prod, and Scale are vCluster Platform license plans. Open source does not need a license or a Platform connection. See Compare open source and free tiers.

Supported Configurations
Running the control plane as a container with:
Enterprise-Only Feature

This feature is an Enterprise feature. See our pricing plans or contact our sales team for more information.

Prerequisites​

External secrets version

By default, vCluster uses the same CRD version as the External Secrets Operator installed on your control plane cluster. The version field allows you to explicitly set which CRD version to use (for example, v1beta1 or v1). Ensure your chosen version is supported by the External Secrets Operator on your control plane cluster.

External secrets integration

To enable the external secret integration, set the following fields:

integrations:
externalSecrets:
enabled: true
version: v1 # Optional. If not specified, uses the same CRD version as your control plane cluster's External Secrets Operator
sync:
toHost:
stores:
enabled: true
fromHost:
clusterStores:
enabled: true

This enables the integration and the sync for all custom resources:

  • ExternalSecret: namespaced, synced from cluster into control plane cluster and then bi-directionally
  • SecretStore: namespaced, synced from cluster into control plane cluster
  • ClusterSecretStore: cluster scoped, synced from control plane cluster into cluster

Once the cluster is up and running, you can create a SecretStore inside the cluster. For this guide, you use the fake store type, which prefills data instead of connecting to a distant secret store.

API Version Compatibility

External Secrets Operator v0.16.2 is the last supporting v1beta1 API version. For v0.17.0+ versions, it provides exclusively v1.

apiVersion: external-secrets.io/v1
kind: SecretStore
metadata:
name: fake
spec:
provider:
fake:
data:
- key: "/foo/bar"
value: "HELLO1"
version: "v1"
- key: "/foo/bar"
value: "HELLO2"
version: "v2"
- key: "/foo/baz"
value: '{"john": "doe"}'
version: "v1"

Inside the cluster, create the store with kubectl apply -f fake.yaml. This creates a corresponding store in the control plane cluster. You can then create an ExternalSecret in the cluster, which references the SecretStore.

apiVersion: external-secrets.io/v1
kind: ExternalSecret
metadata:
name: example
spec:
refreshInterval: 1h
secretStoreRef:
name: fake
kind: SecretStore
target:
name: secret-to-be-created
data:
- secretKey: foo_bar
remoteRef:
key: /foo/bar
version: v1
dataFrom:
- extract:
key: /foo/baz
version: v1

After the ExternalSecret is created in the cluster, the integration creates a corresponding resource inside the control plane cluster. The external secret operator running in the control plane cluster creates the corresponding Kubernetes secret which the integration imports into the cluster. Running kubectl get secrets in the cluster includes the secret-to-be-created in its output.

Config reference​

For every field under integrations.externalSecrets, see the integrations reference.