VaultDynamicSecret represents a generator that can create dynamic secrets from HashiCorp Vault.
4 top-level fields · last changed in External Secrets Operator v2.3.0
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
VaultDynamicSecretSpec defines the desired spec of VaultDynamicSecret.
Do not fail if no secrets are found. Useful for requests where no data is expected.
Used to select the correct ESO controller (think: ingress.ingressClassName) The ESO controller is instantiated with a specific controller name and filters VDS based on this property
Vault API method to use (GET/POST/other)
Parameters to pass to Vault write (for non-GET methods)
Vault path to obtain the dynamic secret from
Vault provider common spec
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.
A key in the referenced Secret. Some instances of this field may be defaulted, in others it may be required.
The name of the Secret resource being referred to.
The namespace of the Secret resource being referred to. Ignored if referent is not cluster-scoped, otherwise 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.
A key in the referenced Secret. Some instances of this field may be defaulted, in others it may be required.
The name of the Secret resource being referred to.
The namespace of the Secret resource being referred to. Ignored if referent is not cluster-scoped, otherwise 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
A key in the referenced Secret. Some instances of this field may be defaulted, in others it may be required.
The name of the Secret resource being referred to.
The namespace of the Secret resource being referred to. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
Path where the Certificate authentication backend is mounted in Vault, e.g: "cert"
SecretRef to a key in a Secret resource containing client private key to authenticate with Vault using the Cert authentication method
A key in the referenced Secret. Some instances of this field may be defaulted, in others it may be required.
The name of the Secret resource being referred to.
The namespace of the Secret resource being referred to. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
VaultRole specifies the Vault role to use for TLS certificate authentication.
Gcp authenticates with Vault using Google Cloud Platform authentication method GCP authentication method
Location optionally defines a location/region for the secret
Path where the GCP auth method is enabled in Vault, e.g: "gcp"
Project ID of the Google Cloud Platform project
Vault Role. In Vault, a role describes an identity with a set of permissions, groups, or policies you want to attach to a user of the secrets engine.
Specify credentials in a Secret object
The SecretAccessKey is used for authentication
A key in the referenced Secret. Some instances of this field may be defaulted, in others it may be required.
The name of the Secret resource being referred to.
The namespace of the Secret resource being referred to. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
ServiceAccountRef to a service account for impersonation
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, otherwise defaults to the namespace of the referent.
Specify a service account with Workload Identity
ClusterLocation is the location of the cluster If not specified, it fetches information from the metadata server
ClusterName is the name of the cluster If not specified, it fetches information from the metadata server
ClusterProjectID is the project ID of the cluster If not specified, it fetches information from the metadata server
ServiceAccountSelector is 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, otherwise 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
ServiceAccountSelector is 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, otherwise 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
A key in the referenced Secret. Some instances of this field may be defaulted, in others it may be required.
The name of the Secret resource being referred to.
The namespace of the Secret resource being referred to. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
The SecretAccessKey is used for authentication
A key in the referenced Secret. Some instances of this field may be defaulted, in others it may be required.
The name of the Secret resource being referred to.
The namespace of the Secret resource being referred to. Ignored if referent is not cluster-scoped, otherwise 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
A key in the referenced Secret. Some instances of this field may be defaulted, in others it may be required.
The name of the Secret resource being referred to.
The namespace of the Secret resource being referred to. Ignored if referent is not cluster-scoped, otherwise 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, otherwise 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.
A key in the referenced Secret. Some instances of this field may be defaulted, in others it may be required.
The name of the Secret resource being referred to.
The namespace of the Secret resource being referred to. Ignored if referent is not cluster-scoped, otherwise 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.
A key in the referenced Secret. Some instances of this field may be defaulted, in others it may be required.
The name of the Secret resource being referred to.
The namespace of the Secret resource being referred to. Ignored if referent is not cluster-scoped, otherwise 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, otherwise 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
A key in the referenced Secret. Some instances of this field may be defaulted, in others it may be required.
The name of the Secret resource being referred to.
The namespace of the Secret resource being referred to. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
Username is an LDAP username 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.
A key in the referenced Secret. Some instances of this field may be defaulted, in others it may be required.
The name of the Secret resource being referred to.
The namespace of the Secret resource being referred to. Ignored if referent is not cluster-scoped, otherwise 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: "userpass"
SecretRef to a key in a Secret resource containing password for the user used to authenticate with Vault using the UserPass authentication method
A key in the referenced Secret. Some instances of this field may be defaulted, in others it may be required.
The name of the Secret resource being referred to.
The namespace of the Secret resource being referred to. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
Username is a username 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".
CheckAndSet defines the Check-And-Set (CAS) settings for PushSecret operations. Only applies to Vault KV v2 stores. When enabled, write operations must include the current version of the secret to prevent unintentional overwrites.
Required when true, all write operations must include a check-and-set parameter. This helps prevent unintentional overwrites of secrets.
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
Headers to be added in Vault request
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'.
A key in the referenced Secret. Some instances of this field may be defaulted, in others it may be required.
The name of the Secret resource being referred to.
The namespace of the Secret resource being referred to. Ignored if referent is not cluster-scoped, otherwise 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'.
A key in the referenced Secret. Some instances of this field may be defaulted, in others it may be required.
The name of the Secret resource being referred to.
The namespace of the Secret resource being referred to. Ignored if referent is not cluster-scoped, otherwise 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".
Result type defines which data is returned from the generator. By default, it is the "data" section of the Vault API response. When using e.g. /auth/token/create the "data" section is empty but the "auth" section contains the generated token. Please refer to the vault docs regarding the result data structure. Additionally, accessing the raw response is possibly by using "Raw" result type.
Used to configure http retries if failed
Source: bundle.yaml
Changes to VaultDynamicSecret (generators.external-secrets.io/v1alpha1) in each External Secrets Operator version, compared to the version before it.
1 property has been added
Released · View VaultDynamicSecret in v2.3.0
2 properties have changed the description
Released · View VaultDynamicSecret in v2.2.0
1 property has been added
Released · View VaultDynamicSecret in v1.1.0
The description of VaultDynamicSecret has changed
3 properties have changed the description
Released · View VaultDynamicSecret in v0.20.4
1 property has been added
Released · View VaultDynamicSecret in v0.20.2
1 property has been added
Released · View VaultDynamicSecret in v0.20.0
1 property is no longer required
Released · View VaultDynamicSecret in v0.14.4
3 properties have changed the description
Released · View VaultDynamicSecret in v0.14.3
1 property has changed the description
Released · View VaultDynamicSecret in v0.14.1
1 property has been added
Released · View VaultDynamicSecret in v0.13.0
31 properties have changed the description
Released · View VaultDynamicSecret in v0.11.0
1 property has been added
Released · View VaultDynamicSecret in v0.10.6
1 property has been added
Released · View VaultDynamicSecret in v0.10.0
1 property has been added
Released · View VaultDynamicSecret in v0.9.14
1 property has been added
70 properties have changed the description
Released · View VaultDynamicSecret in v0.9.12
1 property has been added
Released · View VaultDynamicSecret in v0.9.2
65 properties have changed the description
Released · View VaultDynamicSecret in v0.9.0
65 properties have changed the description
Released · View VaultDynamicSecret in v0.8.12
4 properties have been added
1 property is no longer required
Released · View VaultDynamicSecret in v0.8.2
4 properties have been removed
1 property is now required
Released · View VaultDynamicSecret in v0.8.0
VaultDynamicSecret was first seen on this version of External Secrets Operator
Released · View VaultDynamicSecret in v0.7.3
No examples of VaultDynamicSecret yet. Contribute one on GitHub.
kubespec.dev