ExternalSecret is the Schema for the external-secrets API. It defines how to fetch data from external APIs and make it available as Kubernetes Secrets.
5 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
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
Controls how ESO handles fetched secret data containing NUL bytes for this source.
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
The key in the Kubernetes Secret to store the value.
SourceRef allows you to override the source from which the value will be pulled.
GeneratorRef points to a generator custom resource. Deprecated: The generatorRef is not implemented in .data[]. this will be removed with v1.
Specify the apiVersion of the generator resource
Specify the Kind of the generator resource
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
Controls how ESO handles fetched secret data containing NUL bytes for this source.
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
Controls how ESO handles fetched secret data containing NUL bytes for this find source.
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 merge key/values in one single Secret The resulting key will contain all values from the specified secrets
Used to define the policy to use in conflict resolution.
Used to define the target key of the merge operation. Required if strategy is JSON. Ignored otherwise.
Used to define key priority in conflict resolution.
Used to define the policy when a key in the priority list does not exist in the input.
Used to define the strategy to use in the merge operation.
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.
Used to apply string transformation on the secrets. The resulting key will be the output of the template applied by the operation.
Used to define the template to apply on the secret name. `.value ` will specify the secret name in the template.
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.
Specify the apiVersion of the generator resource
Specify the Kind of the generator resource
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, specified as Golang Duration strings. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h" Example values: "1h0m0s", "2h30m0s", "10m0s" May be set to "0s" to fetch and create it once. Defaults to 1h0m0s.
RefreshPolicy determines how the ExternalSecret should be refreshed: - CreatedOnce: Creates the Secret only if it does not exist and does not update it thereafter - Periodic: Synchronizes the Secret from the external source at regular intervals specified by refreshInterval. No periodic updates occur if refreshInterval is 0. - OnChange: Only synchronizes the Secret when the ExternalSecret's metadata or specification changes
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
Manifest defines a custom Kubernetes resource to create instead of a Secret. When specified, ExternalSecret will create the resource type defined here (e.g., ConfigMap, Custom Resource) instead of a Secret. Warning: Using Generic target. Make sure access policies and encryption are properly configured.
APIVersion of the target resource (e.g., "v1" for ConfigMap, "argoproj.io/v1alpha1" for ArgoCD Application)
Kind of the target resource (e.g., "ConfigMap", "Application")
The name of the Secret resource to be managed. Defaults to the .metadata.name of the ExternalSecret resource
Template defines a blueprint for the created Secret resource.
EngineVersion specifies the template engine version that should be used to compile/execute the template specified in .data and .templateFrom[].
TemplateMergePolicy defines how the rendered template should be merged with the existing Secret data.
ExternalSecretTemplateMetadata defines metadata fields for the Secret blueprint.
TemplateRef specifies a reference to either a ConfigMap or a Secret resource.
A list of keys in the ConfigMap/Secret to use as templates for Secret data
A key in the ConfigMap/Secret
TemplateScope specifies how the template keys should be interpreted.
The name of the ConfigMap/Secret resource
TemplateRef specifies a reference to either a ConfigMap or a Secret resource.
A list of keys in the ConfigMap/Secret to use as templates for Secret data
A key in the ConfigMap/Secret
TemplateScope specifies how the template keys should be interpreted.
The name of the ConfigMap/Secret resource
Target specifies where to place the template result. For Secret resources, common values are: "Data", "Annotations", "Labels". For custom resources (when spec.target.manifest is set), this supports nested paths like "spec.database.config" or "data".
ExternalSecretStatus defines the observed state of ExternalSecret.
Binding represents a servicebinding.io Provisioned Service reference to the secret
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
ExternalSecretConditionType defines a value type for ExternalSecret conditions.
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/v1) in each External Secrets Operator version, compared to the version before it.
3 properties have been added
Released · View ExternalSecret in v2.3.0
1 property has changed the description
Released · View ExternalSecret in v1.1.1
1 property has been added
1 property has changed the description
Released · View ExternalSecret in v1.0.0
The description of ExternalSecret has changed
9 properties have changed the description
Released · View ExternalSecret in v0.20.4
1 property has been added
Released · View ExternalSecret in v0.20.2
1 property has been added
Released · View ExternalSecret in v0.20.0
1 property has been added
Released · View ExternalSecret in v0.18.1
ExternalSecret was first seen on this version of External Secrets Operator
Released · View ExternalSecret in v0.16.0
No examples of ExternalSecret yet. Contribute one on GitHub.
kubespec.dev