ExternalSecret is the Schema for the external-secrets API.
5 top-level fields · last changed in External Secrets Operator v0.8.12
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
ExternalSecretSpec defines the desired state of ExternalSecret.
Data defines the connection between the Kubernetes Secret keys and the Provider data
RemoteRef points to the remote secret and defines which secret (version/property/..) to fetch.
Used to define a conversion Strategy
Used to define a decoding Strategy
Key is the key used in the Provider, mandatory
Policy for fetching tags/labels from provider secrets, possible options are Fetch, None. Defaults to None
Used to select a specific property of the Provider value (if a map), if supported
Used to select a specific version of the Provider value, if supported
SecretKey defines the key in which the controller stores the value. This is the key in the Kind=Secret
SourceRef allows you to override the source from which the value will pulled from.
GeneratorRef points to a generator custom resource in
Specify the apiVersion of the generator resource
Specify the Kind of the resource, e.g. Password, ACRAccessToken etc.
Specify the name of the generator resource
SecretStoreRef defines which SecretStore to fetch the ExternalSecret data.
Kind of the SecretStore resource (SecretStore or ClusterSecretStore) Defaults to `SecretStore`
Name of the SecretStore resource
DataFrom is used to fetch all properties from a specific Provider data If multiple entries are specified, the Secret keys are merged in the specified order
Used to extract multiple key/value pairs from one secret Note: Extract does not support sourceRef.Generator or sourceRef.GeneratorRef.
Used to define a conversion Strategy
Used to define a decoding Strategy
Key is the key used in the Provider, mandatory
Policy for fetching tags/labels from provider secrets, possible options are Fetch, None. Defaults to None
Used to select a specific property of the Provider value (if a map), if supported
Used to select a specific version of the Provider value, if supported
Used to find secrets based on tags or regular expressions Note: Find does not support sourceRef.Generator or sourceRef.GeneratorRef.
Used to define a conversion Strategy
Used to define a decoding Strategy
Finds secrets based on the name.
Finds secrets base
A root path to start the find operations.
Find secrets based on tags.
Used to rewrite secret Keys after getting them from the secret Provider Multiple Rewrite operations can be provided. They are applied in a layered order (first to last)
Used to rewrite with regular expressions. The resulting key will be the output of a regexp.ReplaceAll operation.
Used to define the regular expression of a re.Compiler.
Used to define the target pattern of a ReplaceAll operation.
SourceRef points to a store or generator which contains secret values ready to use. Use this in combination with Extract or Find pull values out of a specific SecretStore. When sourceRef points to a generator Extract or Find is not supported. The generator returns a static map of values
GeneratorRef points to a generator custom resource in
Specify the apiVersion of the generator resource
Specify the Kind of the resource, e.g. Password, ACRAccessToken etc.
Specify the name of the generator resource
SecretStoreRef defines which SecretStore to fetch the ExternalSecret data.
Kind of the SecretStore resource (SecretStore or ClusterSecretStore) Defaults to `SecretStore`
Name of the SecretStore resource
RefreshInterval is the amount of time before the values are read again from the SecretStore provider Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h" May be set to zero to fetch and create it once. Defaults to 1h.
SecretStoreRef defines which SecretStore to fetch the ExternalSecret data.
Kind of the SecretStore resource (SecretStore or ClusterSecretStore) Defaults to `SecretStore`
Name of the SecretStore resource
ExternalSecretTarget defines the Kubernetes Secret to be created There can be only one target per ExternalSecret.
CreationPolicy defines rules on how to create the resulting Secret Defaults to 'Owner'
DeletionPolicy defines rules on how to delete the resulting Secret Defaults to 'Retain'
Immutable defines if the final secret will be immutable
Name defines the name of the Secret resource to be managed This field is immutable Defaults to the .metadata.name of the ExternalSecret resource
Template defines a blueprint for the created Secret resource.
ExternalSecretTemplateMetadata defines metadata fields for the Secret blueprint.
Binding represents a servicebinding.io Provisioned Service reference to the secret
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
refreshTime is the time and date the external secret was fetched and the target secret updated
SyncedResourceVersion keeps track of the last synced version
Source: bundle.yaml
Changes to ExternalSecret (external-secrets.io/v1beta1) in each External Secrets Operator version, compared to the version before it.
21 properties have changed the description
Released · View ExternalSecret in v0.8.12
2 properties have been added
Released · View ExternalSecret in v0.8.2
2 properties have been removed
Released · View ExternalSecret in v0.8.0
2 properties have been added
Released · View ExternalSecret in v0.7.3
4 properties have been added
Released · View ExternalSecret in v0.7.1
2 properties have been added
1 property is no longer required
4 properties have changed the description
Released · View ExternalSecret in v0.7.0
1 property has been added
3 properties have changed the description
Released · View ExternalSecret in v0.5.9
3 properties have been added
Released · View ExternalSecret in v0.5.8
2 properties have been added
Released · View ExternalSecret in v0.5.4
1 property is no longer required
Released · View ExternalSecret in v0.5.2
ExternalSecret was first seen on this version of External Secrets Operator
Released · View ExternalSecret in v0.5.0
No examples of ExternalSecret yet. Contribute one on GitHub.
kubespec.dev