ClusterSecretStore represents a secure external location for storing secrets, which can be referenced as part of `storeRef` fields.
5 top-level fields · last changed in External Secrets Operator v0.3.6
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
SecretStoreSpec defines the desired state of SecretStore.
Used to select the correct KES controller (think: ingress.ingressClassName) The KES controller is instantiated with a specific controller name and filters ES based on this property
Used to configure the provider. Only one provider may be set
Alibaba configures this store to sync secrets using Alibaba Cloud provider
AlibabaAuth contains a secretRef for credentials.
AlibabaAuthSecretRef holds secret references for Alibaba credentials.
The AccessKeyID is used for authentication
The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required.
The name of the Secret resource being referred to.
Namespace of the resource being referred to. Ignored if referent is not cluster-scoped. cluster-scoped defaults to the namespace of the referent.
The AccessKeySecret is used for authentication
The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required.
The name of the Secret resource being referred to.
Namespace of the resource being referred to. Ignored if referent is not cluster-scoped. cluster-scoped defaults to the namespace of the referent.
Alibaba Region to be used for the provider
AWS configures this store to sync secrets using AWS Secret Manager provider
Auth defines the information necessary to authenticate against AWS if not set aws sdk will infer credentials from your environment see: https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials
Authenticate against AWS using service account tokens.
A reference to a ServiceAccount resource.
The name of the ServiceAccount resource being referred to.
Namespace of the resource being referred to. Ignored if referent is not cluster-scoped. cluster-scoped defaults to the namespace of the referent.
AWSAuthSecretRef holds secret references for AWS credentials both AccessKeyID and SecretAccessKey must be defined in order to properly authenticate.
The AccessKeyID is used for authentication
The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required.
The name of the Secret resource being referred to.
Namespace of the resource being referred to. Ignored if referent is not cluster-scoped. cluster-scoped defaults to the namespace of the referent.
The SecretAccessKey is used for authentication
The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required.
The name of the Secret resource being referred to.
Namespace of the resource being referred to. Ignored if referent is not cluster-scoped. cluster-scoped defaults to the namespace of the referent.
AWS Region to be used for the provider
Role is a Role ARN which the SecretManager provider will assume
Service defines which service should be used to fetch the secrets
AzureKV configures this store to sync secrets using Azure Key Vault provider
Auth configures how the operator authenticates with Azure.
The Azure clientId of the service principle used for authentication.
The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required.
The name of the Secret resource being referred to.
Namespace of the resource being referred to. Ignored if referent is not cluster-scoped. cluster-scoped defaults to the namespace of the referent.
The Azure ClientSecret of the service principle used for authentication.
The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required.
The name of the Secret resource being referred to.
Namespace of the resource being referred to. Ignored if referent is not cluster-scoped. cluster-scoped defaults to the namespace of the referent.
TenantID configures the Azure Tenant to send requests to.
Vault Url from which the secrets to be fetched from.
GCPSM configures this store to sync secrets using Google Cloud Platform Secret Manager provider
Auth defines the information necessary to authenticate against GCP
The SecretAccessKey is used for authentication
The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required.
The name of the Secret resource being referred to.
Namespace of the resource being referred to. Ignored if referent is not cluster-scoped. cluster-scoped defaults to the namespace of the referent.
ProjectID project where secret is located
GItlab configures this store to sync secrets using Gitlab Variables provider
Auth configures how secret-manager authenticates with a GitLab instance.
AccessToken is used for authentication.
The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required.
The name of the Secret resource being referred to.
Namespace of the resource being referred to. Ignored if referent is not cluster-scoped. cluster-scoped defaults to the namespace of the referent.
ProjectID specifies a project where secrets are located.
URL configures the GitLab instance URL. Defaults to https://gitlab.com/.
IBM configures this store to sync secrets using IBM Cloud provider
Auth configures how secret-manager authenticates with the IBM secrets manager.
The SecretAccessKey is used for authentication
The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required.
The name of the Secret resource being referred to.
Namespace of the resource being referred to. Ignored if referent is not cluster-scoped. cluster-scoped defaults to the namespace of the referent.
ServiceURL is the Endpoint URL that is specific to the Secrets Manager service instance
Oracle configures this store to sync secrets using Oracle Vault provider
Auth configures how secret-manager authenticates with the Oracle Vault.
SecretRef to pass through sensitive information.
projectID is an access token specific to the secret.
The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required.
The name of the Secret resource being referred to.
Namespace of the resource being referred to. Ignored if referent is not cluster-scoped. cluster-scoped defaults to the namespace of the referent.
The Access Token is used for authentication
The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required.
The name of the Secret resource being referred to.
Namespace of the resource being referred to. Ignored if referent is not cluster-scoped. cluster-scoped defaults to the namespace of the referent.
projectID is an access token specific to the secret.
projectID is an access token specific to the secret.
User is an access OCID specific to the account.
Vault configures this store to sync secrets using Hashi provider
Auth configures how secret-manager authenticates with the Vault server.
AppRole authenticates with Vault using the App Role auth mechanism, with the role and secret stored in a Kubernetes Secret resource.
Path where the App Role authentication backend is mounted in Vault, e.g: "approle"
RoleID configured in the App Role authentication backend when setting up the authentication backend in Vault.
Reference to a key in a Secret that contains the App Role secret used to authenticate with Vault. The `key` field must be specified and denotes which entry within the Secret resource is used as the app role secret.
The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required.
The name of the Secret resource being referred to.
Namespace of the resource being referred to. Ignored if referent is not cluster-scoped. cluster-scoped defaults to the namespace of the referent.
Cert authenticates with TLS Certificates by passing client certificate, private key and ca certificate Cert authentication method
ClientCert is a certificate to authenticate using the Cert Vault authentication method
The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required.
The name of the Secret resource being referred to.
Namespace of the resource being referred to. Ignored if referent is not cluster-scoped. cluster-scoped defaults to the namespace of the referent.
SecretRef to a key in a Secret resource containing client private key to authenticate with Vault using the Cert authentication method
The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required.
The name of the Secret resource being referred to.
Namespace of the resource being referred to. Ignored if referent is not cluster-scoped. cluster-scoped defaults to the namespace of the referent.
Jwt authenticates with Vault by passing role and JWT token using the JWT/OIDC authentication method
Role is a JWT role to authenticate using the JWT/OIDC Vault authentication method
SecretRef to a key in a Secret resource containing JWT token to authenticate with Vault using the JWT/OIDC authentication method
The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required.
The name of the Secret resource being referred to.
Namespace of the resource being referred to. Ignored if referent is not cluster-scoped. cluster-scoped defaults to the namespace of the referent.
Kubernetes authenticates with Vault by passing the ServiceAccount token stored in the named Secret resource to the Vault server.
Path where the Kubernetes authentication backend is mounted in Vault, e.g: "kubernetes"
A required field containing the Vault Role to assume. A Role binds a Kubernetes ServiceAccount with a set of Vault policies.
Optional secret field containing a Kubernetes ServiceAccount JWT used for authenticating with Vault. If a name is specified without a key, `token` is the default. If one is not specified, the one bound to the controller will be used.
The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required.
The name of the Secret resource being referred to.
Namespace of the resource being referred to. Ignored if referent is not cluster-scoped. cluster-scoped defaults to the namespace of the referent.
Optional service account field containing the name of a kubernetes ServiceAccount. If the service account is specified, the service account secret token JWT will be used for authenticating with Vault. If the service account selector is not supplied, the secretRef will be used instead.
The name of the ServiceAccount resource being referred to.
Namespace of the resource being referred to. Ignored if referent is not cluster-scoped. cluster-scoped defaults to the namespace of the referent.
Ldap authenticates with Vault by passing username/password pair using the LDAP authentication method
SecretRef to a key in a Secret resource containing password for the LDAP user used to authenticate with Vault using the LDAP authentication method
The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required.
The name of the Secret resource being referred to.
Namespace of the resource being referred to. Ignored if referent is not cluster-scoped. cluster-scoped defaults to the namespace of the referent.
Username is a LDAP user name used to authenticate using the LDAP Vault authentication method
TokenSecretRef authenticates with Vault by presenting a token.
The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required.
The name of the Secret resource being referred to.
Namespace of the resource being referred to. Ignored if referent is not cluster-scoped. cluster-scoped defaults to the namespace of the referent.
PEM encoded CA bundle used to validate Vault server certificate. Only used if the Server URL is using HTTPS protocol. This parameter is ignored for plain HTTP protocol connection. If not set the system root certificates are used to validate the TLS connection.
Name of the vault namespace. Namespaces is a set of features within Vault Enterprise that allows Vault environments to support Secure Multi-tenancy. e.g: "ns1". More about namespaces can be found here https://www.vaultproject.io/docs/enterprise/namespaces
Path is the mount path of the Vault KV backend endpoint, e.g: "secret". The v2 KV secret engine version specific "/data" path suffix for fetching secrets from Vault is optional and will be appended if not present in specified path.
Server is the connection address for the Vault server, e.g: "https://vault.example.com:8200".
Version is the Vault KV secret engine version. This can be either "v1" or "v2". Version defaults to "v2".
YandexLockbox configures this store to sync secrets using Yandex Lockbox provider
Yandex.Cloud API endpoint (e.g. 'api.cloud.yandex.net:443')
Auth defines the information necessary to authenticate against Yandex Lockbox
The authorized key used for authentication
The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required.
The name of the Secret resource being referred to.
Namespace of the resource being referred to. Ignored if referent is not cluster-scoped. cluster-scoped defaults to the namespace of the referent.
SecretStoreStatus defines the observed state of the SecretStore.
Source: external-secrets.io_clustersecretstores.yaml
Changes to ClusterSecretStore (external-secrets.io/v1alpha1) in each External Secrets Operator version, compared to the version before it.
3 properties have been added
3 properties have changed the description
Released · View ClusterSecretStore in v0.3.6
2 properties have been added
Released · View ClusterSecretStore in v0.3.5
14 properties are no longer required
Released · View ClusterSecretStore in v0.3.4
1 property has been added
Released · View ClusterSecretStore in v0.3.3
1 property has been added
1 property is no longer required
1 property has changed the description
Released · View ClusterSecretStore in v0.3.0
2 properties have been added
Released · View ClusterSecretStore in v0.2.2
2 properties have been added
Released · View ClusterSecretStore in v0.2.0
2 properties have been added
Released · View ClusterSecretStore in v0.1.3
ClusterSecretStore was already present in this version of External Secrets Operator, the oldest one on kubespec.dev
Released · View ClusterSecretStore in v0.1.0
No examples of ClusterSecretStore yet. Contribute one on GitHub.
kubespec.dev