generators.external-secrets.io_clustergenerators.yaml 141 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408
  1. apiVersion: apiextensions.k8s.io/v1
  2. kind: CustomResourceDefinition
  3. metadata:
  4. annotations:
  5. controller-gen.kubebuilder.io/version: v0.19.0
  6. labels:
  7. external-secrets.io/component: controller
  8. name: clustergenerators.generators.external-secrets.io
  9. spec:
  10. group: generators.external-secrets.io
  11. names:
  12. categories:
  13. - external-secrets
  14. - external-secrets-generators
  15. kind: ClusterGenerator
  16. listKind: ClusterGeneratorList
  17. plural: clustergenerators
  18. singular: clustergenerator
  19. scope: Cluster
  20. versions:
  21. - name: v1alpha1
  22. schema:
  23. openAPIV3Schema:
  24. description: ClusterGenerator represents a cluster-wide generator which can
  25. be referenced as part of `generatorRef` fields.
  26. properties:
  27. apiVersion:
  28. description: |-
  29. APIVersion defines the versioned schema of this representation of an object.
  30. Servers should convert recognized schemas to the latest internal value, and
  31. may reject unrecognized values.
  32. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
  33. type: string
  34. kind:
  35. description: |-
  36. Kind is a string value representing the REST resource this object represents.
  37. Servers may infer this from the endpoint the client submits requests to.
  38. Cannot be updated.
  39. In CamelCase.
  40. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
  41. type: string
  42. metadata:
  43. type: object
  44. spec:
  45. description: ClusterGeneratorSpec defines the desired state of a ClusterGenerator.
  46. properties:
  47. generator:
  48. description: Generator the spec for this generator, must match the
  49. kind.
  50. maxProperties: 1
  51. minProperties: 1
  52. properties:
  53. acrAccessTokenSpec:
  54. description: |-
  55. ACRAccessTokenSpec defines how to generate the access token
  56. e.g. how to authenticate and which registry to use.
  57. see: https://github.com/Azure/acr/blob/main/docs/AAD-OAuth.md#overview
  58. properties:
  59. auth:
  60. description: ACRAuth defines the authentication methods for
  61. Azure Container Registry.
  62. properties:
  63. managedIdentity:
  64. description: ManagedIdentity uses Azure Managed Identity
  65. to authenticate with Azure.
  66. properties:
  67. identityId:
  68. description: If multiple Managed Identity is assigned
  69. to the pod, you can select the one to be used
  70. type: string
  71. type: object
  72. servicePrincipal:
  73. description: ServicePrincipal uses Azure Service Principal
  74. credentials to authenticate with Azure.
  75. properties:
  76. secretRef:
  77. description: |-
  78. AzureACRServicePrincipalAuthSecretRef defines the secret references for Azure Service Principal authentication.
  79. It uses static credentials stored in a Kind=Secret.
  80. properties:
  81. clientId:
  82. description: The Azure clientId of the service
  83. principle used for authentication.
  84. properties:
  85. key:
  86. description: |-
  87. A key in the referenced Secret.
  88. Some instances of this field may be defaulted, in others it may be required.
  89. maxLength: 253
  90. minLength: 1
  91. pattern: ^[-._a-zA-Z0-9]+$
  92. type: string
  93. name:
  94. description: The name of the Secret resource
  95. being referred to.
  96. maxLength: 253
  97. minLength: 1
  98. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  99. type: string
  100. namespace:
  101. description: |-
  102. The namespace of the Secret resource being referred to.
  103. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
  104. maxLength: 63
  105. minLength: 1
  106. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  107. type: string
  108. type: object
  109. clientSecret:
  110. description: The Azure ClientSecret of the service
  111. principle used for authentication.
  112. properties:
  113. key:
  114. description: |-
  115. A key in the referenced Secret.
  116. Some instances of this field may be defaulted, in others it may be required.
  117. maxLength: 253
  118. minLength: 1
  119. pattern: ^[-._a-zA-Z0-9]+$
  120. type: string
  121. name:
  122. description: The name of the Secret resource
  123. being referred to.
  124. maxLength: 253
  125. minLength: 1
  126. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  127. type: string
  128. namespace:
  129. description: |-
  130. The namespace of the Secret resource being referred to.
  131. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
  132. maxLength: 63
  133. minLength: 1
  134. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  135. type: string
  136. type: object
  137. type: object
  138. required:
  139. - secretRef
  140. type: object
  141. workloadIdentity:
  142. description: WorkloadIdentity uses Azure Workload Identity
  143. to authenticate with Azure.
  144. properties:
  145. serviceAccountRef:
  146. description: |-
  147. ServiceAccountRef specified the service account
  148. that should be used when authenticating with WorkloadIdentity.
  149. properties:
  150. audiences:
  151. description: |-
  152. Audience specifies the `aud` claim for the service account token
  153. If the service account uses a well-known annotation for e.g. IRSA or GCP Workload Identity
  154. then this audiences will be appended to the list
  155. items:
  156. type: string
  157. type: array
  158. name:
  159. description: The name of the ServiceAccount resource
  160. being referred to.
  161. maxLength: 253
  162. minLength: 1
  163. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  164. type: string
  165. namespace:
  166. description: |-
  167. Namespace of the resource being referred to.
  168. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
  169. maxLength: 63
  170. minLength: 1
  171. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  172. type: string
  173. required:
  174. - name
  175. type: object
  176. type: object
  177. type: object
  178. environmentType:
  179. default: PublicCloud
  180. description: |-
  181. EnvironmentType specifies the Azure cloud environment endpoints to use for
  182. connecting and authenticating with Azure. By default, it points to the public cloud AAD endpoint.
  183. The following endpoints are available, also see here: https://github.com/Azure/go-autorest/blob/main/autorest/azure/environments.go#L152
  184. PublicCloud, USGovernmentCloud, ChinaCloud, GermanCloud
  185. enum:
  186. - PublicCloud
  187. - USGovernmentCloud
  188. - ChinaCloud
  189. - GermanCloud
  190. - AzureStackCloud
  191. type: string
  192. registry:
  193. description: |-
  194. the domain name of the ACR registry
  195. e.g. foobarexample.azurecr.io
  196. type: string
  197. scope:
  198. description: |-
  199. Define the scope for the access token, e.g. pull/push access for a repository.
  200. if not provided it will return a refresh token that has full scope.
  201. Note: you need to pin it down to the repository level, there is no wildcard available.
  202. examples:
  203. repository:my-repository:pull,push
  204. repository:my-repository:pull
  205. see docs for details: https://docs.docker.com/registry/spec/auth/scope/
  206. type: string
  207. tenantId:
  208. description: TenantID configures the Azure Tenant to send
  209. requests to. Required for ServicePrincipal auth type.
  210. type: string
  211. required:
  212. - auth
  213. - registry
  214. type: object
  215. cloudsmithAccessTokenSpec:
  216. description: CloudsmithAccessTokenSpec defines the configuration
  217. for generating a Cloudsmith access token using OIDC authentication.
  218. properties:
  219. apiUrl:
  220. description: APIURL configures the Cloudsmith API URL. Defaults
  221. to https://api.cloudsmith.io.
  222. type: string
  223. orgSlug:
  224. description: OrgSlug is the organization slug in Cloudsmith
  225. type: string
  226. serviceAccountRef:
  227. description: Name of the service account you are federating
  228. with
  229. properties:
  230. audiences:
  231. description: |-
  232. Audience specifies the `aud` claim for the service account token
  233. If the service account uses a well-known annotation for e.g. IRSA or GCP Workload Identity
  234. then this audiences will be appended to the list
  235. items:
  236. type: string
  237. type: array
  238. name:
  239. description: The name of the ServiceAccount resource being
  240. referred to.
  241. maxLength: 253
  242. minLength: 1
  243. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  244. type: string
  245. namespace:
  246. description: |-
  247. Namespace of the resource being referred to.
  248. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
  249. maxLength: 63
  250. minLength: 1
  251. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  252. type: string
  253. required:
  254. - name
  255. type: object
  256. serviceSlug:
  257. description: ServiceSlug is the service slug in Cloudsmith
  258. for OIDC authentication
  259. type: string
  260. required:
  261. - orgSlug
  262. - serviceAccountRef
  263. - serviceSlug
  264. type: object
  265. ecrAuthorizationTokenSpec:
  266. description: ECRAuthorizationTokenSpec defines the desired state
  267. to generate an AWS ECR authorization token.
  268. properties:
  269. auth:
  270. description: Auth defines how to authenticate with AWS
  271. properties:
  272. jwt:
  273. description: AWSJWTAuth provides configuration to authenticate
  274. against AWS using service account tokens.
  275. properties:
  276. serviceAccountRef:
  277. description: ServiceAccountSelector is a reference
  278. to a ServiceAccount resource.
  279. properties:
  280. audiences:
  281. description: |-
  282. Audience specifies the `aud` claim for the service account token
  283. If the service account uses a well-known annotation for e.g. IRSA or GCP Workload Identity
  284. then this audiences will be appended to the list
  285. items:
  286. type: string
  287. type: array
  288. name:
  289. description: The name of the ServiceAccount resource
  290. being referred to.
  291. maxLength: 253
  292. minLength: 1
  293. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  294. type: string
  295. namespace:
  296. description: |-
  297. Namespace of the resource being referred to.
  298. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
  299. maxLength: 63
  300. minLength: 1
  301. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  302. type: string
  303. required:
  304. - name
  305. type: object
  306. type: object
  307. secretRef:
  308. description: |-
  309. AWSAuthSecretRef holds secret references for AWS credentials
  310. both AccessKeyID and SecretAccessKey must be defined in order to properly authenticate.
  311. properties:
  312. accessKeyIDSecretRef:
  313. description: The AccessKeyID is used for authentication
  314. properties:
  315. key:
  316. description: |-
  317. A key in the referenced Secret.
  318. Some instances of this field may be defaulted, in others it may be required.
  319. maxLength: 253
  320. minLength: 1
  321. pattern: ^[-._a-zA-Z0-9]+$
  322. type: string
  323. name:
  324. description: The name of the Secret resource being
  325. referred to.
  326. maxLength: 253
  327. minLength: 1
  328. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  329. type: string
  330. namespace:
  331. description: |-
  332. The namespace of the Secret resource being referred to.
  333. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
  334. maxLength: 63
  335. minLength: 1
  336. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  337. type: string
  338. type: object
  339. secretAccessKeySecretRef:
  340. description: The SecretAccessKey is used for authentication
  341. properties:
  342. key:
  343. description: |-
  344. A key in the referenced Secret.
  345. Some instances of this field may be defaulted, in others it may be required.
  346. maxLength: 253
  347. minLength: 1
  348. pattern: ^[-._a-zA-Z0-9]+$
  349. type: string
  350. name:
  351. description: The name of the Secret resource being
  352. referred to.
  353. maxLength: 253
  354. minLength: 1
  355. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  356. type: string
  357. namespace:
  358. description: |-
  359. The namespace of the Secret resource being referred to.
  360. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
  361. maxLength: 63
  362. minLength: 1
  363. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  364. type: string
  365. type: object
  366. sessionTokenSecretRef:
  367. description: |-
  368. The SessionToken used for authentication
  369. This must be defined if AccessKeyID and SecretAccessKey are temporary credentials
  370. see: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_use-resources.html
  371. properties:
  372. key:
  373. description: |-
  374. A key in the referenced Secret.
  375. Some instances of this field may be defaulted, in others it may be required.
  376. maxLength: 253
  377. minLength: 1
  378. pattern: ^[-._a-zA-Z0-9]+$
  379. type: string
  380. name:
  381. description: The name of the Secret resource being
  382. referred to.
  383. maxLength: 253
  384. minLength: 1
  385. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  386. type: string
  387. namespace:
  388. description: |-
  389. The namespace of the Secret resource being referred to.
  390. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
  391. maxLength: 63
  392. minLength: 1
  393. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  394. type: string
  395. type: object
  396. type: object
  397. type: object
  398. region:
  399. description: Region specifies the region to operate in.
  400. type: string
  401. role:
  402. description: |-
  403. You can assume a role before making calls to the
  404. desired AWS service.
  405. type: string
  406. scope:
  407. description: |-
  408. Scope specifies the ECR service scope.
  409. Valid options are private and public.
  410. type: string
  411. required:
  412. - region
  413. type: object
  414. fakeSpec:
  415. description: FakeSpec contains the static data.
  416. properties:
  417. controller:
  418. description: |-
  419. Used to select the correct ESO controller (think: ingress.ingressClassName)
  420. The ESO controller is instantiated with a specific controller name and filters VDS based on this property
  421. type: string
  422. data:
  423. additionalProperties:
  424. type: string
  425. description: |-
  426. Data defines the static data returned
  427. by this generator.
  428. type: object
  429. type: object
  430. gcrAccessTokenSpec:
  431. description: GCRAccessTokenSpec defines the desired state to generate
  432. a Google Container Registry access token.
  433. properties:
  434. auth:
  435. description: Auth defines the means for authenticating with
  436. GCP
  437. properties:
  438. secretRef:
  439. description: GCPSMAuthSecretRef defines the reference
  440. to a secret containing Google Cloud Platform credentials.
  441. properties:
  442. secretAccessKeySecretRef:
  443. description: The SecretAccessKey is used for authentication
  444. properties:
  445. key:
  446. description: |-
  447. A key in the referenced Secret.
  448. Some instances of this field may be defaulted, in others it may be required.
  449. maxLength: 253
  450. minLength: 1
  451. pattern: ^[-._a-zA-Z0-9]+$
  452. type: string
  453. name:
  454. description: The name of the Secret resource being
  455. referred to.
  456. maxLength: 253
  457. minLength: 1
  458. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  459. type: string
  460. namespace:
  461. description: |-
  462. The namespace of the Secret resource being referred to.
  463. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
  464. maxLength: 63
  465. minLength: 1
  466. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  467. type: string
  468. type: object
  469. type: object
  470. workloadIdentity:
  471. description: GCPWorkloadIdentity defines the configuration
  472. for using GCP Workload Identity authentication.
  473. properties:
  474. clusterLocation:
  475. type: string
  476. clusterName:
  477. type: string
  478. clusterProjectID:
  479. type: string
  480. serviceAccountRef:
  481. description: ServiceAccountSelector is a reference
  482. to a ServiceAccount resource.
  483. properties:
  484. audiences:
  485. description: |-
  486. Audience specifies the `aud` claim for the service account token
  487. If the service account uses a well-known annotation for e.g. IRSA or GCP Workload Identity
  488. then this audiences will be appended to the list
  489. items:
  490. type: string
  491. type: array
  492. name:
  493. description: The name of the ServiceAccount resource
  494. being referred to.
  495. maxLength: 253
  496. minLength: 1
  497. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  498. type: string
  499. namespace:
  500. description: |-
  501. Namespace of the resource being referred to.
  502. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
  503. maxLength: 63
  504. minLength: 1
  505. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  506. type: string
  507. required:
  508. - name
  509. type: object
  510. required:
  511. - clusterLocation
  512. - clusterName
  513. - serviceAccountRef
  514. type: object
  515. workloadIdentityFederation:
  516. description: GCPWorkloadIdentityFederation holds the configurations
  517. required for generating federated access tokens.
  518. properties:
  519. audience:
  520. description: |-
  521. audience is the Secure Token Service (STS) audience which contains the resource name for the workload identity pool and the provider identifier in that pool.
  522. If specified, Audience found in the external account credential config will be overridden with the configured value.
  523. audience must be provided when serviceAccountRef or awsSecurityCredentials is configured.
  524. type: string
  525. awsSecurityCredentials:
  526. description: |-
  527. awsSecurityCredentials is for configuring AWS region and credentials to use for obtaining the access token,
  528. when using the AWS metadata server is not an option.
  529. properties:
  530. awsCredentialsSecretRef:
  531. description: |-
  532. awsCredentialsSecretRef is the reference to the secret which holds the AWS credentials.
  533. Secret should be created with below names for keys
  534. - aws_access_key_id: Access Key ID, which is the unique identifier for the AWS account or the IAM user.
  535. - aws_secret_access_key: Secret Access Key, which is used to authenticate requests made to AWS services.
  536. - aws_session_token: Session Token, is the short-lived token to authenticate requests made to AWS services.
  537. properties:
  538. name:
  539. description: name of the secret.
  540. maxLength: 253
  541. minLength: 1
  542. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  543. type: string
  544. namespace:
  545. description: namespace in which the secret
  546. exists. If empty, secret will looked up
  547. in local namespace.
  548. maxLength: 63
  549. minLength: 1
  550. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  551. type: string
  552. required:
  553. - name
  554. type: object
  555. region:
  556. description: region is for configuring the AWS
  557. region to be used.
  558. example: ap-south-1
  559. maxLength: 50
  560. minLength: 1
  561. pattern: ^[a-z0-9-]+$
  562. type: string
  563. required:
  564. - awsCredentialsSecretRef
  565. - region
  566. type: object
  567. credConfig:
  568. description: |-
  569. credConfig holds the configmap reference containing the GCP external account credential configuration in JSON format and the key name containing the json data.
  570. For using Kubernetes cluster as the identity provider, use serviceAccountRef instead. Operators mounted serviceaccount token cannot be used as the token source, instead
  571. serviceAccountRef must be used by providing operators service account details.
  572. properties:
  573. key:
  574. description: key name holding the external account
  575. credential config.
  576. maxLength: 253
  577. minLength: 1
  578. pattern: ^[-._a-zA-Z0-9]+$
  579. type: string
  580. name:
  581. description: name of the configmap.
  582. maxLength: 253
  583. minLength: 1
  584. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  585. type: string
  586. namespace:
  587. description: namespace in which the configmap
  588. exists. If empty, configmap will looked up in
  589. local namespace.
  590. maxLength: 63
  591. minLength: 1
  592. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  593. type: string
  594. required:
  595. - key
  596. - name
  597. type: object
  598. externalTokenEndpoint:
  599. description: |-
  600. externalTokenEndpoint is the endpoint explicitly set up to provide tokens, which will be matched against the
  601. credential_source.url in the provided credConfig. This field is merely to double-check the external token source
  602. URL is having the expected value.
  603. type: string
  604. gcpServiceAccountEmail:
  605. description: |-
  606. GCPServiceAccountEmail is the email of the Google Cloud service account to impersonate
  607. after Workload Identity Federation. Use this to grant access through the service account's
  608. IAM bindings (for example roles/secretmanager.secretAccessor). When set, it overrides
  609. service_account_impersonation_url in the external account JSON from credConfig;
  610. when serviceAccountRef is set, it also overrides the "iam.gke.io/gcp-service-account" annotation
  611. on that ServiceAccount.
  612. example: my-gsa@my-project.iam.gserviceaccount.com
  613. minLength: 1
  614. pattern: ^.*@.*\.iam\.gserviceaccount\.com$
  615. type: string
  616. serviceAccountRef:
  617. description: |-
  618. serviceAccountRef is the reference to the kubernetes ServiceAccount to be used for obtaining the tokens,
  619. when Kubernetes is configured as provider in workload identity pool.
  620. properties:
  621. audiences:
  622. description: |-
  623. Audience specifies the `aud` claim for the service account token
  624. If the service account uses a well-known annotation for e.g. IRSA or GCP Workload Identity
  625. then this audiences will be appended to the list
  626. items:
  627. type: string
  628. type: array
  629. name:
  630. description: The name of the ServiceAccount resource
  631. being referred to.
  632. maxLength: 253
  633. minLength: 1
  634. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  635. type: string
  636. namespace:
  637. description: |-
  638. Namespace of the resource being referred to.
  639. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
  640. maxLength: 63
  641. minLength: 1
  642. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  643. type: string
  644. required:
  645. - name
  646. type: object
  647. type: object
  648. type: object
  649. projectID:
  650. description: ProjectID defines which project to use to authenticate
  651. with
  652. type: string
  653. required:
  654. - auth
  655. - projectID
  656. type: object
  657. githubAccessTokenSpec:
  658. description: GithubAccessTokenSpec defines the desired state to
  659. generate a GitHub access token.
  660. properties:
  661. appID:
  662. type: string
  663. auth:
  664. description: Auth configures how ESO authenticates with a
  665. Github instance.
  666. properties:
  667. privateKey:
  668. description: GithubSecretRef references a secret containing
  669. GitHub credentials.
  670. properties:
  671. secretRef:
  672. description: |-
  673. SecretKeySelector is a reference to a specific 'key' within a Secret resource.
  674. In some instances, `key` is a required field.
  675. properties:
  676. key:
  677. description: |-
  678. A key in the referenced Secret.
  679. Some instances of this field may be defaulted, in others it may be required.
  680. maxLength: 253
  681. minLength: 1
  682. pattern: ^[-._a-zA-Z0-9]+$
  683. type: string
  684. name:
  685. description: The name of the Secret resource being
  686. referred to.
  687. maxLength: 253
  688. minLength: 1
  689. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  690. type: string
  691. namespace:
  692. description: |-
  693. The namespace of the Secret resource being referred to.
  694. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
  695. maxLength: 63
  696. minLength: 1
  697. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  698. type: string
  699. type: object
  700. required:
  701. - secretRef
  702. type: object
  703. required:
  704. - privateKey
  705. type: object
  706. installID:
  707. type: string
  708. permissions:
  709. additionalProperties:
  710. type: string
  711. description: Map of permissions the token will have. If omitted,
  712. defaults to all permissions the GitHub App has.
  713. type: object
  714. repositories:
  715. description: |-
  716. List of repositories the token will have access to. If omitted, defaults to all repositories the GitHub App
  717. is installed to.
  718. items:
  719. type: string
  720. type: array
  721. url:
  722. description: URL configures the GitHub instance URL. Defaults
  723. to https://github.com/.
  724. type: string
  725. required:
  726. - appID
  727. - auth
  728. - installID
  729. type: object
  730. grafanaSpec:
  731. description: GrafanaSpec controls the behavior of the grafana
  732. generator.
  733. properties:
  734. auth:
  735. description: |-
  736. Auth is the authentication configuration to authenticate
  737. against the Grafana instance.
  738. properties:
  739. basic:
  740. description: |-
  741. Basic auth credentials used to authenticate against the Grafana instance.
  742. Note: you need a token which has elevated permissions to create service accounts.
  743. See here for the documentation on basic roles offered by Grafana:
  744. https://grafana.com/docs/grafana/latest/administration/roles-and-permissions/access-control/rbac-fixed-basic-role-definitions/
  745. properties:
  746. password:
  747. description: A basic auth password used to authenticate
  748. against the Grafana instance.
  749. properties:
  750. key:
  751. description: The key where the token is found.
  752. maxLength: 253
  753. minLength: 1
  754. pattern: ^[-._a-zA-Z0-9]+$
  755. type: string
  756. name:
  757. description: The name of the Secret resource being
  758. referred to.
  759. maxLength: 253
  760. minLength: 1
  761. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  762. type: string
  763. type: object
  764. username:
  765. description: A basic auth username used to authenticate
  766. against the Grafana instance.
  767. type: string
  768. required:
  769. - password
  770. - username
  771. type: object
  772. token:
  773. description: |-
  774. A service account token used to authenticate against the Grafana instance.
  775. Note: you need a token which has elevated permissions to create service accounts.
  776. See here for the documentation on basic roles offered by Grafana:
  777. https://grafana.com/docs/grafana/latest/administration/roles-and-permissions/access-control/rbac-fixed-basic-role-definitions/
  778. properties:
  779. key:
  780. description: The key where the token is found.
  781. maxLength: 253
  782. minLength: 1
  783. pattern: ^[-._a-zA-Z0-9]+$
  784. type: string
  785. name:
  786. description: The name of the Secret resource being
  787. referred to.
  788. maxLength: 253
  789. minLength: 1
  790. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  791. type: string
  792. type: object
  793. type: object
  794. serviceAccount:
  795. description: |-
  796. ServiceAccount is the configuration for the service account that
  797. is supposed to be generated by the generator.
  798. properties:
  799. name:
  800. description: Name is the name of the service account that
  801. will be created by ESO.
  802. type: string
  803. role:
  804. description: |-
  805. Role is the role of the service account.
  806. See here for the documentation on basic roles offered by Grafana:
  807. https://grafana.com/docs/grafana/latest/administration/roles-and-permissions/access-control/rbac-fixed-basic-role-definitions/
  808. type: string
  809. required:
  810. - name
  811. - role
  812. type: object
  813. url:
  814. description: URL is the URL of the Grafana instance.
  815. type: string
  816. required:
  817. - auth
  818. - serviceAccount
  819. - url
  820. type: object
  821. mfaSpec:
  822. description: MFASpec controls the behavior of the mfa generator.
  823. properties:
  824. algorithm:
  825. description: Algorithm to use for encoding. Defaults to SHA1
  826. as per the RFC.
  827. type: string
  828. length:
  829. description: Length defines the token length. Defaults to
  830. 6 characters.
  831. type: integer
  832. secret:
  833. description: Secret is a secret selector to a secret containing
  834. the seed secret to generate the TOTP value from.
  835. properties:
  836. key:
  837. description: |-
  838. A key in the referenced Secret.
  839. Some instances of this field may be defaulted, in others it may be required.
  840. maxLength: 253
  841. minLength: 1
  842. pattern: ^[-._a-zA-Z0-9]+$
  843. type: string
  844. name:
  845. description: The name of the Secret resource being referred
  846. to.
  847. maxLength: 253
  848. minLength: 1
  849. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  850. type: string
  851. namespace:
  852. description: |-
  853. The namespace of the Secret resource being referred to.
  854. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
  855. maxLength: 63
  856. minLength: 1
  857. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  858. type: string
  859. type: object
  860. timePeriod:
  861. description: TimePeriod defines how long the token can be
  862. active. Defaults to 30 seconds.
  863. type: integer
  864. when:
  865. description: When defines a time parameter that can be used
  866. to pin the origin time of the generated token.
  867. format: date-time
  868. type: string
  869. required:
  870. - secret
  871. type: object
  872. passwordSpec:
  873. description: PasswordSpec controls the behavior of the password
  874. generator.
  875. properties:
  876. allowRepeat:
  877. default: false
  878. description: set AllowRepeat to true to allow repeating characters.
  879. type: boolean
  880. digits:
  881. description: |-
  882. Digits specifies the number of digits in the generated
  883. password. If omitted it defaults to 25% of the length of the password
  884. type: integer
  885. encoding:
  886. default: raw
  887. description: |-
  888. Encoding specifies the encoding of the generated password.
  889. Valid values are:
  890. - "raw" (default): no encoding
  891. - "base64": standard base64 encoding
  892. - "base64url": base64url encoding
  893. - "base32": base32 encoding
  894. - "hex": hexadecimal encoding
  895. enum:
  896. - base64
  897. - base64url
  898. - base32
  899. - hex
  900. - raw
  901. type: string
  902. length:
  903. default: 24
  904. description: |-
  905. Length of the password to be generated.
  906. Defaults to 24
  907. type: integer
  908. noUpper:
  909. default: false
  910. description: Set NoUpper to disable uppercase characters
  911. type: boolean
  912. secretKeys:
  913. description: |-
  914. SecretKeys defines the keys that will be populated with generated passwords.
  915. Defaults to "password" when not set.
  916. items:
  917. type: string
  918. minItems: 1
  919. type: array
  920. symbolCharacters:
  921. description: |-
  922. SymbolCharacters specifies the special characters that should be used
  923. in the generated password.
  924. type: string
  925. symbols:
  926. description: |-
  927. Symbols specifies the number of symbol characters in the generated
  928. password. If omitted it defaults to 25% of the length of the password
  929. type: integer
  930. required:
  931. - allowRepeat
  932. - length
  933. - noUpper
  934. type: object
  935. quayAccessTokenSpec:
  936. description: QuayAccessTokenSpec defines the desired state to
  937. generate a Quay access token.
  938. properties:
  939. robotAccount:
  940. description: Name of the robot account you are federating
  941. with
  942. type: string
  943. serviceAccountRef:
  944. description: Name of the service account you are federating
  945. with
  946. properties:
  947. audiences:
  948. description: |-
  949. Audience specifies the `aud` claim for the service account token
  950. If the service account uses a well-known annotation for e.g. IRSA or GCP Workload Identity
  951. then this audiences will be appended to the list
  952. items:
  953. type: string
  954. type: array
  955. name:
  956. description: The name of the ServiceAccount resource being
  957. referred to.
  958. maxLength: 253
  959. minLength: 1
  960. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  961. type: string
  962. namespace:
  963. description: |-
  964. Namespace of the resource being referred to.
  965. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
  966. maxLength: 63
  967. minLength: 1
  968. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  969. type: string
  970. required:
  971. - name
  972. type: object
  973. url:
  974. description: URL configures the Quay instance URL. Defaults
  975. to quay.io.
  976. type: string
  977. required:
  978. - robotAccount
  979. - serviceAccountRef
  980. type: object
  981. sshKeySpec:
  982. description: SSHKeySpec controls the behavior of the ssh key generator.
  983. properties:
  984. comment:
  985. description: Comment specifies an optional comment for the
  986. SSH key
  987. type: string
  988. keySize:
  989. description: |-
  990. KeySize specifies the key size for RSA keys (default: 2048) and ECDSA keys (default: 256).
  991. For RSA keys: 2048, 3072, 4096
  992. For ECDSA keys: 256, 384, 521
  993. Ignored for ed25519 keys
  994. maximum: 8192
  995. minimum: 256
  996. type: integer
  997. keyType:
  998. default: rsa
  999. description: KeyType specifies the SSH key type (rsa, ecdsa,
  1000. ed25519)
  1001. enum:
  1002. - rsa
  1003. - ecdsa
  1004. - ed25519
  1005. type: string
  1006. type: object
  1007. stsSessionTokenSpec:
  1008. description: STSSessionTokenSpec defines the desired state to
  1009. generate an AWS STS session token.
  1010. properties:
  1011. auth:
  1012. description: Auth defines how to authenticate with AWS
  1013. properties:
  1014. jwt:
  1015. description: AWSJWTAuth provides configuration to authenticate
  1016. against AWS using service account tokens.
  1017. properties:
  1018. serviceAccountRef:
  1019. description: ServiceAccountSelector is a reference
  1020. to a ServiceAccount resource.
  1021. properties:
  1022. audiences:
  1023. description: |-
  1024. Audience specifies the `aud` claim for the service account token
  1025. If the service account uses a well-known annotation for e.g. IRSA or GCP Workload Identity
  1026. then this audiences will be appended to the list
  1027. items:
  1028. type: string
  1029. type: array
  1030. name:
  1031. description: The name of the ServiceAccount resource
  1032. being referred to.
  1033. maxLength: 253
  1034. minLength: 1
  1035. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  1036. type: string
  1037. namespace:
  1038. description: |-
  1039. Namespace of the resource being referred to.
  1040. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
  1041. maxLength: 63
  1042. minLength: 1
  1043. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  1044. type: string
  1045. required:
  1046. - name
  1047. type: object
  1048. type: object
  1049. secretRef:
  1050. description: |-
  1051. AWSAuthSecretRef holds secret references for AWS credentials
  1052. both AccessKeyID and SecretAccessKey must be defined in order to properly authenticate.
  1053. properties:
  1054. accessKeyIDSecretRef:
  1055. description: The AccessKeyID is used for authentication
  1056. properties:
  1057. key:
  1058. description: |-
  1059. A key in the referenced Secret.
  1060. Some instances of this field may be defaulted, in others it may be required.
  1061. maxLength: 253
  1062. minLength: 1
  1063. pattern: ^[-._a-zA-Z0-9]+$
  1064. type: string
  1065. name:
  1066. description: The name of the Secret resource being
  1067. referred to.
  1068. maxLength: 253
  1069. minLength: 1
  1070. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  1071. type: string
  1072. namespace:
  1073. description: |-
  1074. The namespace of the Secret resource being referred to.
  1075. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
  1076. maxLength: 63
  1077. minLength: 1
  1078. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  1079. type: string
  1080. type: object
  1081. secretAccessKeySecretRef:
  1082. description: The SecretAccessKey is used for authentication
  1083. properties:
  1084. key:
  1085. description: |-
  1086. A key in the referenced Secret.
  1087. Some instances of this field may be defaulted, in others it may be required.
  1088. maxLength: 253
  1089. minLength: 1
  1090. pattern: ^[-._a-zA-Z0-9]+$
  1091. type: string
  1092. name:
  1093. description: The name of the Secret resource being
  1094. referred to.
  1095. maxLength: 253
  1096. minLength: 1
  1097. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  1098. type: string
  1099. namespace:
  1100. description: |-
  1101. The namespace of the Secret resource being referred to.
  1102. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
  1103. maxLength: 63
  1104. minLength: 1
  1105. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  1106. type: string
  1107. type: object
  1108. sessionTokenSecretRef:
  1109. description: |-
  1110. The SessionToken used for authentication
  1111. This must be defined if AccessKeyID and SecretAccessKey are temporary credentials
  1112. see: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_use-resources.html
  1113. properties:
  1114. key:
  1115. description: |-
  1116. A key in the referenced Secret.
  1117. Some instances of this field may be defaulted, in others it may be required.
  1118. maxLength: 253
  1119. minLength: 1
  1120. pattern: ^[-._a-zA-Z0-9]+$
  1121. type: string
  1122. name:
  1123. description: The name of the Secret resource being
  1124. referred to.
  1125. maxLength: 253
  1126. minLength: 1
  1127. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  1128. type: string
  1129. namespace:
  1130. description: |-
  1131. The namespace of the Secret resource being referred to.
  1132. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
  1133. maxLength: 63
  1134. minLength: 1
  1135. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  1136. type: string
  1137. type: object
  1138. type: object
  1139. type: object
  1140. region:
  1141. description: Region specifies the region to operate in.
  1142. type: string
  1143. requestParameters:
  1144. description: RequestParameters contains parameters that can
  1145. be passed to the STS service.
  1146. properties:
  1147. serialNumber:
  1148. description: |-
  1149. SerialNumber is the identification number of the MFA device that is associated with the IAM user who is making
  1150. the GetSessionToken call.
  1151. Possible values: hardware device (such as GAHT12345678) or an Amazon Resource Name (ARN) for a virtual device
  1152. (such as arn:aws:iam::123456789012:mfa/user)
  1153. type: string
  1154. sessionDuration:
  1155. format: int32
  1156. type: integer
  1157. tokenCode:
  1158. description: TokenCode is the value provided by the MFA
  1159. device, if MFA is required.
  1160. type: string
  1161. type: object
  1162. role:
  1163. description: |-
  1164. You can assume a role before making calls to the
  1165. desired AWS service.
  1166. type: string
  1167. required:
  1168. - region
  1169. type: object
  1170. uuidSpec:
  1171. description: UUIDSpec controls the behavior of the uuid generator.
  1172. type: object
  1173. vaultDynamicSecretSpec:
  1174. description: VaultDynamicSecretSpec defines the desired spec of
  1175. VaultDynamicSecret.
  1176. properties:
  1177. allowEmptyResponse:
  1178. default: false
  1179. description: Do not fail if no secrets are found. Useful for
  1180. requests where no data is expected.
  1181. type: boolean
  1182. controller:
  1183. description: |-
  1184. Used to select the correct ESO controller (think: ingress.ingressClassName)
  1185. The ESO controller is instantiated with a specific controller name and filters VDS based on this property
  1186. type: string
  1187. getParameters:
  1188. additionalProperties:
  1189. items:
  1190. type: string
  1191. type: array
  1192. description: |-
  1193. GetParameters are query-string parameters passed to Vault on GET calls.
  1194. Each key may map to multiple values, matching HTTP query-string semantics.
  1195. Ignored for non-GET methods; use Parameters for write bodies.
  1196. type: object
  1197. method:
  1198. description: Vault API method to use (GET/POST/other)
  1199. type: string
  1200. parameters:
  1201. description: Parameters to pass to Vault write (for non-GET
  1202. methods)
  1203. x-kubernetes-preserve-unknown-fields: true
  1204. path:
  1205. description: Vault path to obtain the dynamic secret from
  1206. type: string
  1207. provider:
  1208. description: Vault provider common spec
  1209. properties:
  1210. auth:
  1211. description: Auth configures how secret-manager authenticates
  1212. with the Vault server.
  1213. properties:
  1214. appRole:
  1215. description: |-
  1216. AppRole authenticates with Vault using the App Role auth mechanism,
  1217. with the role and secret stored in a Kubernetes Secret resource.
  1218. properties:
  1219. path:
  1220. default: approle
  1221. description: |-
  1222. Path where the App Role authentication backend is mounted
  1223. in Vault, e.g: "approle"
  1224. type: string
  1225. roleId:
  1226. description: |-
  1227. RoleID configured in the App Role authentication backend when setting
  1228. up the authentication backend in Vault.
  1229. type: string
  1230. roleRef:
  1231. description: |-
  1232. Reference to a key in a Secret that contains the App Role ID used
  1233. to authenticate with Vault.
  1234. The `key` field must be specified and denotes which entry within the Secret
  1235. resource is used as the app role id.
  1236. properties:
  1237. key:
  1238. description: |-
  1239. A key in the referenced Secret.
  1240. Some instances of this field may be defaulted, in others it may be required.
  1241. maxLength: 253
  1242. minLength: 1
  1243. pattern: ^[-._a-zA-Z0-9]+$
  1244. type: string
  1245. name:
  1246. description: The name of the Secret resource
  1247. being referred to.
  1248. maxLength: 253
  1249. minLength: 1
  1250. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  1251. type: string
  1252. namespace:
  1253. description: |-
  1254. The namespace of the Secret resource being referred to.
  1255. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
  1256. maxLength: 63
  1257. minLength: 1
  1258. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  1259. type: string
  1260. type: object
  1261. secretRef:
  1262. description: |-
  1263. Reference to a key in a Secret that contains the App Role secret used
  1264. to authenticate with Vault.
  1265. The `key` field must be specified and denotes which entry within the Secret
  1266. resource is used as the app role secret.
  1267. properties:
  1268. key:
  1269. description: |-
  1270. A key in the referenced Secret.
  1271. Some instances of this field may be defaulted, in others it may be required.
  1272. maxLength: 253
  1273. minLength: 1
  1274. pattern: ^[-._a-zA-Z0-9]+$
  1275. type: string
  1276. name:
  1277. description: The name of the Secret resource
  1278. being referred to.
  1279. maxLength: 253
  1280. minLength: 1
  1281. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  1282. type: string
  1283. namespace:
  1284. description: |-
  1285. The namespace of the Secret resource being referred to.
  1286. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
  1287. maxLength: 63
  1288. minLength: 1
  1289. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  1290. type: string
  1291. type: object
  1292. required:
  1293. - path
  1294. - secretRef
  1295. type: object
  1296. cert:
  1297. description: |-
  1298. Cert authenticates with TLS Certificates by passing client certificate, private key and ca certificate
  1299. Cert authentication method
  1300. properties:
  1301. clientCert:
  1302. description: |-
  1303. ClientCert is a certificate to authenticate using the Cert Vault
  1304. authentication method
  1305. properties:
  1306. key:
  1307. description: |-
  1308. A key in the referenced Secret.
  1309. Some instances of this field may be defaulted, in others it may be required.
  1310. maxLength: 253
  1311. minLength: 1
  1312. pattern: ^[-._a-zA-Z0-9]+$
  1313. type: string
  1314. name:
  1315. description: The name of the Secret resource
  1316. being referred to.
  1317. maxLength: 253
  1318. minLength: 1
  1319. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  1320. type: string
  1321. namespace:
  1322. description: |-
  1323. The namespace of the Secret resource being referred to.
  1324. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
  1325. maxLength: 63
  1326. minLength: 1
  1327. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  1328. type: string
  1329. type: object
  1330. path:
  1331. default: cert
  1332. description: |-
  1333. Path where the Certificate authentication backend is mounted
  1334. in Vault, e.g: "cert"
  1335. type: string
  1336. secretRef:
  1337. description: |-
  1338. SecretRef to a key in a Secret resource containing client private key to
  1339. authenticate with Vault using the Cert authentication method
  1340. properties:
  1341. key:
  1342. description: |-
  1343. A key in the referenced Secret.
  1344. Some instances of this field may be defaulted, in others it may be required.
  1345. maxLength: 253
  1346. minLength: 1
  1347. pattern: ^[-._a-zA-Z0-9]+$
  1348. type: string
  1349. name:
  1350. description: The name of the Secret resource
  1351. being referred to.
  1352. maxLength: 253
  1353. minLength: 1
  1354. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  1355. type: string
  1356. namespace:
  1357. description: |-
  1358. The namespace of the Secret resource being referred to.
  1359. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
  1360. maxLength: 63
  1361. minLength: 1
  1362. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  1363. type: string
  1364. type: object
  1365. vaultRole:
  1366. description: VaultRole specifies the Vault role
  1367. to use for TLS certificate authentication.
  1368. type: string
  1369. type: object
  1370. gcp:
  1371. description: |-
  1372. Gcp authenticates with Vault using Google Cloud Platform authentication method
  1373. GCP authentication method
  1374. properties:
  1375. location:
  1376. description: Location optionally defines a location/region
  1377. for the secret
  1378. type: string
  1379. path:
  1380. default: gcp
  1381. description: 'Path where the GCP auth method is
  1382. enabled in Vault, e.g: "gcp"'
  1383. type: string
  1384. projectID:
  1385. description: Project ID of the Google Cloud Platform
  1386. project
  1387. type: string
  1388. role:
  1389. description: Vault Role. In Vault, a role describes
  1390. an identity with a set of permissions, groups,
  1391. or policies you want to attach to a user of
  1392. the secrets engine.
  1393. type: string
  1394. secretRef:
  1395. description: Specify credentials in a Secret object
  1396. properties:
  1397. secretAccessKeySecretRef:
  1398. description: The SecretAccessKey is used for
  1399. authentication
  1400. properties:
  1401. key:
  1402. description: |-
  1403. A key in the referenced Secret.
  1404. Some instances of this field may be defaulted, in others it may be required.
  1405. maxLength: 253
  1406. minLength: 1
  1407. pattern: ^[-._a-zA-Z0-9]+$
  1408. type: string
  1409. name:
  1410. description: The name of the Secret resource
  1411. being referred to.
  1412. maxLength: 253
  1413. minLength: 1
  1414. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  1415. type: string
  1416. namespace:
  1417. description: |-
  1418. The namespace of the Secret resource being referred to.
  1419. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
  1420. maxLength: 63
  1421. minLength: 1
  1422. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  1423. type: string
  1424. type: object
  1425. type: object
  1426. serviceAccountRef:
  1427. description: ServiceAccountRef to a service account
  1428. for impersonation
  1429. properties:
  1430. audiences:
  1431. description: |-
  1432. Audience specifies the `aud` claim for the service account token
  1433. If the service account uses a well-known annotation for e.g. IRSA or GCP Workload Identity
  1434. then this audiences will be appended to the list
  1435. items:
  1436. type: string
  1437. type: array
  1438. name:
  1439. description: The name of the ServiceAccount
  1440. resource being referred to.
  1441. maxLength: 253
  1442. minLength: 1
  1443. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  1444. type: string
  1445. namespace:
  1446. description: |-
  1447. Namespace of the resource being referred to.
  1448. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
  1449. maxLength: 63
  1450. minLength: 1
  1451. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  1452. type: string
  1453. required:
  1454. - name
  1455. type: object
  1456. workloadIdentity:
  1457. description: Specify a service account with Workload
  1458. Identity
  1459. properties:
  1460. clusterLocation:
  1461. description: |-
  1462. ClusterLocation is the location of the cluster
  1463. If not specified, it fetches information from the metadata server
  1464. type: string
  1465. clusterName:
  1466. description: |-
  1467. ClusterName is the name of the cluster
  1468. If not specified, it fetches information from the metadata server
  1469. type: string
  1470. clusterProjectID:
  1471. description: |-
  1472. ClusterProjectID is the project ID of the cluster
  1473. If not specified, it fetches information from the metadata server
  1474. type: string
  1475. serviceAccountRef:
  1476. description: ServiceAccountSelector is a reference
  1477. to a ServiceAccount resource.
  1478. properties:
  1479. audiences:
  1480. description: |-
  1481. Audience specifies the `aud` claim for the service account token
  1482. If the service account uses a well-known annotation for e.g. IRSA or GCP Workload Identity
  1483. then this audiences will be appended to the list
  1484. items:
  1485. type: string
  1486. type: array
  1487. name:
  1488. description: The name of the ServiceAccount
  1489. resource being referred to.
  1490. maxLength: 253
  1491. minLength: 1
  1492. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  1493. type: string
  1494. namespace:
  1495. description: |-
  1496. Namespace of the resource being referred to.
  1497. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
  1498. maxLength: 63
  1499. minLength: 1
  1500. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  1501. type: string
  1502. required:
  1503. - name
  1504. type: object
  1505. required:
  1506. - serviceAccountRef
  1507. type: object
  1508. required:
  1509. - role
  1510. type: object
  1511. iam:
  1512. description: |-
  1513. Iam authenticates with vault by passing a special AWS request signed with AWS IAM credentials
  1514. AWS IAM authentication method
  1515. properties:
  1516. externalID:
  1517. description: AWS External ID set on assumed IAM
  1518. roles
  1519. type: string
  1520. jwt:
  1521. description: Specify a service account with IRSA
  1522. enabled
  1523. properties:
  1524. serviceAccountRef:
  1525. description: ServiceAccountSelector is a reference
  1526. to a ServiceAccount resource.
  1527. properties:
  1528. audiences:
  1529. description: |-
  1530. Audience specifies the `aud` claim for the service account token
  1531. If the service account uses a well-known annotation for e.g. IRSA or GCP Workload Identity
  1532. then this audiences will be appended to the list
  1533. items:
  1534. type: string
  1535. type: array
  1536. name:
  1537. description: The name of the ServiceAccount
  1538. resource being referred to.
  1539. maxLength: 253
  1540. minLength: 1
  1541. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  1542. type: string
  1543. namespace:
  1544. description: |-
  1545. Namespace of the resource being referred to.
  1546. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
  1547. maxLength: 63
  1548. minLength: 1
  1549. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  1550. type: string
  1551. required:
  1552. - name
  1553. type: object
  1554. type: object
  1555. path:
  1556. description: 'Path where the AWS auth method is
  1557. enabled in Vault, e.g: "aws"'
  1558. type: string
  1559. region:
  1560. description: AWS region
  1561. type: string
  1562. role:
  1563. description: This is the AWS role to be assumed
  1564. before talking to vault
  1565. type: string
  1566. secretRef:
  1567. description: Specify credentials in a Secret object
  1568. properties:
  1569. accessKeyIDSecretRef:
  1570. description: The AccessKeyID is used for authentication
  1571. properties:
  1572. key:
  1573. description: |-
  1574. A key in the referenced Secret.
  1575. Some instances of this field may be defaulted, in others it may be required.
  1576. maxLength: 253
  1577. minLength: 1
  1578. pattern: ^[-._a-zA-Z0-9]+$
  1579. type: string
  1580. name:
  1581. description: The name of the Secret resource
  1582. being referred to.
  1583. maxLength: 253
  1584. minLength: 1
  1585. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  1586. type: string
  1587. namespace:
  1588. description: |-
  1589. The namespace of the Secret resource being referred to.
  1590. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
  1591. maxLength: 63
  1592. minLength: 1
  1593. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  1594. type: string
  1595. type: object
  1596. secretAccessKeySecretRef:
  1597. description: The SecretAccessKey is used for
  1598. authentication
  1599. properties:
  1600. key:
  1601. description: |-
  1602. A key in the referenced Secret.
  1603. Some instances of this field may be defaulted, in others it may be required.
  1604. maxLength: 253
  1605. minLength: 1
  1606. pattern: ^[-._a-zA-Z0-9]+$
  1607. type: string
  1608. name:
  1609. description: The name of the Secret resource
  1610. being referred to.
  1611. maxLength: 253
  1612. minLength: 1
  1613. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  1614. type: string
  1615. namespace:
  1616. description: |-
  1617. The namespace of the Secret resource being referred to.
  1618. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
  1619. maxLength: 63
  1620. minLength: 1
  1621. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  1622. type: string
  1623. type: object
  1624. sessionTokenSecretRef:
  1625. description: |-
  1626. The SessionToken used for authentication
  1627. This must be defined if AccessKeyID and SecretAccessKey are temporary credentials
  1628. see: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_use-resources.html
  1629. properties:
  1630. key:
  1631. description: |-
  1632. A key in the referenced Secret.
  1633. Some instances of this field may be defaulted, in others it may be required.
  1634. maxLength: 253
  1635. minLength: 1
  1636. pattern: ^[-._a-zA-Z0-9]+$
  1637. type: string
  1638. name:
  1639. description: The name of the Secret resource
  1640. being referred to.
  1641. maxLength: 253
  1642. minLength: 1
  1643. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  1644. type: string
  1645. namespace:
  1646. description: |-
  1647. The namespace of the Secret resource being referred to.
  1648. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
  1649. maxLength: 63
  1650. minLength: 1
  1651. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  1652. type: string
  1653. type: object
  1654. type: object
  1655. vaultAwsIamServerID:
  1656. description: 'X-Vault-AWS-IAM-Server-ID is an
  1657. additional header used by Vault IAM auth method
  1658. to mitigate against different types of replay
  1659. attacks. More details here: https://developer.hashicorp.com/vault/docs/auth/aws'
  1660. type: string
  1661. vaultRole:
  1662. description: Vault Role. In vault, a role describes
  1663. an identity with a set of permissions, groups,
  1664. or policies you want to attach a user of the
  1665. secrets engine
  1666. type: string
  1667. required:
  1668. - vaultRole
  1669. type: object
  1670. jwt:
  1671. description: |-
  1672. Jwt authenticates with Vault by passing role and JWT token using the
  1673. JWT/OIDC authentication method
  1674. properties:
  1675. kubernetesServiceAccountToken:
  1676. description: |-
  1677. Optional ServiceAccountToken specifies the Kubernetes service account for which to request
  1678. a token for with the `TokenRequest` API.
  1679. properties:
  1680. audiences:
  1681. description: |-
  1682. Optional audiences field that will be used to request a temporary Kubernetes service
  1683. account token for the service account referenced by `serviceAccountRef`.
  1684. Defaults to a single audience `vault` it not specified.
  1685. Deprecated: use serviceAccountRef.Audiences instead
  1686. items:
  1687. type: string
  1688. type: array
  1689. expirationSeconds:
  1690. description: |-
  1691. Optional expiration time in seconds that will be used to request a temporary
  1692. Kubernetes service account token for the service account referenced by
  1693. `serviceAccountRef`.
  1694. Deprecated: this will be removed in the future.
  1695. Defaults to 10 minutes.
  1696. format: int64
  1697. type: integer
  1698. serviceAccountRef:
  1699. description: Service account field containing
  1700. the name of a kubernetes ServiceAccount.
  1701. properties:
  1702. audiences:
  1703. description: |-
  1704. Audience specifies the `aud` claim for the service account token
  1705. If the service account uses a well-known annotation for e.g. IRSA or GCP Workload Identity
  1706. then this audiences will be appended to the list
  1707. items:
  1708. type: string
  1709. type: array
  1710. name:
  1711. description: The name of the ServiceAccount
  1712. resource being referred to.
  1713. maxLength: 253
  1714. minLength: 1
  1715. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  1716. type: string
  1717. namespace:
  1718. description: |-
  1719. Namespace of the resource being referred to.
  1720. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
  1721. maxLength: 63
  1722. minLength: 1
  1723. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  1724. type: string
  1725. required:
  1726. - name
  1727. type: object
  1728. required:
  1729. - serviceAccountRef
  1730. type: object
  1731. path:
  1732. default: jwt
  1733. description: |-
  1734. Path where the JWT authentication backend is mounted
  1735. in Vault, e.g: "jwt"
  1736. type: string
  1737. role:
  1738. description: |-
  1739. Role is a JWT role to authenticate using the JWT/OIDC Vault
  1740. authentication method
  1741. type: string
  1742. secretRef:
  1743. description: |-
  1744. Optional SecretRef that refers to a key in a Secret resource containing JWT token to
  1745. authenticate with Vault using the JWT/OIDC authentication method.
  1746. properties:
  1747. key:
  1748. description: |-
  1749. A key in the referenced Secret.
  1750. Some instances of this field may be defaulted, in others it may be required.
  1751. maxLength: 253
  1752. minLength: 1
  1753. pattern: ^[-._a-zA-Z0-9]+$
  1754. type: string
  1755. name:
  1756. description: The name of the Secret resource
  1757. being referred to.
  1758. maxLength: 253
  1759. minLength: 1
  1760. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  1761. type: string
  1762. namespace:
  1763. description: |-
  1764. The namespace of the Secret resource being referred to.
  1765. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
  1766. maxLength: 63
  1767. minLength: 1
  1768. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  1769. type: string
  1770. type: object
  1771. required:
  1772. - path
  1773. type: object
  1774. kubernetes:
  1775. description: |-
  1776. Kubernetes authenticates with Vault by passing the ServiceAccount
  1777. token stored in the named Secret resource to the Vault server.
  1778. properties:
  1779. mountPath:
  1780. default: kubernetes
  1781. description: |-
  1782. Path where the Kubernetes authentication backend is mounted in Vault, e.g:
  1783. "kubernetes"
  1784. type: string
  1785. role:
  1786. description: |-
  1787. A required field containing the Vault Role to assume. A Role binds a
  1788. Kubernetes ServiceAccount with a set of Vault policies.
  1789. type: string
  1790. secretRef:
  1791. description: |-
  1792. Optional secret field containing a Kubernetes ServiceAccount JWT used
  1793. for authenticating with Vault. If a name is specified without a key,
  1794. `token` is the default. If one is not specified, the one bound to
  1795. the controller will be used.
  1796. properties:
  1797. key:
  1798. description: |-
  1799. A key in the referenced Secret.
  1800. Some instances of this field may be defaulted, in others it may be required.
  1801. maxLength: 253
  1802. minLength: 1
  1803. pattern: ^[-._a-zA-Z0-9]+$
  1804. type: string
  1805. name:
  1806. description: The name of the Secret resource
  1807. being referred to.
  1808. maxLength: 253
  1809. minLength: 1
  1810. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  1811. type: string
  1812. namespace:
  1813. description: |-
  1814. The namespace of the Secret resource being referred to.
  1815. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
  1816. maxLength: 63
  1817. minLength: 1
  1818. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  1819. type: string
  1820. type: object
  1821. serviceAccountRef:
  1822. description: |-
  1823. Optional service account field containing the name of a kubernetes ServiceAccount.
  1824. If the service account is specified, the service account secret token JWT will be used
  1825. for authenticating with Vault. If the service account selector is not supplied,
  1826. the secretRef will be used instead.
  1827. properties:
  1828. audiences:
  1829. description: |-
  1830. Audience specifies the `aud` claim for the service account token
  1831. If the service account uses a well-known annotation for e.g. IRSA or GCP Workload Identity
  1832. then this audiences will be appended to the list
  1833. items:
  1834. type: string
  1835. type: array
  1836. name:
  1837. description: The name of the ServiceAccount
  1838. resource being referred to.
  1839. maxLength: 253
  1840. minLength: 1
  1841. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  1842. type: string
  1843. namespace:
  1844. description: |-
  1845. Namespace of the resource being referred to.
  1846. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
  1847. maxLength: 63
  1848. minLength: 1
  1849. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  1850. type: string
  1851. required:
  1852. - name
  1853. type: object
  1854. required:
  1855. - mountPath
  1856. - role
  1857. type: object
  1858. ldap:
  1859. description: |-
  1860. Ldap authenticates with Vault by passing username/password pair using
  1861. the LDAP authentication method
  1862. properties:
  1863. path:
  1864. default: ldap
  1865. description: |-
  1866. Path where the LDAP authentication backend is mounted
  1867. in Vault, e.g: "ldap"
  1868. type: string
  1869. secretRef:
  1870. description: |-
  1871. SecretRef to a key in a Secret resource containing password for the LDAP
  1872. user used to authenticate with Vault using the LDAP authentication
  1873. method
  1874. properties:
  1875. key:
  1876. description: |-
  1877. A key in the referenced Secret.
  1878. Some instances of this field may be defaulted, in others it may be required.
  1879. maxLength: 253
  1880. minLength: 1
  1881. pattern: ^[-._a-zA-Z0-9]+$
  1882. type: string
  1883. name:
  1884. description: The name of the Secret resource
  1885. being referred to.
  1886. maxLength: 253
  1887. minLength: 1
  1888. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  1889. type: string
  1890. namespace:
  1891. description: |-
  1892. The namespace of the Secret resource being referred to.
  1893. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
  1894. maxLength: 63
  1895. minLength: 1
  1896. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  1897. type: string
  1898. type: object
  1899. username:
  1900. description: |-
  1901. Username is an LDAP username used to authenticate using the LDAP Vault
  1902. authentication method
  1903. type: string
  1904. required:
  1905. - path
  1906. - username
  1907. type: object
  1908. namespace:
  1909. description: |-
  1910. Name of the vault namespace to authenticate to. This can be different than the namespace your secret is in.
  1911. Namespaces is a set of features within Vault Enterprise that allows
  1912. Vault environments to support Secure Multi-tenancy. e.g: "ns1".
  1913. More about namespaces can be found here https://www.vaultproject.io/docs/enterprise/namespaces
  1914. This will default to Vault.Namespace field if set, or empty otherwise
  1915. type: string
  1916. tokenSecretRef:
  1917. description: TokenSecretRef authenticates with Vault
  1918. by presenting a token.
  1919. properties:
  1920. key:
  1921. description: |-
  1922. A key in the referenced Secret.
  1923. Some instances of this field may be defaulted, in others it may be required.
  1924. maxLength: 253
  1925. minLength: 1
  1926. pattern: ^[-._a-zA-Z0-9]+$
  1927. type: string
  1928. name:
  1929. description: The name of the Secret resource being
  1930. referred to.
  1931. maxLength: 253
  1932. minLength: 1
  1933. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  1934. type: string
  1935. namespace:
  1936. description: |-
  1937. The namespace of the Secret resource being referred to.
  1938. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
  1939. maxLength: 63
  1940. minLength: 1
  1941. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  1942. type: string
  1943. type: object
  1944. userPass:
  1945. description: UserPass authenticates with Vault by
  1946. passing username/password pair
  1947. properties:
  1948. path:
  1949. default: userpass
  1950. description: |-
  1951. Path where the UserPassword authentication backend is mounted
  1952. in Vault, e.g: "userpass"
  1953. type: string
  1954. secretRef:
  1955. description: |-
  1956. SecretRef to a key in a Secret resource containing password for the
  1957. user used to authenticate with Vault using the UserPass authentication
  1958. method
  1959. properties:
  1960. key:
  1961. description: |-
  1962. A key in the referenced Secret.
  1963. Some instances of this field may be defaulted, in others it may be required.
  1964. maxLength: 253
  1965. minLength: 1
  1966. pattern: ^[-._a-zA-Z0-9]+$
  1967. type: string
  1968. name:
  1969. description: The name of the Secret resource
  1970. being referred to.
  1971. maxLength: 253
  1972. minLength: 1
  1973. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  1974. type: string
  1975. namespace:
  1976. description: |-
  1977. The namespace of the Secret resource being referred to.
  1978. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
  1979. maxLength: 63
  1980. minLength: 1
  1981. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  1982. type: string
  1983. type: object
  1984. username:
  1985. description: |-
  1986. Username is a username used to authenticate using the UserPass Vault
  1987. authentication method
  1988. type: string
  1989. required:
  1990. - path
  1991. - username
  1992. type: object
  1993. type: object
  1994. caBundle:
  1995. description: |-
  1996. PEM encoded CA bundle used to validate Vault server certificate. Only used
  1997. if the Server URL is using HTTPS protocol. This parameter is ignored for
  1998. plain HTTP protocol connection. If not set the system root certificates
  1999. are used to validate the TLS connection.
  2000. format: byte
  2001. type: string
  2002. caProvider:
  2003. description: The provider for the CA bundle to use to
  2004. validate Vault server certificate.
  2005. properties:
  2006. key:
  2007. description: The key where the CA certificate can
  2008. be found in the Secret or ConfigMap.
  2009. maxLength: 253
  2010. minLength: 1
  2011. pattern: ^[-._a-zA-Z0-9]+$
  2012. type: string
  2013. name:
  2014. description: The name of the object located at the
  2015. provider type.
  2016. maxLength: 253
  2017. minLength: 1
  2018. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  2019. type: string
  2020. namespace:
  2021. description: |-
  2022. The namespace the Provider type is in.
  2023. Can only be defined when used in a ClusterSecretStore.
  2024. maxLength: 63
  2025. minLength: 1
  2026. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  2027. type: string
  2028. type:
  2029. description: The type of provider to use such as "Secret",
  2030. or "ConfigMap".
  2031. enum:
  2032. - Secret
  2033. - ConfigMap
  2034. type: string
  2035. required:
  2036. - name
  2037. - type
  2038. type: object
  2039. checkAndSet:
  2040. description: |-
  2041. CheckAndSet defines the Check-And-Set (CAS) settings for PushSecret operations.
  2042. Only applies to Vault KV v2 stores. When enabled, write operations must include
  2043. the current version of the secret to prevent unintentional overwrites.
  2044. properties:
  2045. required:
  2046. description: |-
  2047. Required when true, all write operations must include a check-and-set parameter.
  2048. This helps prevent unintentional overwrites of secrets.
  2049. type: boolean
  2050. type: object
  2051. forwardInconsistent:
  2052. description: |-
  2053. ForwardInconsistent tells Vault to forward read-after-write requests to the Vault
  2054. leader instead of simply retrying within a loop. This can increase performance if
  2055. the option is enabled serverside.
  2056. https://www.vaultproject.io/docs/configuration/replication#allow_forwarding_via_header
  2057. type: boolean
  2058. headers:
  2059. additionalProperties:
  2060. type: string
  2061. description: Headers to be added in Vault request
  2062. type: object
  2063. namespace:
  2064. description: |-
  2065. Name of the vault namespace. Namespaces is a set of features within Vault Enterprise that allows
  2066. Vault environments to support Secure Multi-tenancy. e.g: "ns1".
  2067. More about namespaces can be found here https://www.vaultproject.io/docs/enterprise/namespaces
  2068. type: string
  2069. path:
  2070. description: |-
  2071. Path is the mount path of the Vault KV backend endpoint, e.g:
  2072. "secret". The v2 KV secret engine version specific "/data" path suffix
  2073. for fetching secrets from Vault is optional and will be appended
  2074. if not present in specified path.
  2075. type: string
  2076. readYourWrites:
  2077. description: |-
  2078. ReadYourWrites ensures isolated read-after-write semantics by
  2079. providing discovered cluster replication states in each request.
  2080. More information about eventual consistency in Vault can be found here
  2081. https://www.vaultproject.io/docs/enterprise/consistency
  2082. type: boolean
  2083. server:
  2084. description: 'Server is the connection address for the
  2085. Vault server, e.g: "https://vault.example.com:8200".'
  2086. type: string
  2087. tls:
  2088. description: |-
  2089. The configuration used for client side related TLS communication, when the Vault server
  2090. requires mutual authentication. Only used if the Server URL is using HTTPS protocol.
  2091. This parameter is ignored for plain HTTP protocol connection.
  2092. It's worth noting this configuration is different from the "TLS certificates auth method",
  2093. which is available under the `auth.cert` section.
  2094. properties:
  2095. certSecretRef:
  2096. description: |-
  2097. CertSecretRef is a certificate added to the transport layer
  2098. when communicating with the Vault server.
  2099. If no key for the Secret is specified, external-secret will default to 'tls.crt'.
  2100. properties:
  2101. key:
  2102. description: |-
  2103. A key in the referenced Secret.
  2104. Some instances of this field may be defaulted, in others it may be required.
  2105. maxLength: 253
  2106. minLength: 1
  2107. pattern: ^[-._a-zA-Z0-9]+$
  2108. type: string
  2109. name:
  2110. description: The name of the Secret resource being
  2111. referred to.
  2112. maxLength: 253
  2113. minLength: 1
  2114. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  2115. type: string
  2116. namespace:
  2117. description: |-
  2118. The namespace of the Secret resource being referred to.
  2119. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
  2120. maxLength: 63
  2121. minLength: 1
  2122. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  2123. type: string
  2124. type: object
  2125. keySecretRef:
  2126. description: |-
  2127. KeySecretRef to a key in a Secret resource containing client private key
  2128. added to the transport layer when communicating with the Vault server.
  2129. If no key for the Secret is specified, external-secret will default to 'tls.key'.
  2130. properties:
  2131. key:
  2132. description: |-
  2133. A key in the referenced Secret.
  2134. Some instances of this field may be defaulted, in others it may be required.
  2135. maxLength: 253
  2136. minLength: 1
  2137. pattern: ^[-._a-zA-Z0-9]+$
  2138. type: string
  2139. name:
  2140. description: The name of the Secret resource being
  2141. referred to.
  2142. maxLength: 253
  2143. minLength: 1
  2144. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  2145. type: string
  2146. namespace:
  2147. description: |-
  2148. The namespace of the Secret resource being referred to.
  2149. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
  2150. maxLength: 63
  2151. minLength: 1
  2152. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  2153. type: string
  2154. type: object
  2155. type: object
  2156. version:
  2157. default: v2
  2158. description: |-
  2159. Version is the Vault KV secret engine version. This can be either "v1" or
  2160. "v2". Version defaults to "v2".
  2161. enum:
  2162. - v1
  2163. - v2
  2164. type: string
  2165. required:
  2166. - server
  2167. type: object
  2168. resultType:
  2169. default: Data
  2170. description: |-
  2171. Result type defines which data is returned from the generator.
  2172. By default, it is the "data" section of the Vault API response.
  2173. When using e.g. /auth/token/create the "data" section is empty but
  2174. the "auth" section contains the generated token.
  2175. Please refer to the vault docs regarding the result data structure.
  2176. Additionally, accessing the raw response is possibly by using "Raw" result type.
  2177. enum:
  2178. - Data
  2179. - Auth
  2180. - Raw
  2181. type: string
  2182. retrySettings:
  2183. description: Used to configure http retries if failed
  2184. properties:
  2185. maxRetries:
  2186. format: int32
  2187. type: integer
  2188. retryInterval:
  2189. type: string
  2190. type: object
  2191. required:
  2192. - path
  2193. - provider
  2194. type: object
  2195. webhookSpec:
  2196. description: WebhookSpec controls the behavior of the external
  2197. generator. Any body parameters should be passed to the server
  2198. through the parameters field.
  2199. properties:
  2200. auth:
  2201. description: Auth specifies a authorization protocol. Only
  2202. one protocol may be set.
  2203. maxProperties: 1
  2204. minProperties: 1
  2205. properties:
  2206. ntlm:
  2207. description: NTLMProtocol configures the store to use
  2208. NTLM for auth
  2209. properties:
  2210. passwordSecret:
  2211. description: |-
  2212. SecretKeySelector is a reference to a specific 'key' within a Secret resource.
  2213. In some instances, `key` is a required field.
  2214. properties:
  2215. key:
  2216. description: |-
  2217. A key in the referenced Secret.
  2218. Some instances of this field may be defaulted, in others it may be required.
  2219. maxLength: 253
  2220. minLength: 1
  2221. pattern: ^[-._a-zA-Z0-9]+$
  2222. type: string
  2223. name:
  2224. description: The name of the Secret resource being
  2225. referred to.
  2226. maxLength: 253
  2227. minLength: 1
  2228. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  2229. type: string
  2230. namespace:
  2231. description: |-
  2232. The namespace of the Secret resource being referred to.
  2233. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
  2234. maxLength: 63
  2235. minLength: 1
  2236. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  2237. type: string
  2238. type: object
  2239. usernameSecret:
  2240. description: |-
  2241. SecretKeySelector is a reference to a specific 'key' within a Secret resource.
  2242. In some instances, `key` is a required field.
  2243. properties:
  2244. key:
  2245. description: |-
  2246. A key in the referenced Secret.
  2247. Some instances of this field may be defaulted, in others it may be required.
  2248. maxLength: 253
  2249. minLength: 1
  2250. pattern: ^[-._a-zA-Z0-9]+$
  2251. type: string
  2252. name:
  2253. description: The name of the Secret resource being
  2254. referred to.
  2255. maxLength: 253
  2256. minLength: 1
  2257. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  2258. type: string
  2259. namespace:
  2260. description: |-
  2261. The namespace of the Secret resource being referred to.
  2262. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
  2263. maxLength: 63
  2264. minLength: 1
  2265. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  2266. type: string
  2267. type: object
  2268. required:
  2269. - passwordSecret
  2270. - usernameSecret
  2271. type: object
  2272. type: object
  2273. body:
  2274. description: Body
  2275. type: string
  2276. caBundle:
  2277. description: |-
  2278. PEM encoded CA bundle used to validate webhook server certificate. Only used
  2279. if the Server URL is using HTTPS protocol. This parameter is ignored for
  2280. plain HTTP protocol connection. If not set the system root certificates
  2281. are used to validate the TLS connection.
  2282. format: byte
  2283. type: string
  2284. caProvider:
  2285. description: The provider for the CA bundle to use to validate
  2286. webhook server certificate.
  2287. properties:
  2288. key:
  2289. description: The key where the CA certificate can be found
  2290. in the Secret or ConfigMap.
  2291. maxLength: 253
  2292. minLength: 1
  2293. pattern: ^[-._a-zA-Z0-9]+$
  2294. type: string
  2295. name:
  2296. description: The name of the object located at the provider
  2297. type.
  2298. maxLength: 253
  2299. minLength: 1
  2300. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  2301. type: string
  2302. namespace:
  2303. description: The namespace the Provider type is in.
  2304. maxLength: 63
  2305. minLength: 1
  2306. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  2307. type: string
  2308. type:
  2309. description: The type of provider to use such as "Secret",
  2310. or "ConfigMap".
  2311. enum:
  2312. - Secret
  2313. - ConfigMap
  2314. type: string
  2315. required:
  2316. - name
  2317. - type
  2318. type: object
  2319. headers:
  2320. additionalProperties:
  2321. type: string
  2322. description: Headers
  2323. type: object
  2324. method:
  2325. description: Webhook Method
  2326. type: string
  2327. result:
  2328. description: Result formatting
  2329. properties:
  2330. jsonPath:
  2331. description: Json path of return value
  2332. type: string
  2333. type: object
  2334. secrets:
  2335. description: |-
  2336. Secrets to fill in templates
  2337. These secrets will be passed to the templating function as key value pairs under the given name
  2338. items:
  2339. description: WebhookSecret defines a secret reference that
  2340. will be used in webhook templates.
  2341. properties:
  2342. name:
  2343. description: Name of this secret in templates
  2344. type: string
  2345. secretRef:
  2346. description: Secret ref to fill in credentials
  2347. properties:
  2348. key:
  2349. description: The key where the token is found.
  2350. maxLength: 253
  2351. minLength: 1
  2352. pattern: ^[-._a-zA-Z0-9]+$
  2353. type: string
  2354. name:
  2355. description: The name of the Secret resource being
  2356. referred to.
  2357. maxLength: 253
  2358. minLength: 1
  2359. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  2360. type: string
  2361. type: object
  2362. required:
  2363. - name
  2364. - secretRef
  2365. type: object
  2366. type: array
  2367. timeout:
  2368. description: Timeout
  2369. type: string
  2370. url:
  2371. description: Webhook url to call
  2372. type: string
  2373. required:
  2374. - result
  2375. - url
  2376. type: object
  2377. type: object
  2378. kind:
  2379. description: Kind the kind of this generator.
  2380. enum:
  2381. - ACRAccessToken
  2382. - CloudsmithAccessToken
  2383. - ECRAuthorizationToken
  2384. - Fake
  2385. - GCRAccessToken
  2386. - GithubAccessToken
  2387. - QuayAccessToken
  2388. - Password
  2389. - SSHKey
  2390. - STSSessionToken
  2391. - UUID
  2392. - VaultDynamicSecret
  2393. - Webhook
  2394. - Grafana
  2395. type: string
  2396. required:
  2397. - generator
  2398. - kind
  2399. type: object
  2400. type: object
  2401. served: true
  2402. storage: true
  2403. subresources:
  2404. status: {}