mirror of
https://github.com/external-secrets/external-secrets.git
synced 2024-12-14 11:57:59 +00:00
docs: add more details in the externalsecret comments in the API section (creationPolicy + deletionPolicy) (#3725)
Signed-off-by: c-neto <carlos.neto.dev@gmail.com>
This commit is contained in:
parent
71f9bd0624
commit
d10a66ee68
1 changed files with 11 additions and 10 deletions
|
@ -32,17 +32,18 @@ spec:
|
||||||
# It is immutable
|
# It is immutable
|
||||||
name: application-config
|
name: application-config
|
||||||
|
|
||||||
# Enum with values: 'Owner', 'Merge', or 'None'
|
# Specifies the ExternalSecret ownership details in the created Secret. Options:
|
||||||
# Default value of 'Owner'
|
# - Owner: (default) Creates the Secret and sets .metadata.ownerReferences. If the ExternalSecret is deleted, the Secret will also be deleted.
|
||||||
# Owner creates the secret and sets .metadata.ownerReferences of the resource
|
# - Merge: Does not create the Secret but merges data fields into the existing Secret (expects the Secret to already exist).
|
||||||
# Merge does not create the secret, but merges in the data fields to the secret
|
# - Orphan: Creates the Secret but does not set .metadata.ownerReferences. If the Secret already exists, it will be updated.
|
||||||
# None does not create a secret (future use with injector)
|
# - None: Does not create or update the Secret (reserved for future use with injector).
|
||||||
creationPolicy: 'Merge'
|
creationPolicy: Merge
|
||||||
|
|
||||||
# DeletionPolicy defines how/when to delete the Secret in Kubernetes
|
# Specifies what happens to the Secret when data fields are deleted from the provider (e.g., Vault, AWS Parameter Store). Options:
|
||||||
# if the provider secret gets deleted.
|
# - Retain: (default) Retains the Secret if all Secret data fields have been deleted from the provider.
|
||||||
# Valid values are Delete, Merge, Retain
|
# - Delete: Removes the Secret if all Secret data fields from the provider are deleted.
|
||||||
deletionPolicy: "Retain"
|
# - Merge: Removes keys from the Secret but not the Secret itself.
|
||||||
|
deletionPolicy: Retain
|
||||||
|
|
||||||
# Specify a blueprint for the resulting Kind=Secret
|
# Specify a blueprint for the resulting Kind=Secret
|
||||||
template:
|
template:
|
||||||
|
|
Loading…
Reference in a new issue