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.9.18
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 constraint a ClusterSecretStore to specific namespaces. Relevant only to ClusterSecretStore
Choose namespace using a labelSelector
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key is the label key that the selector applies to.
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
Choose namespaces by name
Used to select the correct ESO controller (think: ingress.ingressClassName) The ESO 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
Akeyless configures this store to sync secrets using Akeyless Vault provider
Akeyless GW API Url from which the secrets to be fetched from.
Auth configures how the operator authenticates with Akeyless.
Kubernetes authenticates with Akeyless by passing the ServiceAccount token stored in the named Secret resource.
the Akeyless Kubernetes auth-method access-id
Kubernetes-auth configuration name in Akeyless-Gateway
Optional secret field containing a Kubernetes ServiceAccount JWT used for authenticating with Akeyless. 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 Akeyless. If the service account selector is not supplied, the secretRef will be used instead.
Audience specifies the `aud` claim for the service account token If the service account uses a well-known annotation for e.g. IRSA or GCP Workload Identity then this audiences will be appended to the list
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.
Reference to a Secret that contains the details to authenticate with Akeyless.
The SecretAccessID 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.
A reference to a specific 'key' within a Secret resource, In some instances, `key` is a required field.
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.
A reference to a specific 'key' within a Secret resource, In some instances, `key` is a required field.
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/base64 encoded CA bundle used to validate Akeyless Gateway certificate. Only used if the AkeylessGWApiURL URL is using HTTPS protocol. If not set the system root certificates are used to validate the TLS connection.
The provider for the CA bundle to use to validate Akeyless Gateway certificate.
The key where the CA certificate can be found in the Secret or ConfigMap.
The name of the object located at the provider type.
The namespace the Provider type is in. Can only be defined when used in a ClusterSecretStore.
The type of provider to use such as "Secret", or "ConfigMap".
Alibaba configures this store to sync secrets using Alibaba Cloud provider
AlibabaAuth contains a secretRef for credentials.
Authenticate against Alibaba using RRSA.
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
AdditionalRoles is a chained list of Role ARNs which the provider will sequentially assume before assuming the Role
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.
Audience specifies the `aud` claim for the service account token If the service account uses a well-known annotation for e.g. IRSA or GCP Workload Identity then this audiences will be appended to the list
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.
The SessionToken used for authentication This must be defined if AccessKeyID and SecretAccessKey are temporary credentials see: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_use-resources.html
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 External ID set on assumed IAM roles
AWS Region to be used for the provider
Role is a Role ARN which the provider will assume
SecretsManager defines how the provider behaves when interacting with AWS SecretsManager
Specifies whether to delete the secret without any recovery window. You can't use both this parameter and RecoveryWindowInDays in the same call. If you don't use either, then by default Secrets Manager uses a 30 day recovery window. see: https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_DeleteSecret.html#SecretsManager-DeleteSecret-request-ForceDeleteWithoutRecovery
The number of days from 7 to 30 that Secrets Manager waits before permanently deleting the secret. You can't use both this parameter and ForceDeleteWithoutRecovery in the same call. If you don't use either, then by default Secrets Manager uses a 30 day recovery window. see: https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_DeleteSecret.html#SecretsManager-DeleteSecret-request-RecoveryWindowInDays
Service defines which service should be used to fetch the secrets
AWS STS assume role session tags
AWS STS assume role transitive session tags. Required when multiple rules are used with the provider
AzureKV configures this store to sync secrets using Azure Key Vault provider
Auth configures how the operator authenticates with Azure. Required for ServicePrincipal auth type. Optional for WorkloadIdentity.
The Azure ClientCertificate 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 clientId of the service principle or managed identity 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.
The Azure tenantId of the managed identity 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.
Auth type defines how to authenticate to the keyvault service. Valid values are: - "ServicePrincipal" (default): Using a service principal (tenantId, clientId, clientSecret) - "ManagedIdentity": Using Managed Identity assigned to the pod (see aad-pod-identity)
EnvironmentType specifies the Azure cloud environment endpoints to use for connecting and authenticating with Azure. By default it points to the public cloud AAD endpoint. The following endpoints are available, also see here: https://github.com/Azure/go-autorest/blob/main/autorest/azure/environments.go#L152 PublicCloud, USGovernmentCloud, ChinaCloud, GermanCloud
If multiple Managed Identity is assigned to the pod, you can select the one to be used
ServiceAccountRef specified the service account that should be used when authenticating with WorkloadIdentity.
Audience specifies the `aud` claim for the service account token If the service account uses a well-known annotation for e.g. IRSA or GCP Workload Identity then this audiences will be appended to the list
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.
TenantID configures the Azure Tenant to send requests to. Required for ServicePrincipal auth type. Optional for WorkloadIdentity.
Vault Url from which the secrets to be fetched from.
Chef configures this store to sync secrets with chef server
Auth defines the information necessary to authenticate against chef Server
ChefAuthSecretRef holds secret references for chef server login credentials.
SecretKey is the Signing Key in PEM format, 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.
ServerURL is the chef server URL used to connect to. If using orgs you should include your org in the url and terminate the url with a "/"
UserName should be the user ID on the chef server
Conjur configures this store to sync secrets using conjur provider
A reference to a specific 'key' within a Secret resource, In some instances, `key` is a required field.
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.
A reference to a specific 'key' within a Secret resource, In some instances, `key` is a required field.
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 HostID for JWT authentication. This may be used depending on how the Conjur JWT authenticator policy is configured.
Optional SecretRef that refers to a key in a Secret resource containing JWT token to authenticate with Conjur using the JWT 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.
Optional ServiceAccountRef specifies the Kubernetes service account for which to request a token for with the `TokenRequest` API.
Audience specifies the `aud` claim for the service account token If the service account uses a well-known annotation for e.g. IRSA or GCP Workload Identity then this audiences will be appended to the list
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.
The conjur authn jwt webservice id
Used to provide custom certificate authority (CA) certificates for a secret store. The CAProvider points to a Secret or ConfigMap resource that contains a PEM-encoded certificate.
The key where the CA certificate can be found in the Secret or ConfigMap.
The name of the object located at the provider type.
The namespace the Provider type is in. Can only be defined when used in a ClusterSecretStore.
The type of provider to use such as "Secret", or "ConfigMap".
Delinea DevOps Secrets Vault https://docs.delinea.com/online-help/products/devops-secrets-vault/current
ClientID is the non-secret part of the credential.
SecretRef references a key in a secret that will be used as value.
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.
Value can be specified directly to set a value without using a secret.
ClientSecret is the secret part of the credential.
SecretRef references a key in a secret that will be used as value.
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.
Value can be specified directly to set a value without using a secret.
Tenant is the chosen hostname / site name.
TLD is based on the server location that was chosen during provisioning. If unset, defaults to "com".
URLTemplate If unset, defaults to "https://%s.secretsvaultcloud.%s/v1/%s%s".
Doppler configures this store to sync secrets using the Doppler provider
Auth configures how the Operator authenticates with the Doppler API
The DopplerToken is used for authentication. See https://docs.doppler.com/reference/api#authentication for auth token types. The Key attribute defaults to dopplerToken if not specified.
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.
Doppler config (required if not using a Service Token)
Format enables the downloading of secrets as a file (string)
Environment variable compatible name transforms that change secret names to a different format
Doppler project (required if not using a Service Token)
Fake configures a store with static key/value pairs
Deprecated: ValueMap is deprecated and is intended to be removed in the future, use the `value` field instead.
Fortanix configures this store to sync secrets using the Fortanix provider
APIKey is the API token to access SDKMS Applications.
SecretRef is a reference to a secret containing the SDKMS API Key.
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.
APIURL is the URL of SDKMS API. Defaults to `sdkms.fortanix.com`.
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.
A reference to a ServiceAccount resource.
Audience specifies the `aud` claim for the service account token If the service account uses a well-known annotation for e.g. IRSA or GCP Workload Identity then this audiences will be appended to the list
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.
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.
Environment environment_scope of gitlab CI/CD variables (Please see https://docs.gitlab.com/ee/ci/environments/#create-a-static-environment on how to create environments)
GroupIDs specify, which gitlab groups to pull secrets from. Group secrets are read from left to right followed by the project variables.
InheritFromGroups specifies whether parent groups should be discovered and checked for secrets.
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.
IBM Container-based auth with IAM Trusted Profile.
the IBM Trusted Profile
Location the token is mounted on the pod
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
KeeperSecurity configures this store to sync secrets using the KeeperSecurity provider
A reference to a specific 'key' within a Secret resource, In some instances, `key` is a required field.
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 configures this store to sync secrets using a Kubernetes cluster provider
Auth configures how secret-manager authenticates with a Kubernetes instance.
has both clientCert and clientKey as secretKeySelector
A reference to a specific 'key' within a Secret resource, In some instances, `key` is a required field.
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.
A reference to a specific 'key' within a Secret resource, In some instances, `key` is a required field.
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.
points to a service account that should be used for authentication
Audience specifies the `aud` claim for the service account token If the service account uses a well-known annotation for e.g. IRSA or GCP Workload Identity then this audiences will be appended to the list
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.
use static token to authenticate with
A reference to a specific 'key' within a Secret resource, In some instances, `key` is a required field.
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.
Remote namespace to fetch the secrets from
configures the Kubernetes server Address.
CABundle is a base64-encoded CA certificate
see: https://external-secrets.io/v0.4.1/spec/#external-secrets.io/v1alpha1.CAProvider
The key where the CA certificate can be found in the Secret or ConfigMap.
The name of the object located at the provider type.
The namespace the Provider type is in. Can only be defined when used in a ClusterSecretStore.
The type of provider to use such as "Secret", or "ConfigMap".
configures the Kubernetes server Address.
Onboardbase configures this store to sync secrets using the Onboardbase provider
APIHost use this to configure the host url for the API for selfhosted installation, default is https://public.onboardbase.com/api/v1/
Auth configures how the Operator authenticates with the Onboardbase API
OnboardbaseAPIKey is the APIKey generated by an admin account. It is used to recognize and authorize access to a project and environment within onboardbase
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.
OnboardbasePasscode is the passcode attached to the API Key
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.
Environment is the name of an environmnent within a project to pull the secrets from
Project is an onboardbase project that the secrets should be pulled from
OnePassword configures this store to sync secrets using the 1Password Cloud provider
Auth defines the information necessary to authenticate against OnePassword Connect Server
OnePasswordAuthSecretRef holds secret references for 1Password credentials.
The ConnectToken is used for authentication to a 1Password Connect Server.
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.
ConnectHost defines the OnePassword Connect Server to connect to
Vaults defines which OnePassword vaults to search in which order
Oracle configures this store to sync secrets using Oracle Vault provider
Auth configures how secret-manager authenticates with the Oracle Vault. If empty, use the instance principal, otherwise the user credentials specified in Auth.
SecretRef to pass through sensitive information.
Fingerprint is the fingerprint of the API private key.
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.
PrivateKey is the user's API Signing Key in PEM format, 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.
Tenancy is the tenancy OCID where user is located.
User is an access OCID specific to the account.
Compartment is the vault compartment OCID. Required for PushSecret
EncryptionKey is the OCID of the encryption key within the vault. Required for PushSecret
The type of principal to use for authentication. If left blank, the Auth struct will determine the principal type. This optional field must be specified if using workload identity.
Region is the region where vault is located.
ServiceAccountRef specified the service account that should be used when authenticating with WorkloadIdentity.
Audience specifies the `aud` claim for the service account token If the service account uses a well-known annotation for e.g. IRSA or GCP Workload Identity then this audiences will be appended to the list
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.
Vault is the vault's OCID of the specific vault where secret is located.
Auth defines the information necessary to authenticate against Passbolt Server
A reference to a specific 'key' within a Secret resource, In some instances, `key` is a required field.
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.
A reference to a specific 'key' within a Secret resource, In some instances, `key` is a required field.
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.
Host defines the Passbolt Server to connect to
Configures a store to sync secrets with a Password Depot instance.
Auth configures how secret-manager authenticates with a Password Depot instance.
Username / Password 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.
Database to use as source
URL configures the Password Depot instance URL.
Pulumi configures this store to sync secrets using the Pulumi provider
AccessToken is the access tokens to sign in to the Pulumi Cloud Console.
SecretRef is a reference to a secret containing the Pulumi API 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.
APIURL is the URL of the Pulumi API.
Environment are YAML documents composed of static key-value pairs, programmatic expressions, dynamically retrieved values from supported providers including all major clouds, and other Pulumi ESC environments. To create a new environment, visit https://www.pulumi.com/docs/esc/environments/ for more information.
Organization are a space to collaborate on shared projects and stacks. To create a new organization, visit https://app.pulumi.com/ and click "New Organization".
Scaleway
AccessKey is the non-secret part of the api key.
SecretRef references a key in a secret that will be used as value.
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.
Value can be specified directly to set a value without using a secret.
APIURL is the url of the api to use. Defaults to https://api.scaleway.com
ProjectID is the id of your project, which you can find in the console: https://console.scaleway.com/project/settings
Region where your secrets are located: https://developers.scaleway.com/en/quickstart/#region-and-zone
SecretKey is the non-secret part of the api key.
SecretRef references a key in a secret that will be used as value.
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.
Value can be specified directly to set a value without using a secret.
Senhasegura configures this store to sync secrets using senhasegura provider
Auth defines parameters to authenticate in senhasegura
A reference to a specific 'key' within a Secret resource, In some instances, `key` is a required field.
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.
IgnoreSslCertificate defines if SSL certificate must be ignored
Module defines which senhasegura module should be used to get secrets
URL of senhasegura
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 ID 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 id.
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.
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.
Iam authenticates with vault by passing a special AWS request signed with AWS IAM credentials AWS IAM authentication method
AWS External ID set on assumed IAM roles
Specify a service account with IRSA enabled
A reference to a ServiceAccount resource.
Audience specifies the `aud` claim for the service account token If the service account uses a well-known annotation for e.g. IRSA or GCP Workload Identity then this audiences will be appended to the list
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.
Path where the AWS auth method is enabled in Vault, e.g: "aws"
AWS region
This is the AWS role to be assumed before talking to vault
Specify credentials in a Secret object
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.
The SessionToken used for authentication This must be defined if AccessKeyID and SecretAccessKey are temporary credentials see: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_use-resources.html
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.
X-Vault-AWS-IAM-Server-ID is an additional header used by Vault IAM auth method to mitigate against different types of replay attacks. More details here: https://developer.hashicorp.com/vault/docs/auth/aws
Vault Role. In vault, a role describes an identity with a set of permissions, groups, or policies you want to attach a user of the secrets engine
Jwt authenticates with Vault by passing role and JWT token using the JWT/OIDC authentication method
Optional ServiceAccountToken specifies the Kubernetes service account for which to request a token for with the `TokenRequest` API.
Optional audiences field that will be used to request a temporary Kubernetes service account token for the service account referenced by `serviceAccountRef`. Defaults to a single audience `vault` it not specified. Deprecated: use serviceAccountRef.Audiences instead
Optional expiration time in seconds that will be used to request a temporary Kubernetes service account token for the service account referenced by `serviceAccountRef`. Deprecated: this will be removed in the future. Defaults to 10 minutes.
Service account field containing the name of a kubernetes ServiceAccount.
Audience specifies the `aud` claim for the service account token If the service account uses a well-known annotation for e.g. IRSA or GCP Workload Identity then this audiences will be appended to the list
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.
Path where the JWT authentication backend is mounted in Vault, e.g: "jwt"
Role is a JWT role to authenticate using the JWT/OIDC Vault authentication method
Optional SecretRef that refers 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.
Audience specifies the `aud` claim for the service account token If the service account uses a well-known annotation for e.g. IRSA or GCP Workload Identity then this audiences will be appended to the list
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
Path where the LDAP authentication backend is mounted in Vault, e.g: "ldap"
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
Name of the vault namespace to authenticate to. This can be different than the namespace your secret is in. 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 This will default to Vault.Namespace field if set, or empty otherwise
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.
UserPass authenticates with Vault by passing username/password pair
Path where the UserPassword authentication backend is mounted in Vault, e.g: "user"
SecretRef to a key in a Secret resource containing password for the user used to authenticate with Vault using the UserPass 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 user name used to authenticate using the UserPass Vault authentication method
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.
The provider for the CA bundle to use to validate Vault server certificate.
The key where the CA certificate can be found in the Secret or ConfigMap.
The name of the object located at the provider type.
The namespace the Provider type is in. Can only be defined when used in a ClusterSecretStore.
The type of provider to use such as "Secret", or "ConfigMap".
ForwardInconsistent tells Vault to forward read-after-write requests to the Vault leader instead of simply retrying within a loop. This can increase performance if the option is enabled serverside. https://www.vaultproject.io/docs/configuration/replication#allow_forwarding_via_header
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.
ReadYourWrites ensures isolated read-after-write semantics by providing discovered cluster replication states in each request. More information about eventual consistency in Vault can be found here https://www.vaultproject.io/docs/enterprise/consistency
Server is the connection address for the Vault server, e.g: "https://vault.example.com:8200".
The configuration used for client side related TLS communication, when the Vault server requires mutual authentication. Only used if the Server URL is using HTTPS protocol. This parameter is ignored for plain HTTP protocol connection. It's worth noting this configuration is different from the "TLS certificates auth method", which is available under the `auth.cert` section.
CertSecretRef is a certificate added to the transport layer when communicating with the Vault server. If no key for the Secret is specified, external-secret will default to 'tls.crt'.
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.
KeySecretRef to a key in a Secret resource containing client private key added to the transport layer when communicating with the Vault server. If no key for the Secret is specified, external-secret will default to 'tls.key'.
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.
Version is the Vault KV secret engine version. This can be either "v1" or "v2". Version defaults to "v2".
Webhook configures this store to sync secrets using a generic templated webhook
Body
PEM encoded CA bundle used to validate webhook 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.
The provider for the CA bundle to use to validate webhook server certificate.
The key the value inside of the provider type to use, only used with "Secret" type
The name of the object located at the provider type.
The namespace the Provider type is in.
The type of provider to use such as "Secret", or "ConfigMap".
Headers
Webhook Method
Result formatting
Json path of return value
Secrets to fill in templates These secrets will be passed to the templating function as key value pairs under the given name
Name of this secret in templates
Secret ref to fill in credentials
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.
Timeout
Webhook url to call
YandexCertificateManager configures this store to sync secrets using Yandex Certificate Manager provider
Yandex.Cloud API endpoint (e.g. 'api.cloud.yandex.net:443')
Auth defines the information necessary to authenticate against Yandex Certificate Manager
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.
The provider for the CA bundle to use to validate Yandex.Cloud server certificate.
A reference to a specific 'key' within a Secret resource, In some instances, `key` is a required field.
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.
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.
The provider for the CA bundle to use to validate Yandex.Cloud server certificate.
A reference to a specific 'key' within a Secret resource, In some instances, `key` is a required field.
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.
Used to configure store refresh interval in seconds. Empty or 0 will default to the controller config.
Used to configure http retries if failed
SecretStoreStatus defines the observed state of the SecretStore.
SecretStoreCapabilities defines the possible operations a SecretStore can do.
Source: bundle.yaml
Changes to ClusterSecretStore (external-secrets.io/v1beta1) in each External Secrets Operator version, compared to the version before it.
1 property has been added
Released · View ClusterSecretStore in v0.9.18
2 properties have been added
3 properties have changed the description
Released · View ClusterSecretStore in v0.9.16
5 properties have been added
Released · View ClusterSecretStore in v0.9.14
2 properties have been added
Released · View ClusterSecretStore in v0.9.13
1 property has been added
197 properties have changed the description
Released · View ClusterSecretStore in v0.9.12
1 property has been added
4 properties have changed the description
Released · View ClusterSecretStore in v0.9.10
3 properties have been added
Released · View ClusterSecretStore in v0.9.9
1 property has been added
Released · View ClusterSecretStore in v0.9.8
2 properties have been added
1 property is no longer required
Released · View ClusterSecretStore in v0.9.6
1 property has been added
Released · View ClusterSecretStore in v0.9.2
1 property has been added
Released · View ClusterSecretStore in v0.9.1
3 properties have been added
163 properties have changed the description
Released · View ClusterSecretStore in v0.9.0
163 properties have changed the description
Released · View ClusterSecretStore in v0.8.12
4 properties have been added
1 property has been removed
2 properties are no longer required
2 properties have changed the description
Released · View ClusterSecretStore in v0.8.2
1 property has been added
4 properties have been removed
2 properties are now required
2 properties have changed the description
Released · View ClusterSecretStore in v0.8.0
8 properties have been added
1 property has been removed
2 properties are no longer required
2 properties have changed the description
Released · View ClusterSecretStore in v0.7.3
1 property has been added
Released · View ClusterSecretStore in v0.7.2
4 properties have been added
Released · View ClusterSecretStore in v0.7.0
1 property has been added
Released · View ClusterSecretStore in v0.6.1
10 properties have been added
1 property is no longer required
3 properties have changed the description
Released · View ClusterSecretStore in v0.6.0
1 property has been added
1 property is no longer required
4 properties have changed the description
Released · View ClusterSecretStore in v0.5.9
1 property has been added
Released · View ClusterSecretStore in v0.5.4
2 properties have been added
1 property has changed the description
Released · View ClusterSecretStore in v0.5.3
1 property has been added
Released · View ClusterSecretStore in v0.5.2
ClusterSecretStore was first seen on this version of External Secrets Operator
Released · View ClusterSecretStore in v0.5.0
No examples of ClusterSecretStore yet. Contribute one on GitHub.
kubespec.dev