| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493 |
- apiVersion: apiextensions.k8s.io/v1
- kind: CustomResourceDefinition
- metadata:
- annotations:
- controller-gen.kubebuilder.io/version: v0.19.0
- labels:
- external-secrets.io/component: controller
- name: externalsecrets.external-secrets.io
- spec:
- group: external-secrets.io
- names:
- categories:
- - external-secrets
- kind: ExternalSecret
- listKind: ExternalSecretList
- plural: externalsecrets
- shortNames:
- - es
- singular: externalsecret
- scope: Namespaced
- versions:
- - additionalPrinterColumns:
- - jsonPath: .spec.secretStoreRef.kind
- name: StoreType
- type: string
- - jsonPath: .spec.secretStoreRef.name
- name: Store
- type: string
- - jsonPath: .spec.refreshInterval
- name: Refresh Interval
- type: string
- - jsonPath: .status.conditions[?(@.type=="Ready")].reason
- name: Status
- type: string
- - jsonPath: .status.conditions[?(@.type=="Ready")].status
- name: Ready
- type: string
- - jsonPath: .status.refreshTime
- name: Last Sync
- type: date
- name: v1
- schema:
- openAPIV3Schema:
- description: |-
- 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.
- properties:
- apiVersion:
- description: |-
- 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
- type: string
- kind:
- description: |-
- 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
- type: string
- metadata:
- type: object
- spec:
- description: ExternalSecretSpec defines the desired state of ExternalSecret.
- properties:
- data:
- description: Data defines the connection between the Kubernetes Secret
- keys and the Provider data
- items:
- description: ExternalSecretData defines the connection between the
- Kubernetes Secret key (spec.data.<key>) and the Provider data.
- properties:
- remoteRef:
- description: |-
- RemoteRef points to the remote secret and defines
- which secret (version/property/..) to fetch.
- properties:
- conversionStrategy:
- description: Used to define a conversion Strategy. Defaults
- to Default when omitted.
- enum:
- - Default
- - Unicode
- type: string
- decodingStrategy:
- description: Used to define a decoding Strategy. Defaults
- to None when omitted.
- enum:
- - Auto
- - Base64
- - Base64URL
- - None
- type: string
- key:
- description: Key is the key used in the Provider, mandatory
- type: string
- metadataPolicy:
- description: Policy for fetching tags/labels from provider
- secrets, possible options are Fetch, None. Defaults to
- None
- enum:
- - None
- - Fetch
- type: string
- nullBytePolicy:
- description: Controls how ESO handles fetched secret data
- containing NUL bytes for this source.
- enum:
- - Ignore
- - Fail
- type: string
- property:
- description: Used to select a specific property of the Provider
- value (if a map), if supported
- type: string
- version:
- description: Used to select a specific version of the Provider
- value, if supported
- type: string
- required:
- - key
- type: object
- secretKey:
- description: The key in the Kubernetes Secret to store the value.
- maxLength: 253
- minLength: 1
- pattern: ^[-._a-zA-Z0-9]+$
- type: string
- sourceRef:
- description: |-
- SourceRef allows you to override the source
- from which the value will be pulled.
- maxProperties: 1
- minProperties: 1
- properties:
- generatorRef:
- description: |-
- GeneratorRef points to a generator custom resource.
- Deprecated: The generatorRef is not implemented in .data[].
- this will be removed with v1.
- properties:
- apiVersion:
- default: generators.external-secrets.io/v1alpha1
- description: Specify the apiVersion of the generator
- resource
- type: string
- kind:
- description: Specify the Kind of the generator resource
- enum:
- - ACRAccessToken
- - BeyondtrustWorkloadCredentialsDynamicSecret
- - ClusterGenerator
- - CloudsmithAccessToken
- - ECRAuthorizationToken
- - Fake
- - GCRAccessToken
- - GithubAccessToken
- - GitlabDeployToken
- - QuayAccessToken
- - Password
- - SSHKey
- - STSSessionToken
- - UUID
- - VaultDynamicSecret
- - Webhook
- - Grafana
- - MFA
- type: string
- name:
- description: Specify the name of the generator resource
- maxLength: 253
- minLength: 1
- pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
- type: string
- required:
- - kind
- - name
- type: object
- storeRef:
- description: SecretStoreRef defines which SecretStore to
- fetch the ExternalSecret data.
- properties:
- kind:
- description: |-
- Kind of the SecretStore resource (SecretStore or ClusterSecretStore)
- Defaults to `SecretStore`
- enum:
- - SecretStore
- - ClusterSecretStore
- type: string
- name:
- description: Name of the SecretStore resource
- maxLength: 253
- minLength: 1
- pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
- type: string
- type: object
- type: object
- required:
- - remoteRef
- - secretKey
- type: object
- type: array
- dataFrom:
- description: |-
- 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
- items:
- description: |-
- ExternalSecretDataFromRemoteRef defines the connection between the Kubernetes Secret keys and the Provider data
- when using DataFrom to fetch multiple values from a Provider.
- properties:
- extract:
- description: |-
- Used to extract multiple key/value pairs from one secret
- Note: Extract does not support sourceRef.Generator or sourceRef.GeneratorRef.
- properties:
- conversionStrategy:
- description: Used to define a conversion Strategy. Defaults
- to Default when omitted.
- enum:
- - Default
- - Unicode
- type: string
- decodingStrategy:
- description: Used to define a decoding Strategy. Defaults
- to None when omitted.
- enum:
- - Auto
- - Base64
- - Base64URL
- - None
- type: string
- key:
- description: Key is the key used in the Provider, mandatory
- type: string
- metadataPolicy:
- description: Policy for fetching tags/labels from provider
- secrets, possible options are Fetch, None. Defaults to
- None
- enum:
- - None
- - Fetch
- type: string
- nullBytePolicy:
- description: Controls how ESO handles fetched secret data
- containing NUL bytes for this source.
- enum:
- - Ignore
- - Fail
- type: string
- property:
- description: Used to select a specific property of the Provider
- value (if a map), if supported
- type: string
- version:
- description: Used to select a specific version of the Provider
- value, if supported
- type: string
- required:
- - key
- type: object
- find:
- description: |-
- Used to find secrets based on tags or regular expressions
- Note: Find does not support sourceRef.Generator or sourceRef.GeneratorRef.
- properties:
- conversionStrategy:
- description: Used to define a conversion Strategy. Defaults
- to Default when omitted.
- enum:
- - Default
- - Unicode
- type: string
- decodingStrategy:
- description: Used to define a decoding Strategy. Defaults
- to None when omitted.
- enum:
- - Auto
- - Base64
- - Base64URL
- - None
- type: string
- name:
- description: Finds secrets based on the name.
- properties:
- regexp:
- description: Finds secrets base
- type: string
- type: object
- nullBytePolicy:
- description: Controls how ESO handles fetched secret data
- containing NUL bytes for this find source.
- enum:
- - Ignore
- - Fail
- type: string
- path:
- description: A root path to start the find operations.
- type: string
- tags:
- additionalProperties:
- type: string
- description: Find secrets based on tags.
- type: object
- type: object
- rewrite:
- description: |-
- 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)
- items:
- description: ExternalSecretRewrite defines how to rewrite
- secret data values before they are written to the Secret.
- maxProperties: 1
- minProperties: 1
- properties:
- merge:
- description: |-
- Used to merge key/values in one single Secret
- The resulting key will contain all values from the specified secrets
- properties:
- conflictPolicy:
- default: Error
- description: Used to define the policy to use in conflict
- resolution.
- enum:
- - Ignore
- - Error
- type: string
- into:
- default: ""
- description: |-
- Used to define the target key of the merge operation.
- Required if strategy is JSON. Ignored otherwise.
- type: string
- priority:
- description: Used to define key priority in conflict
- resolution.
- items:
- type: string
- type: array
- priorityPolicy:
- default: Strict
- description: Used to define the policy when a key
- in the priority list does not exist in the input.
- enum:
- - IgnoreNotFound
- - Strict
- type: string
- strategy:
- default: Extract
- description: Used to define the strategy to use in
- the merge operation.
- enum:
- - Extract
- - JSON
- type: string
- type: object
- regexp:
- description: |-
- Used to rewrite with regular expressions.
- The resulting key will be the output of a regexp.ReplaceAll operation.
- properties:
- source:
- description: Used to define the regular expression
- of a re.Compiler.
- type: string
- target:
- description: Used to define the target pattern of
- a ReplaceAll operation.
- type: string
- required:
- - source
- - target
- type: object
- transform:
- description: |-
- Used to apply string transformation on the secrets.
- The resulting key will be the output of the template applied by the operation.
- properties:
- template:
- description: |-
- Used to define the template to apply on the secret name.
- `.value ` will specify the secret name in the template.
- type: string
- required:
- - template
- type: object
- type: object
- type: array
- sourceRef:
- description: |-
- 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
- maxProperties: 1
- minProperties: 1
- properties:
- generatorRef:
- description: GeneratorRef points to a generator custom resource.
- properties:
- apiVersion:
- default: generators.external-secrets.io/v1alpha1
- description: Specify the apiVersion of the generator
- resource
- type: string
- kind:
- description: Specify the Kind of the generator resource
- enum:
- - ACRAccessToken
- - BeyondtrustWorkloadCredentialsDynamicSecret
- - ClusterGenerator
- - CloudsmithAccessToken
- - ECRAuthorizationToken
- - Fake
- - GCRAccessToken
- - GithubAccessToken
- - GitlabDeployToken
- - QuayAccessToken
- - Password
- - SSHKey
- - STSSessionToken
- - UUID
- - VaultDynamicSecret
- - Webhook
- - Grafana
- - MFA
- type: string
- name:
- description: Specify the name of the generator resource
- maxLength: 253
- minLength: 1
- pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
- type: string
- required:
- - kind
- - name
- type: object
- storeRef:
- description: SecretStoreRef defines which SecretStore to
- fetch the ExternalSecret data.
- properties:
- kind:
- description: |-
- Kind of the SecretStore resource (SecretStore or ClusterSecretStore)
- Defaults to `SecretStore`
- enum:
- - SecretStore
- - ClusterSecretStore
- type: string
- name:
- description: Name of the SecretStore resource
- maxLength: 253
- minLength: 1
- pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
- type: string
- type: object
- type: object
- type: object
- type: array
- refreshInterval:
- default: 1h0m0s
- description: |-
- 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.
- type: string
- refreshPolicy:
- description: |-
- 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
- enum:
- - CreatedOnce
- - Periodic
- - OnChange
- type: string
- secretStoreRef:
- description: SecretStoreRef defines which SecretStore to fetch the
- ExternalSecret data.
- properties:
- kind:
- description: |-
- Kind of the SecretStore resource (SecretStore or ClusterSecretStore)
- Defaults to `SecretStore`
- enum:
- - SecretStore
- - ClusterSecretStore
- type: string
- name:
- description: Name of the SecretStore resource
- maxLength: 253
- minLength: 1
- pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
- type: string
- type: object
- syncWindows:
- description: |-
- SyncWindows optionally restricts when periodic refreshes may occur.
- Evaluated in UTC, only for Periodic refresh policy (or when refreshPolicy is unset).
- properties:
- kind:
- description: |-
- Kind applies to every window in the list.
- "allow" -- syncs are permitted only while at least one window is active;
- all other times are blocked.
- "deny" -- syncs are blocked while any window is active;
- all other times are permitted.
- enum:
- - allow
- - deny
- type: string
- windows:
- description: Windows is the list of schedule+duration pairs.
- items:
- description: |-
- ExternalSecretSyncWindowEntry defines a single cron-schedule + duration pair
- within a SyncWindows block.
- properties:
- duration:
- description: |-
- Duration specifies how long the window stays open after each Schedule
- firing. Example: "8h".
- type: string
- schedule:
- description: |-
- Schedule is a standard 5-field cron expression evaluated in UTC, or a
- named shorthand such as @daily or @every 1h. It marks the start time of
- each window occurrence.
- Example: "0 22 * * 1-5" opens a window every weekday at 22:00 UTC.
- minLength: 1
- pattern: ^(@(annually|yearly|monthly|weekly|daily|midnight|hourly)|@every
- [^\s]+.*|[^\s]+( [^\s]+){4})$
- type: string
- required:
- - duration
- - schedule
- type: object
- minItems: 1
- type: array
- required:
- - kind
- - windows
- type: object
- target:
- default:
- creationPolicy: Owner
- deletionPolicy: Retain
- description: |-
- ExternalSecretTarget defines the Kubernetes Secret to be created,
- there can be only one target per ExternalSecret.
- properties:
- creationPolicy:
- default: Owner
- description: |-
- CreationPolicy defines rules on how to create the resulting Secret.
- Defaults to "Owner"
- enum:
- - Owner
- - Orphan
- - Merge
- - None
- - CreateOrMerge
- type: string
- deletionPolicy:
- default: Retain
- description: |-
- DeletionPolicy defines rules on how to delete the resulting Secret.
- Defaults to "Retain"
- enum:
- - Delete
- - Merge
- - Retain
- type: string
- immutable:
- description: Immutable defines if the final secret will be immutable
- type: boolean
- manifest:
- description: |-
- 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.
- properties:
- apiVersion:
- description: APIVersion of the target resource (e.g., "v1"
- for ConfigMap, "argoproj.io/v1alpha1" for ArgoCD Application)
- minLength: 1
- type: string
- kind:
- description: Kind of the target resource (e.g., "ConfigMap",
- "Application")
- minLength: 1
- type: string
- required:
- - apiVersion
- - kind
- type: object
- name:
- description: |-
- The name of the Secret resource to be managed.
- Defaults to the .metadata.name of the ExternalSecret resource
- maxLength: 253
- minLength: 1
- pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
- type: string
- template:
- description: Template defines a blueprint for the created Secret
- resource.
- properties:
- data:
- additionalProperties:
- type: string
- type: object
- engineVersion:
- default: v2
- description: |-
- EngineVersion specifies the template engine version
- that should be used to compile/execute the
- template specified in .data and .templateFrom[].
- enum:
- - v2
- type: string
- mergePolicy:
- default: Replace
- description: TemplateMergePolicy defines how the rendered
- template should be merged with the existing Secret data.
- enum:
- - Replace
- - Merge
- type: string
- metadata:
- description: ExternalSecretTemplateMetadata defines metadata
- fields for the Secret blueprint.
- properties:
- annotations:
- additionalProperties:
- type: string
- type: object
- finalizers:
- items:
- type: string
- type: array
- labels:
- additionalProperties:
- type: string
- type: object
- type: object
- templateFrom:
- items:
- description: |-
- TemplateFrom specifies a source for templates.
- Each item in the list can either reference a ConfigMap or a Secret resource.
- properties:
- configMap:
- description: TemplateRef specifies a reference to either
- a ConfigMap or a Secret resource.
- properties:
- items:
- description: A list of keys in the ConfigMap/Secret
- to use as templates for Secret data
- items:
- description: TemplateRefItem specifies a key in
- the ConfigMap/Secret to use as a template for
- Secret data.
- properties:
- key:
- description: A key in the ConfigMap/Secret
- maxLength: 253
- minLength: 1
- pattern: ^[-._a-zA-Z0-9]+$
- type: string
- templateAs:
- default: Values
- description: TemplateScope specifies how the
- template keys should be interpreted.
- enum:
- - Values
- - KeysAndValues
- type: string
- required:
- - key
- type: object
- type: array
- name:
- description: The name of the ConfigMap/Secret resource
- maxLength: 253
- minLength: 1
- pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
- type: string
- required:
- - items
- - name
- type: object
- literal:
- type: string
- secret:
- description: TemplateRef specifies a reference to either
- a ConfigMap or a Secret resource.
- properties:
- items:
- description: A list of keys in the ConfigMap/Secret
- to use as templates for Secret data
- items:
- description: TemplateRefItem specifies a key in
- the ConfigMap/Secret to use as a template for
- Secret data.
- properties:
- key:
- description: A key in the ConfigMap/Secret
- maxLength: 253
- minLength: 1
- pattern: ^[-._a-zA-Z0-9]+$
- type: string
- templateAs:
- default: Values
- description: TemplateScope specifies how the
- template keys should be interpreted.
- enum:
- - Values
- - KeysAndValues
- type: string
- required:
- - key
- type: object
- type: array
- name:
- description: The name of the ConfigMap/Secret resource
- maxLength: 253
- minLength: 1
- pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
- type: string
- required:
- - items
- - name
- type: object
- target:
- default: Data
- description: |-
- Target specifies where to place the template result.
- For Secret resources the accepted values are empty, "Data", "Annotations" and "Labels";
- any other value is rejected because it would allow writes to privileged Secret fields.
- For custom resources (when spec.target.manifest is set), this supports
- nested paths like "spec.database.config" or "data".
- type: string
- valuesDecodingStrategy:
- description: |-
- Used to define a decoding Strategy for the rendered template values.
- Defaults to None when omitted.
- enum:
- - Auto
- - Base64
- - Base64URL
- - None
- type: string
- type: object
- type: array
- type:
- type: string
- type: object
- type: object
- type: object
- status:
- description: ExternalSecretStatus defines the observed state of ExternalSecret.
- properties:
- binding:
- description: Binding represents a servicebinding.io Provisioned Service
- reference to the secret
- properties:
- name:
- default: ""
- description: |-
- 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
- type: string
- type: object
- x-kubernetes-map-type: atomic
- conditions:
- items:
- description: ExternalSecretStatusCondition defines a status condition
- of an ExternalSecret resource.
- properties:
- lastTransitionTime:
- format: date-time
- type: string
- message:
- type: string
- reason:
- type: string
- status:
- type: string
- type:
- description: ExternalSecretConditionType defines a value type
- for ExternalSecret conditions.
- enum:
- - Ready
- - Deleted
- type: string
- required:
- - status
- - type
- type: object
- type: array
- refreshTime:
- description: |-
- refreshTime is the time and date the external secret was fetched and
- the target secret updated
- format: date-time
- nullable: true
- type: string
- syncedResourceVersion:
- description: SyncedResourceVersion keeps track of the last synced
- version
- type: string
- type: object
- type: object
- selectableFields:
- - jsonPath: .spec.secretStoreRef.name
- - jsonPath: .spec.secretStoreRef.kind
- - jsonPath: .spec.target.name
- - jsonPath: .spec.refreshInterval
- served: true
- storage: true
- subresources:
- status: {}
- - additionalPrinterColumns:
- - jsonPath: .spec.secretStoreRef.kind
- name: StoreType
- type: string
- - jsonPath: .spec.secretStoreRef.name
- name: Store
- type: string
- - jsonPath: .spec.refreshInterval
- name: Refresh Interval
- type: string
- - jsonPath: .status.conditions[?(@.type=="Ready")].reason
- name: Status
- type: string
- - jsonPath: .status.conditions[?(@.type=="Ready")].status
- name: Ready
- type: string
- - jsonPath: .status.refreshTime
- name: Last Sync
- type: date
- deprecated: true
- name: v1beta1
- schema:
- openAPIV3Schema:
- description: ExternalSecret is the schema for the external-secrets API.
- properties:
- apiVersion:
- description: |-
- 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
- type: string
- kind:
- description: |-
- 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
- type: string
- metadata:
- type: object
- spec:
- description: ExternalSecretSpec defines the desired state of ExternalSecret.
- properties:
- data:
- description: Data defines the connection between the Kubernetes Secret
- keys and the Provider data
- items:
- description: ExternalSecretData defines the connection between the
- Kubernetes Secret key (spec.data.<key>) and the Provider data.
- properties:
- remoteRef:
- description: |-
- RemoteRef points to the remote secret and defines
- which secret (version/property/..) to fetch.
- properties:
- conversionStrategy:
- default: Default
- description: Used to define a conversion Strategy
- enum:
- - Default
- - Unicode
- type: string
- decodingStrategy:
- default: None
- description: Used to define a decoding Strategy
- enum:
- - Auto
- - Base64
- - Base64URL
- - None
- type: string
- key:
- description: Key is the key used in the Provider, mandatory
- type: string
- metadataPolicy:
- default: None
- description: Policy for fetching tags/labels from provider
- secrets, possible options are Fetch, None. Defaults to
- None
- enum:
- - None
- - Fetch
- type: string
- property:
- description: Used to select a specific property of the Provider
- value (if a map), if supported
- type: string
- version:
- description: Used to select a specific version of the Provider
- value, if supported
- type: string
- required:
- - key
- type: object
- secretKey:
- description: The key in the Kubernetes Secret to store the value.
- maxLength: 253
- minLength: 1
- pattern: ^[-._a-zA-Z0-9]+$
- type: string
- sourceRef:
- description: |-
- SourceRef allows you to override the source
- from which the value will be pulled.
- maxProperties: 1
- minProperties: 1
- properties:
- generatorRef:
- description: |-
- GeneratorRef points to a generator custom resource.
- Deprecated: The generatorRef is not implemented in .data[].
- this will be removed with v1.
- properties:
- apiVersion:
- default: generators.external-secrets.io/v1alpha1
- description: Specify the apiVersion of the generator
- resource
- type: string
- kind:
- description: Specify the Kind of the generator resource
- enum:
- - ACRAccessToken
- - ClusterGenerator
- - ECRAuthorizationToken
- - Fake
- - GCRAccessToken
- - GithubAccessToken
- - QuayAccessToken
- - Password
- - SSHKey
- - STSSessionToken
- - UUID
- - VaultDynamicSecret
- - Webhook
- - Grafana
- type: string
- name:
- description: Specify the name of the generator resource
- maxLength: 253
- minLength: 1
- pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
- type: string
- required:
- - kind
- - name
- type: object
- storeRef:
- description: SecretStoreRef defines which SecretStore to
- fetch the ExternalSecret data.
- properties:
- kind:
- description: |-
- Kind of the SecretStore resource (SecretStore or ClusterSecretStore)
- Defaults to `SecretStore`
- enum:
- - SecretStore
- - ClusterSecretStore
- type: string
- name:
- description: Name of the SecretStore resource
- maxLength: 253
- minLength: 1
- pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
- type: string
- type: object
- type: object
- required:
- - remoteRef
- - secretKey
- type: object
- type: array
- dataFrom:
- description: |-
- 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
- items:
- description: ExternalSecretDataFromRemoteRef defines a reference
- to multiple secrets in the provider to be fetched using options.
- properties:
- extract:
- description: |-
- Used to extract multiple key/value pairs from one secret
- Note: Extract does not support sourceRef.Generator or sourceRef.GeneratorRef.
- properties:
- conversionStrategy:
- default: Default
- description: Used to define a conversion Strategy
- enum:
- - Default
- - Unicode
- type: string
- decodingStrategy:
- default: None
- description: Used to define a decoding Strategy
- enum:
- - Auto
- - Base64
- - Base64URL
- - None
- type: string
- key:
- description: Key is the key used in the Provider, mandatory
- type: string
- metadataPolicy:
- default: None
- description: Policy for fetching tags/labels from provider
- secrets, possible options are Fetch, None. Defaults to
- None
- enum:
- - None
- - Fetch
- type: string
- property:
- description: Used to select a specific property of the Provider
- value (if a map), if supported
- type: string
- version:
- description: Used to select a specific version of the Provider
- value, if supported
- type: string
- required:
- - key
- type: object
- find:
- description: |-
- Used to find secrets based on tags or regular expressions
- Note: Find does not support sourceRef.Generator or sourceRef.GeneratorRef.
- properties:
- conversionStrategy:
- default: Default
- description: Used to define a conversion Strategy
- enum:
- - Default
- - Unicode
- type: string
- decodingStrategy:
- default: None
- description: Used to define a decoding Strategy
- enum:
- - Auto
- - Base64
- - Base64URL
- - None
- type: string
- name:
- description: Finds secrets based on the name.
- properties:
- regexp:
- description: Finds secrets base
- type: string
- type: object
- path:
- description: A root path to start the find operations.
- type: string
- tags:
- additionalProperties:
- type: string
- description: Find secrets based on tags.
- type: object
- type: object
- rewrite:
- description: |-
- 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)
- items:
- description: ExternalSecretRewrite defines rules on how to
- rewrite secret keys.
- maxProperties: 1
- minProperties: 1
- properties:
- regexp:
- description: |-
- Used to rewrite with regular expressions.
- The resulting key will be the output of a regexp.ReplaceAll operation.
- properties:
- source:
- description: Used to define the regular expression
- of a re.Compiler.
- type: string
- target:
- description: Used to define the target pattern of
- a ReplaceAll operation.
- type: string
- required:
- - source
- - target
- type: object
- transform:
- description: |-
- Used to apply string transformation on the secrets.
- The resulting key will be the output of the template applied by the operation.
- properties:
- template:
- description: |-
- Used to define the template to apply on the secret name.
- `.value ` will specify the secret name in the template.
- type: string
- required:
- - template
- type: object
- type: object
- type: array
- sourceRef:
- description: |-
- 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
- maxProperties: 1
- minProperties: 1
- properties:
- generatorRef:
- description: GeneratorRef points to a generator custom resource.
- properties:
- apiVersion:
- default: generators.external-secrets.io/v1alpha1
- description: Specify the apiVersion of the generator
- resource
- type: string
- kind:
- description: Specify the Kind of the generator resource
- enum:
- - ACRAccessToken
- - ClusterGenerator
- - ECRAuthorizationToken
- - Fake
- - GCRAccessToken
- - GithubAccessToken
- - QuayAccessToken
- - Password
- - SSHKey
- - STSSessionToken
- - UUID
- - VaultDynamicSecret
- - Webhook
- - Grafana
- type: string
- name:
- description: Specify the name of the generator resource
- maxLength: 253
- minLength: 1
- pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
- type: string
- required:
- - kind
- - name
- type: object
- storeRef:
- description: SecretStoreRef defines which SecretStore to
- fetch the ExternalSecret data.
- properties:
- kind:
- description: |-
- Kind of the SecretStore resource (SecretStore or ClusterSecretStore)
- Defaults to `SecretStore`
- enum:
- - SecretStore
- - ClusterSecretStore
- type: string
- name:
- description: Name of the SecretStore resource
- maxLength: 253
- minLength: 1
- pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
- type: string
- type: object
- type: object
- type: object
- type: array
- refreshInterval:
- default: 1h0m0s
- description: |-
- 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.
- type: string
- refreshPolicy:
- description: |-
- 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
- enum:
- - CreatedOnce
- - Periodic
- - OnChange
- type: string
- secretStoreRef:
- description: SecretStoreRef defines which SecretStore to fetch the
- ExternalSecret data.
- properties:
- kind:
- description: |-
- Kind of the SecretStore resource (SecretStore or ClusterSecretStore)
- Defaults to `SecretStore`
- enum:
- - SecretStore
- - ClusterSecretStore
- type: string
- name:
- description: Name of the SecretStore resource
- maxLength: 253
- minLength: 1
- pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
- type: string
- type: object
- target:
- default:
- creationPolicy: Owner
- deletionPolicy: Retain
- description: |-
- ExternalSecretTarget defines the Kubernetes Secret to be created
- There can be only one target per ExternalSecret.
- properties:
- creationPolicy:
- default: Owner
- description: |-
- CreationPolicy defines rules on how to create the resulting Secret.
- Defaults to "Owner"
- enum:
- - Owner
- - Orphan
- - Merge
- - None
- type: string
- deletionPolicy:
- default: Retain
- description: |-
- DeletionPolicy defines rules on how to delete the resulting Secret.
- Defaults to "Retain"
- enum:
- - Delete
- - Merge
- - Retain
- type: string
- immutable:
- description: Immutable defines if the final secret will be immutable
- type: boolean
- name:
- description: |-
- The name of the Secret resource to be managed.
- Defaults to the .metadata.name of the ExternalSecret resource
- maxLength: 253
- minLength: 1
- pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
- type: string
- template:
- description: Template defines a blueprint for the created Secret
- resource.
- properties:
- data:
- additionalProperties:
- type: string
- type: object
- engineVersion:
- default: v2
- description: |-
- EngineVersion specifies the template engine version
- that should be used to compile/execute the
- template specified in .data and .templateFrom[].
- enum:
- - v2
- type: string
- mergePolicy:
- default: Replace
- description: TemplateMergePolicy defines how template values
- should be merged when generating a secret.
- enum:
- - Replace
- - Merge
- type: string
- metadata:
- description: ExternalSecretTemplateMetadata defines metadata
- fields for the Secret blueprint.
- properties:
- annotations:
- additionalProperties:
- type: string
- type: object
- labels:
- additionalProperties:
- type: string
- type: object
- type: object
- templateFrom:
- items:
- description: TemplateFrom defines a source for template
- data.
- properties:
- configMap:
- description: TemplateRef defines a reference to a template
- source in a ConfigMap or Secret.
- properties:
- items:
- description: A list of keys in the ConfigMap/Secret
- to use as templates for Secret data
- items:
- description: TemplateRefItem defines which key
- in the referenced ConfigMap or Secret to use
- as a template.
- properties:
- key:
- description: A key in the ConfigMap/Secret
- maxLength: 253
- minLength: 1
- pattern: ^[-._a-zA-Z0-9]+$
- type: string
- templateAs:
- default: Values
- description: TemplateScope defines the scope
- of the template when processing template
- data.
- enum:
- - Values
- - KeysAndValues
- type: string
- required:
- - key
- type: object
- type: array
- name:
- description: The name of the ConfigMap/Secret resource
- maxLength: 253
- minLength: 1
- pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
- type: string
- required:
- - items
- - name
- type: object
- literal:
- type: string
- secret:
- description: TemplateRef defines a reference to a template
- source in a ConfigMap or Secret.
- properties:
- items:
- description: A list of keys in the ConfigMap/Secret
- to use as templates for Secret data
- items:
- description: TemplateRefItem defines which key
- in the referenced ConfigMap or Secret to use
- as a template.
- properties:
- key:
- description: A key in the ConfigMap/Secret
- maxLength: 253
- minLength: 1
- pattern: ^[-._a-zA-Z0-9]+$
- type: string
- templateAs:
- default: Values
- description: TemplateScope defines the scope
- of the template when processing template
- data.
- enum:
- - Values
- - KeysAndValues
- type: string
- required:
- - key
- type: object
- type: array
- name:
- description: The name of the ConfigMap/Secret resource
- maxLength: 253
- minLength: 1
- pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
- type: string
- required:
- - items
- - name
- type: object
- target:
- default: Data
- description: TemplateTarget defines the target field
- where the template result will be stored.
- enum:
- - Data
- - Annotations
- - Labels
- type: string
- type: object
- type: array
- type:
- type: string
- type: object
- type: object
- type: object
- status:
- description: ExternalSecretStatus defines the observed state of ExternalSecret.
- properties:
- binding:
- description: Binding represents a servicebinding.io Provisioned Service
- reference to the secret
- properties:
- name:
- default: ""
- description: |-
- 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
- type: string
- type: object
- x-kubernetes-map-type: atomic
- conditions:
- items:
- description: ExternalSecretStatusCondition contains condition information
- for an ExternalSecret.
- properties:
- lastTransitionTime:
- format: date-time
- type: string
- message:
- type: string
- reason:
- type: string
- status:
- type: string
- type:
- description: ExternalSecretConditionType defines the condition
- type for an ExternalSecret.
- type: string
- required:
- - status
- - type
- type: object
- type: array
- refreshTime:
- description: |-
- refreshTime is the time and date the external secret was fetched and
- the target secret updated
- format: date-time
- nullable: true
- type: string
- syncedResourceVersion:
- description: SyncedResourceVersion keeps track of the last synced
- version
- type: string
- type: object
- type: object
- served: false
- storage: false
- subresources:
- status: {}
|