generators.external-secrets.io_clustergenerators.yaml 140 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396
  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. serviceAccountRef:
  605. description: |-
  606. serviceAccountRef is the reference to the kubernetes ServiceAccount to be used for obtaining the tokens,
  607. when Kubernetes is configured as provider in workload identity pool.
  608. properties:
  609. audiences:
  610. description: |-
  611. Audience specifies the `aud` claim for the service account token
  612. If the service account uses a well-known annotation for e.g. IRSA or GCP Workload Identity
  613. then this audiences will be appended to the list
  614. items:
  615. type: string
  616. type: array
  617. name:
  618. description: The name of the ServiceAccount resource
  619. being referred to.
  620. maxLength: 253
  621. minLength: 1
  622. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  623. type: string
  624. namespace:
  625. description: |-
  626. Namespace of the resource being referred to.
  627. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
  628. maxLength: 63
  629. minLength: 1
  630. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  631. type: string
  632. required:
  633. - name
  634. type: object
  635. type: object
  636. type: object
  637. projectID:
  638. description: ProjectID defines which project to use to authenticate
  639. with
  640. type: string
  641. required:
  642. - auth
  643. - projectID
  644. type: object
  645. githubAccessTokenSpec:
  646. description: GithubAccessTokenSpec defines the desired state to
  647. generate a GitHub access token.
  648. properties:
  649. appID:
  650. type: string
  651. auth:
  652. description: Auth configures how ESO authenticates with a
  653. Github instance.
  654. properties:
  655. privateKey:
  656. description: GithubSecretRef references a secret containing
  657. GitHub credentials.
  658. properties:
  659. secretRef:
  660. description: |-
  661. SecretKeySelector is a reference to a specific 'key' within a Secret resource.
  662. In some instances, `key` is a required field.
  663. properties:
  664. key:
  665. description: |-
  666. A key in the referenced Secret.
  667. Some instances of this field may be defaulted, in others it may be required.
  668. maxLength: 253
  669. minLength: 1
  670. pattern: ^[-._a-zA-Z0-9]+$
  671. type: string
  672. name:
  673. description: The name of the Secret resource being
  674. referred to.
  675. maxLength: 253
  676. minLength: 1
  677. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  678. type: string
  679. namespace:
  680. description: |-
  681. The namespace of the Secret resource being referred to.
  682. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
  683. maxLength: 63
  684. minLength: 1
  685. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  686. type: string
  687. type: object
  688. required:
  689. - secretRef
  690. type: object
  691. required:
  692. - privateKey
  693. type: object
  694. installID:
  695. type: string
  696. permissions:
  697. additionalProperties:
  698. type: string
  699. description: Map of permissions the token will have. If omitted,
  700. defaults to all permissions the GitHub App has.
  701. type: object
  702. repositories:
  703. description: |-
  704. List of repositories the token will have access to. If omitted, defaults to all repositories the GitHub App
  705. is installed to.
  706. items:
  707. type: string
  708. type: array
  709. url:
  710. description: URL configures the GitHub instance URL. Defaults
  711. to https://github.com/.
  712. type: string
  713. required:
  714. - appID
  715. - auth
  716. - installID
  717. type: object
  718. grafanaSpec:
  719. description: GrafanaSpec controls the behavior of the grafana
  720. generator.
  721. properties:
  722. auth:
  723. description: |-
  724. Auth is the authentication configuration to authenticate
  725. against the Grafana instance.
  726. properties:
  727. basic:
  728. description: |-
  729. Basic auth credentials used to authenticate against the Grafana instance.
  730. Note: you need a token which has elevated permissions to create service accounts.
  731. See here for the documentation on basic roles offered by Grafana:
  732. https://grafana.com/docs/grafana/latest/administration/roles-and-permissions/access-control/rbac-fixed-basic-role-definitions/
  733. properties:
  734. password:
  735. description: A basic auth password used to authenticate
  736. against the Grafana instance.
  737. properties:
  738. key:
  739. description: The key where the token is found.
  740. maxLength: 253
  741. minLength: 1
  742. pattern: ^[-._a-zA-Z0-9]+$
  743. type: string
  744. name:
  745. description: The name of the Secret resource being
  746. referred to.
  747. maxLength: 253
  748. minLength: 1
  749. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  750. type: string
  751. type: object
  752. username:
  753. description: A basic auth username used to authenticate
  754. against the Grafana instance.
  755. type: string
  756. required:
  757. - password
  758. - username
  759. type: object
  760. token:
  761. description: |-
  762. A service account token used to authenticate against the Grafana instance.
  763. Note: you need a token which has elevated permissions to create service accounts.
  764. See here for the documentation on basic roles offered by Grafana:
  765. https://grafana.com/docs/grafana/latest/administration/roles-and-permissions/access-control/rbac-fixed-basic-role-definitions/
  766. properties:
  767. key:
  768. description: The key where the token is found.
  769. maxLength: 253
  770. minLength: 1
  771. pattern: ^[-._a-zA-Z0-9]+$
  772. type: string
  773. name:
  774. description: The name of the Secret resource being
  775. referred to.
  776. maxLength: 253
  777. minLength: 1
  778. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  779. type: string
  780. type: object
  781. type: object
  782. serviceAccount:
  783. description: |-
  784. ServiceAccount is the configuration for the service account that
  785. is supposed to be generated by the generator.
  786. properties:
  787. name:
  788. description: Name is the name of the service account that
  789. will be created by ESO.
  790. type: string
  791. role:
  792. description: |-
  793. Role is the role of the service account.
  794. See here for the documentation on basic roles offered by Grafana:
  795. https://grafana.com/docs/grafana/latest/administration/roles-and-permissions/access-control/rbac-fixed-basic-role-definitions/
  796. type: string
  797. required:
  798. - name
  799. - role
  800. type: object
  801. url:
  802. description: URL is the URL of the Grafana instance.
  803. type: string
  804. required:
  805. - auth
  806. - serviceAccount
  807. - url
  808. type: object
  809. mfaSpec:
  810. description: MFASpec controls the behavior of the mfa generator.
  811. properties:
  812. algorithm:
  813. description: Algorithm to use for encoding. Defaults to SHA1
  814. as per the RFC.
  815. type: string
  816. length:
  817. description: Length defines the token length. Defaults to
  818. 6 characters.
  819. type: integer
  820. secret:
  821. description: Secret is a secret selector to a secret containing
  822. the seed secret to generate the TOTP value from.
  823. properties:
  824. key:
  825. description: |-
  826. A key in the referenced Secret.
  827. Some instances of this field may be defaulted, in others it may be required.
  828. maxLength: 253
  829. minLength: 1
  830. pattern: ^[-._a-zA-Z0-9]+$
  831. type: string
  832. name:
  833. description: The name of the Secret resource being referred
  834. to.
  835. maxLength: 253
  836. minLength: 1
  837. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  838. type: string
  839. namespace:
  840. description: |-
  841. The namespace of the Secret resource being referred to.
  842. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
  843. maxLength: 63
  844. minLength: 1
  845. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  846. type: string
  847. type: object
  848. timePeriod:
  849. description: TimePeriod defines how long the token can be
  850. active. Defaults to 30 seconds.
  851. type: integer
  852. when:
  853. description: When defines a time parameter that can be used
  854. to pin the origin time of the generated token.
  855. format: date-time
  856. type: string
  857. required:
  858. - secret
  859. type: object
  860. passwordSpec:
  861. description: PasswordSpec controls the behavior of the password
  862. generator.
  863. properties:
  864. allowRepeat:
  865. default: false
  866. description: set AllowRepeat to true to allow repeating characters.
  867. type: boolean
  868. digits:
  869. description: |-
  870. Digits specifies the number of digits in the generated
  871. password. If omitted it defaults to 25% of the length of the password
  872. type: integer
  873. encoding:
  874. default: raw
  875. description: |-
  876. Encoding specifies the encoding of the generated password.
  877. Valid values are:
  878. - "raw" (default): no encoding
  879. - "base64": standard base64 encoding
  880. - "base64url": base64url encoding
  881. - "base32": base32 encoding
  882. - "hex": hexadecimal encoding
  883. enum:
  884. - base64
  885. - base64url
  886. - base32
  887. - hex
  888. - raw
  889. type: string
  890. length:
  891. default: 24
  892. description: |-
  893. Length of the password to be generated.
  894. Defaults to 24
  895. type: integer
  896. noUpper:
  897. default: false
  898. description: Set NoUpper to disable uppercase characters
  899. type: boolean
  900. secretKeys:
  901. description: |-
  902. SecretKeys defines the keys that will be populated with generated passwords.
  903. Defaults to "password" when not set.
  904. items:
  905. type: string
  906. minItems: 1
  907. type: array
  908. symbolCharacters:
  909. description: |-
  910. SymbolCharacters specifies the special characters that should be used
  911. in the generated password.
  912. type: string
  913. symbols:
  914. description: |-
  915. Symbols specifies the number of symbol characters in the generated
  916. password. If omitted it defaults to 25% of the length of the password
  917. type: integer
  918. required:
  919. - allowRepeat
  920. - length
  921. - noUpper
  922. type: object
  923. quayAccessTokenSpec:
  924. description: QuayAccessTokenSpec defines the desired state to
  925. generate a Quay access token.
  926. properties:
  927. robotAccount:
  928. description: Name of the robot account you are federating
  929. with
  930. type: string
  931. serviceAccountRef:
  932. description: Name of the service account you are federating
  933. with
  934. properties:
  935. audiences:
  936. description: |-
  937. Audience specifies the `aud` claim for the service account token
  938. If the service account uses a well-known annotation for e.g. IRSA or GCP Workload Identity
  939. then this audiences will be appended to the list
  940. items:
  941. type: string
  942. type: array
  943. name:
  944. description: The name of the ServiceAccount resource being
  945. referred to.
  946. maxLength: 253
  947. minLength: 1
  948. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  949. type: string
  950. namespace:
  951. description: |-
  952. Namespace of the resource being referred to.
  953. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
  954. maxLength: 63
  955. minLength: 1
  956. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  957. type: string
  958. required:
  959. - name
  960. type: object
  961. url:
  962. description: URL configures the Quay instance URL. Defaults
  963. to quay.io.
  964. type: string
  965. required:
  966. - robotAccount
  967. - serviceAccountRef
  968. type: object
  969. sshKeySpec:
  970. description: SSHKeySpec controls the behavior of the ssh key generator.
  971. properties:
  972. comment:
  973. description: Comment specifies an optional comment for the
  974. SSH key
  975. type: string
  976. keySize:
  977. description: |-
  978. KeySize specifies the key size for RSA keys (default: 2048) and ECDSA keys (default: 256).
  979. For RSA keys: 2048, 3072, 4096
  980. For ECDSA keys: 256, 384, 521
  981. Ignored for ed25519 keys
  982. maximum: 8192
  983. minimum: 256
  984. type: integer
  985. keyType:
  986. default: rsa
  987. description: KeyType specifies the SSH key type (rsa, ecdsa,
  988. ed25519)
  989. enum:
  990. - rsa
  991. - ecdsa
  992. - ed25519
  993. type: string
  994. type: object
  995. stsSessionTokenSpec:
  996. description: STSSessionTokenSpec defines the desired state to
  997. generate an AWS STS session token.
  998. properties:
  999. auth:
  1000. description: Auth defines how to authenticate with AWS
  1001. properties:
  1002. jwt:
  1003. description: AWSJWTAuth provides configuration to authenticate
  1004. against AWS using service account tokens.
  1005. properties:
  1006. serviceAccountRef:
  1007. description: ServiceAccountSelector is a reference
  1008. to a ServiceAccount resource.
  1009. properties:
  1010. audiences:
  1011. description: |-
  1012. Audience specifies the `aud` claim for the service account token
  1013. If the service account uses a well-known annotation for e.g. IRSA or GCP Workload Identity
  1014. then this audiences will be appended to the list
  1015. items:
  1016. type: string
  1017. type: array
  1018. name:
  1019. description: The name of the ServiceAccount resource
  1020. being referred to.
  1021. maxLength: 253
  1022. minLength: 1
  1023. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  1024. type: string
  1025. namespace:
  1026. description: |-
  1027. Namespace of the resource being referred to.
  1028. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
  1029. maxLength: 63
  1030. minLength: 1
  1031. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  1032. type: string
  1033. required:
  1034. - name
  1035. type: object
  1036. type: object
  1037. secretRef:
  1038. description: |-
  1039. AWSAuthSecretRef holds secret references for AWS credentials
  1040. both AccessKeyID and SecretAccessKey must be defined in order to properly authenticate.
  1041. properties:
  1042. accessKeyIDSecretRef:
  1043. description: The AccessKeyID is used for authentication
  1044. properties:
  1045. key:
  1046. description: |-
  1047. A key in the referenced Secret.
  1048. Some instances of this field may be defaulted, in others it may be required.
  1049. maxLength: 253
  1050. minLength: 1
  1051. pattern: ^[-._a-zA-Z0-9]+$
  1052. type: string
  1053. name:
  1054. description: The name of the Secret resource being
  1055. referred to.
  1056. maxLength: 253
  1057. minLength: 1
  1058. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  1059. type: string
  1060. namespace:
  1061. description: |-
  1062. The namespace of the Secret resource being referred to.
  1063. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
  1064. maxLength: 63
  1065. minLength: 1
  1066. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  1067. type: string
  1068. type: object
  1069. secretAccessKeySecretRef:
  1070. description: The SecretAccessKey is used for authentication
  1071. properties:
  1072. key:
  1073. description: |-
  1074. A key in the referenced Secret.
  1075. Some instances of this field may be defaulted, in others it may be required.
  1076. maxLength: 253
  1077. minLength: 1
  1078. pattern: ^[-._a-zA-Z0-9]+$
  1079. type: string
  1080. name:
  1081. description: The name of the Secret resource being
  1082. referred to.
  1083. maxLength: 253
  1084. minLength: 1
  1085. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  1086. type: string
  1087. namespace:
  1088. description: |-
  1089. The namespace of the Secret resource being referred to.
  1090. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
  1091. maxLength: 63
  1092. minLength: 1
  1093. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  1094. type: string
  1095. type: object
  1096. sessionTokenSecretRef:
  1097. description: |-
  1098. The SessionToken used for authentication
  1099. This must be defined if AccessKeyID and SecretAccessKey are temporary credentials
  1100. see: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_use-resources.html
  1101. properties:
  1102. key:
  1103. description: |-
  1104. A key in the referenced Secret.
  1105. Some instances of this field may be defaulted, in others it may be required.
  1106. maxLength: 253
  1107. minLength: 1
  1108. pattern: ^[-._a-zA-Z0-9]+$
  1109. type: string
  1110. name:
  1111. description: The name of the Secret resource being
  1112. referred to.
  1113. maxLength: 253
  1114. minLength: 1
  1115. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  1116. type: string
  1117. namespace:
  1118. description: |-
  1119. The namespace of the Secret resource being referred to.
  1120. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
  1121. maxLength: 63
  1122. minLength: 1
  1123. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  1124. type: string
  1125. type: object
  1126. type: object
  1127. type: object
  1128. region:
  1129. description: Region specifies the region to operate in.
  1130. type: string
  1131. requestParameters:
  1132. description: RequestParameters contains parameters that can
  1133. be passed to the STS service.
  1134. properties:
  1135. serialNumber:
  1136. description: |-
  1137. SerialNumber is the identification number of the MFA device that is associated with the IAM user who is making
  1138. the GetSessionToken call.
  1139. Possible values: hardware device (such as GAHT12345678) or an Amazon Resource Name (ARN) for a virtual device
  1140. (such as arn:aws:iam::123456789012:mfa/user)
  1141. type: string
  1142. sessionDuration:
  1143. format: int32
  1144. type: integer
  1145. tokenCode:
  1146. description: TokenCode is the value provided by the MFA
  1147. device, if MFA is required.
  1148. type: string
  1149. type: object
  1150. role:
  1151. description: |-
  1152. You can assume a role before making calls to the
  1153. desired AWS service.
  1154. type: string
  1155. required:
  1156. - region
  1157. type: object
  1158. uuidSpec:
  1159. description: UUIDSpec controls the behavior of the uuid generator.
  1160. type: object
  1161. vaultDynamicSecretSpec:
  1162. description: VaultDynamicSecretSpec defines the desired spec of
  1163. VaultDynamicSecret.
  1164. properties:
  1165. allowEmptyResponse:
  1166. default: false
  1167. description: Do not fail if no secrets are found. Useful for
  1168. requests where no data is expected.
  1169. type: boolean
  1170. controller:
  1171. description: |-
  1172. Used to select the correct ESO controller (think: ingress.ingressClassName)
  1173. The ESO controller is instantiated with a specific controller name and filters VDS based on this property
  1174. type: string
  1175. getParameters:
  1176. additionalProperties:
  1177. items:
  1178. type: string
  1179. type: array
  1180. description: |-
  1181. GetParameters are query-string parameters passed to Vault on GET calls.
  1182. Each key may map to multiple values, matching HTTP query-string semantics.
  1183. Ignored for non-GET methods; use Parameters for write bodies.
  1184. type: object
  1185. method:
  1186. description: Vault API method to use (GET/POST/other)
  1187. type: string
  1188. parameters:
  1189. description: Parameters to pass to Vault write (for non-GET
  1190. methods)
  1191. x-kubernetes-preserve-unknown-fields: true
  1192. path:
  1193. description: Vault path to obtain the dynamic secret from
  1194. type: string
  1195. provider:
  1196. description: Vault provider common spec
  1197. properties:
  1198. auth:
  1199. description: Auth configures how secret-manager authenticates
  1200. with the Vault server.
  1201. properties:
  1202. appRole:
  1203. description: |-
  1204. AppRole authenticates with Vault using the App Role auth mechanism,
  1205. with the role and secret stored in a Kubernetes Secret resource.
  1206. properties:
  1207. path:
  1208. default: approle
  1209. description: |-
  1210. Path where the App Role authentication backend is mounted
  1211. in Vault, e.g: "approle"
  1212. type: string
  1213. roleId:
  1214. description: |-
  1215. RoleID configured in the App Role authentication backend when setting
  1216. up the authentication backend in Vault.
  1217. type: string
  1218. roleRef:
  1219. description: |-
  1220. Reference to a key in a Secret that contains the App Role ID used
  1221. to authenticate with Vault.
  1222. The `key` field must be specified and denotes which entry within the Secret
  1223. resource is used as the app role id.
  1224. properties:
  1225. key:
  1226. description: |-
  1227. A key in the referenced Secret.
  1228. Some instances of this field may be defaulted, in others it may be required.
  1229. maxLength: 253
  1230. minLength: 1
  1231. pattern: ^[-._a-zA-Z0-9]+$
  1232. type: string
  1233. name:
  1234. description: The name of the Secret resource
  1235. being referred to.
  1236. maxLength: 253
  1237. minLength: 1
  1238. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  1239. type: string
  1240. namespace:
  1241. description: |-
  1242. The namespace of the Secret resource being referred to.
  1243. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
  1244. maxLength: 63
  1245. minLength: 1
  1246. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  1247. type: string
  1248. type: object
  1249. secretRef:
  1250. description: |-
  1251. Reference to a key in a Secret that contains the App Role secret used
  1252. to authenticate with Vault.
  1253. The `key` field must be specified and denotes which entry within the Secret
  1254. resource is used as the app role secret.
  1255. properties:
  1256. key:
  1257. description: |-
  1258. A key in the referenced Secret.
  1259. Some instances of this field may be defaulted, in others it may be required.
  1260. maxLength: 253
  1261. minLength: 1
  1262. pattern: ^[-._a-zA-Z0-9]+$
  1263. type: string
  1264. name:
  1265. description: The name of the Secret resource
  1266. being referred to.
  1267. maxLength: 253
  1268. minLength: 1
  1269. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  1270. type: string
  1271. namespace:
  1272. description: |-
  1273. The namespace of the Secret resource being referred to.
  1274. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
  1275. maxLength: 63
  1276. minLength: 1
  1277. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  1278. type: string
  1279. type: object
  1280. required:
  1281. - path
  1282. - secretRef
  1283. type: object
  1284. cert:
  1285. description: |-
  1286. Cert authenticates with TLS Certificates by passing client certificate, private key and ca certificate
  1287. Cert authentication method
  1288. properties:
  1289. clientCert:
  1290. description: |-
  1291. ClientCert is a certificate to authenticate using the Cert Vault
  1292. authentication method
  1293. properties:
  1294. key:
  1295. description: |-
  1296. A key in the referenced Secret.
  1297. Some instances of this field may be defaulted, in others it may be required.
  1298. maxLength: 253
  1299. minLength: 1
  1300. pattern: ^[-._a-zA-Z0-9]+$
  1301. type: string
  1302. name:
  1303. description: The name of the Secret resource
  1304. being referred to.
  1305. maxLength: 253
  1306. minLength: 1
  1307. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  1308. type: string
  1309. namespace:
  1310. description: |-
  1311. The namespace of the Secret resource being referred to.
  1312. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
  1313. maxLength: 63
  1314. minLength: 1
  1315. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  1316. type: string
  1317. type: object
  1318. path:
  1319. default: cert
  1320. description: |-
  1321. Path where the Certificate authentication backend is mounted
  1322. in Vault, e.g: "cert"
  1323. type: string
  1324. secretRef:
  1325. description: |-
  1326. SecretRef to a key in a Secret resource containing client private key to
  1327. authenticate with Vault using the Cert authentication method
  1328. properties:
  1329. key:
  1330. description: |-
  1331. A key in the referenced Secret.
  1332. Some instances of this field may be defaulted, in others it may be required.
  1333. maxLength: 253
  1334. minLength: 1
  1335. pattern: ^[-._a-zA-Z0-9]+$
  1336. type: string
  1337. name:
  1338. description: The name of the Secret resource
  1339. being referred to.
  1340. maxLength: 253
  1341. minLength: 1
  1342. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  1343. type: string
  1344. namespace:
  1345. description: |-
  1346. The namespace of the Secret resource being referred to.
  1347. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
  1348. maxLength: 63
  1349. minLength: 1
  1350. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  1351. type: string
  1352. type: object
  1353. vaultRole:
  1354. description: VaultRole specifies the Vault role
  1355. to use for TLS certificate authentication.
  1356. type: string
  1357. type: object
  1358. gcp:
  1359. description: |-
  1360. Gcp authenticates with Vault using Google Cloud Platform authentication method
  1361. GCP authentication method
  1362. properties:
  1363. location:
  1364. description: Location optionally defines a location/region
  1365. for the secret
  1366. type: string
  1367. path:
  1368. default: gcp
  1369. description: 'Path where the GCP auth method is
  1370. enabled in Vault, e.g: "gcp"'
  1371. type: string
  1372. projectID:
  1373. description: Project ID of the Google Cloud Platform
  1374. project
  1375. type: string
  1376. role:
  1377. description: Vault Role. In Vault, a role describes
  1378. an identity with a set of permissions, groups,
  1379. or policies you want to attach to a user of
  1380. the secrets engine.
  1381. type: string
  1382. secretRef:
  1383. description: Specify credentials in a Secret object
  1384. properties:
  1385. secretAccessKeySecretRef:
  1386. description: The SecretAccessKey is used for
  1387. authentication
  1388. properties:
  1389. key:
  1390. description: |-
  1391. A key in the referenced Secret.
  1392. Some instances of this field may be defaulted, in others it may be required.
  1393. maxLength: 253
  1394. minLength: 1
  1395. pattern: ^[-._a-zA-Z0-9]+$
  1396. type: string
  1397. name:
  1398. description: The name of the Secret resource
  1399. being referred to.
  1400. maxLength: 253
  1401. minLength: 1
  1402. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  1403. type: string
  1404. namespace:
  1405. description: |-
  1406. The namespace of the Secret resource being referred to.
  1407. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
  1408. maxLength: 63
  1409. minLength: 1
  1410. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  1411. type: string
  1412. type: object
  1413. type: object
  1414. serviceAccountRef:
  1415. description: ServiceAccountRef to a service account
  1416. for impersonation
  1417. properties:
  1418. audiences:
  1419. description: |-
  1420. Audience specifies the `aud` claim for the service account token
  1421. If the service account uses a well-known annotation for e.g. IRSA or GCP Workload Identity
  1422. then this audiences will be appended to the list
  1423. items:
  1424. type: string
  1425. type: array
  1426. name:
  1427. description: The name of the ServiceAccount
  1428. resource being referred to.
  1429. maxLength: 253
  1430. minLength: 1
  1431. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  1432. type: string
  1433. namespace:
  1434. description: |-
  1435. Namespace of the resource being referred to.
  1436. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
  1437. maxLength: 63
  1438. minLength: 1
  1439. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  1440. type: string
  1441. required:
  1442. - name
  1443. type: object
  1444. workloadIdentity:
  1445. description: Specify a service account with Workload
  1446. Identity
  1447. properties:
  1448. clusterLocation:
  1449. description: |-
  1450. ClusterLocation is the location of the cluster
  1451. If not specified, it fetches information from the metadata server
  1452. type: string
  1453. clusterName:
  1454. description: |-
  1455. ClusterName is the name of the cluster
  1456. If not specified, it fetches information from the metadata server
  1457. type: string
  1458. clusterProjectID:
  1459. description: |-
  1460. ClusterProjectID is the project ID of the cluster
  1461. If not specified, it fetches information from the metadata server
  1462. type: string
  1463. serviceAccountRef:
  1464. description: ServiceAccountSelector is a reference
  1465. to a ServiceAccount resource.
  1466. properties:
  1467. audiences:
  1468. description: |-
  1469. Audience specifies the `aud` claim for the service account token
  1470. If the service account uses a well-known annotation for e.g. IRSA or GCP Workload Identity
  1471. then this audiences will be appended to the list
  1472. items:
  1473. type: string
  1474. type: array
  1475. name:
  1476. description: The name of the ServiceAccount
  1477. resource being referred to.
  1478. maxLength: 253
  1479. minLength: 1
  1480. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  1481. type: string
  1482. namespace:
  1483. description: |-
  1484. Namespace of the resource being referred to.
  1485. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
  1486. maxLength: 63
  1487. minLength: 1
  1488. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  1489. type: string
  1490. required:
  1491. - name
  1492. type: object
  1493. required:
  1494. - serviceAccountRef
  1495. type: object
  1496. required:
  1497. - role
  1498. type: object
  1499. iam:
  1500. description: |-
  1501. Iam authenticates with vault by passing a special AWS request signed with AWS IAM credentials
  1502. AWS IAM authentication method
  1503. properties:
  1504. externalID:
  1505. description: AWS External ID set on assumed IAM
  1506. roles
  1507. type: string
  1508. jwt:
  1509. description: Specify a service account with IRSA
  1510. enabled
  1511. properties:
  1512. serviceAccountRef:
  1513. description: ServiceAccountSelector is a reference
  1514. to a ServiceAccount resource.
  1515. properties:
  1516. audiences:
  1517. description: |-
  1518. Audience specifies the `aud` claim for the service account token
  1519. If the service account uses a well-known annotation for e.g. IRSA or GCP Workload Identity
  1520. then this audiences will be appended to the list
  1521. items:
  1522. type: string
  1523. type: array
  1524. name:
  1525. description: The name of the ServiceAccount
  1526. resource being referred to.
  1527. maxLength: 253
  1528. minLength: 1
  1529. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  1530. type: string
  1531. namespace:
  1532. description: |-
  1533. Namespace of the resource being referred to.
  1534. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
  1535. maxLength: 63
  1536. minLength: 1
  1537. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  1538. type: string
  1539. required:
  1540. - name
  1541. type: object
  1542. type: object
  1543. path:
  1544. description: 'Path where the AWS auth method is
  1545. enabled in Vault, e.g: "aws"'
  1546. type: string
  1547. region:
  1548. description: AWS region
  1549. type: string
  1550. role:
  1551. description: This is the AWS role to be assumed
  1552. before talking to vault
  1553. type: string
  1554. secretRef:
  1555. description: Specify credentials in a Secret object
  1556. properties:
  1557. accessKeyIDSecretRef:
  1558. description: The AccessKeyID is used for authentication
  1559. properties:
  1560. key:
  1561. description: |-
  1562. A key in the referenced Secret.
  1563. Some instances of this field may be defaulted, in others it may be required.
  1564. maxLength: 253
  1565. minLength: 1
  1566. pattern: ^[-._a-zA-Z0-9]+$
  1567. type: string
  1568. name:
  1569. description: The name of the Secret resource
  1570. being referred to.
  1571. maxLength: 253
  1572. minLength: 1
  1573. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  1574. type: string
  1575. namespace:
  1576. description: |-
  1577. The namespace of the Secret resource being referred to.
  1578. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
  1579. maxLength: 63
  1580. minLength: 1
  1581. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  1582. type: string
  1583. type: object
  1584. secretAccessKeySecretRef:
  1585. description: The SecretAccessKey is used for
  1586. authentication
  1587. properties:
  1588. key:
  1589. description: |-
  1590. A key in the referenced Secret.
  1591. Some instances of this field may be defaulted, in others it may be required.
  1592. maxLength: 253
  1593. minLength: 1
  1594. pattern: ^[-._a-zA-Z0-9]+$
  1595. type: string
  1596. name:
  1597. description: The name of the Secret resource
  1598. being referred to.
  1599. maxLength: 253
  1600. minLength: 1
  1601. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  1602. type: string
  1603. namespace:
  1604. description: |-
  1605. The namespace of the Secret resource being referred to.
  1606. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
  1607. maxLength: 63
  1608. minLength: 1
  1609. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  1610. type: string
  1611. type: object
  1612. sessionTokenSecretRef:
  1613. description: |-
  1614. The SessionToken used for authentication
  1615. This must be defined if AccessKeyID and SecretAccessKey are temporary credentials
  1616. see: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_use-resources.html
  1617. properties:
  1618. key:
  1619. description: |-
  1620. A key in the referenced Secret.
  1621. Some instances of this field may be defaulted, in others it may be required.
  1622. maxLength: 253
  1623. minLength: 1
  1624. pattern: ^[-._a-zA-Z0-9]+$
  1625. type: string
  1626. name:
  1627. description: The name of the Secret resource
  1628. being referred to.
  1629. maxLength: 253
  1630. minLength: 1
  1631. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  1632. type: string
  1633. namespace:
  1634. description: |-
  1635. The namespace of the Secret resource being referred to.
  1636. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
  1637. maxLength: 63
  1638. minLength: 1
  1639. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  1640. type: string
  1641. type: object
  1642. type: object
  1643. vaultAwsIamServerID:
  1644. description: 'X-Vault-AWS-IAM-Server-ID is an
  1645. additional header used by Vault IAM auth method
  1646. to mitigate against different types of replay
  1647. attacks. More details here: https://developer.hashicorp.com/vault/docs/auth/aws'
  1648. type: string
  1649. vaultRole:
  1650. description: Vault Role. In vault, a role describes
  1651. an identity with a set of permissions, groups,
  1652. or policies you want to attach a user of the
  1653. secrets engine
  1654. type: string
  1655. required:
  1656. - vaultRole
  1657. type: object
  1658. jwt:
  1659. description: |-
  1660. Jwt authenticates with Vault by passing role and JWT token using the
  1661. JWT/OIDC authentication method
  1662. properties:
  1663. kubernetesServiceAccountToken:
  1664. description: |-
  1665. Optional ServiceAccountToken specifies the Kubernetes service account for which to request
  1666. a token for with the `TokenRequest` API.
  1667. properties:
  1668. audiences:
  1669. description: |-
  1670. Optional audiences field that will be used to request a temporary Kubernetes service
  1671. account token for the service account referenced by `serviceAccountRef`.
  1672. Defaults to a single audience `vault` it not specified.
  1673. Deprecated: use serviceAccountRef.Audiences instead
  1674. items:
  1675. type: string
  1676. type: array
  1677. expirationSeconds:
  1678. description: |-
  1679. Optional expiration time in seconds that will be used to request a temporary
  1680. Kubernetes service account token for the service account referenced by
  1681. `serviceAccountRef`.
  1682. Deprecated: this will be removed in the future.
  1683. Defaults to 10 minutes.
  1684. format: int64
  1685. type: integer
  1686. serviceAccountRef:
  1687. description: Service account field containing
  1688. the name of a kubernetes ServiceAccount.
  1689. properties:
  1690. audiences:
  1691. description: |-
  1692. Audience specifies the `aud` claim for the service account token
  1693. If the service account uses a well-known annotation for e.g. IRSA or GCP Workload Identity
  1694. then this audiences will be appended to the list
  1695. items:
  1696. type: string
  1697. type: array
  1698. name:
  1699. description: The name of the ServiceAccount
  1700. resource being referred to.
  1701. maxLength: 253
  1702. minLength: 1
  1703. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  1704. type: string
  1705. namespace:
  1706. description: |-
  1707. Namespace of the resource being referred to.
  1708. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
  1709. maxLength: 63
  1710. minLength: 1
  1711. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  1712. type: string
  1713. required:
  1714. - name
  1715. type: object
  1716. required:
  1717. - serviceAccountRef
  1718. type: object
  1719. path:
  1720. default: jwt
  1721. description: |-
  1722. Path where the JWT authentication backend is mounted
  1723. in Vault, e.g: "jwt"
  1724. type: string
  1725. role:
  1726. description: |-
  1727. Role is a JWT role to authenticate using the JWT/OIDC Vault
  1728. authentication method
  1729. type: string
  1730. secretRef:
  1731. description: |-
  1732. Optional SecretRef that refers to a key in a Secret resource containing JWT token to
  1733. authenticate with Vault using the JWT/OIDC authentication method.
  1734. properties:
  1735. key:
  1736. description: |-
  1737. A key in the referenced Secret.
  1738. Some instances of this field may be defaulted, in others it may be required.
  1739. maxLength: 253
  1740. minLength: 1
  1741. pattern: ^[-._a-zA-Z0-9]+$
  1742. type: string
  1743. name:
  1744. description: The name of the Secret resource
  1745. being referred to.
  1746. maxLength: 253
  1747. minLength: 1
  1748. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  1749. type: string
  1750. namespace:
  1751. description: |-
  1752. The namespace of the Secret resource being referred to.
  1753. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
  1754. maxLength: 63
  1755. minLength: 1
  1756. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  1757. type: string
  1758. type: object
  1759. required:
  1760. - path
  1761. type: object
  1762. kubernetes:
  1763. description: |-
  1764. Kubernetes authenticates with Vault by passing the ServiceAccount
  1765. token stored in the named Secret resource to the Vault server.
  1766. properties:
  1767. mountPath:
  1768. default: kubernetes
  1769. description: |-
  1770. Path where the Kubernetes authentication backend is mounted in Vault, e.g:
  1771. "kubernetes"
  1772. type: string
  1773. role:
  1774. description: |-
  1775. A required field containing the Vault Role to assume. A Role binds a
  1776. Kubernetes ServiceAccount with a set of Vault policies.
  1777. type: string
  1778. secretRef:
  1779. description: |-
  1780. Optional secret field containing a Kubernetes ServiceAccount JWT used
  1781. for authenticating with Vault. If a name is specified without a key,
  1782. `token` is the default. If one is not specified, the one bound to
  1783. the controller will be used.
  1784. properties:
  1785. key:
  1786. description: |-
  1787. A key in the referenced Secret.
  1788. Some instances of this field may be defaulted, in others it may be required.
  1789. maxLength: 253
  1790. minLength: 1
  1791. pattern: ^[-._a-zA-Z0-9]+$
  1792. type: string
  1793. name:
  1794. description: The name of the Secret resource
  1795. being referred to.
  1796. maxLength: 253
  1797. minLength: 1
  1798. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  1799. type: string
  1800. namespace:
  1801. description: |-
  1802. The namespace of the Secret resource being referred to.
  1803. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
  1804. maxLength: 63
  1805. minLength: 1
  1806. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  1807. type: string
  1808. type: object
  1809. serviceAccountRef:
  1810. description: |-
  1811. Optional service account field containing the name of a kubernetes ServiceAccount.
  1812. If the service account is specified, the service account secret token JWT will be used
  1813. for authenticating with Vault. If the service account selector is not supplied,
  1814. the secretRef will be used instead.
  1815. properties:
  1816. audiences:
  1817. description: |-
  1818. Audience specifies the `aud` claim for the service account token
  1819. If the service account uses a well-known annotation for e.g. IRSA or GCP Workload Identity
  1820. then this audiences will be appended to the list
  1821. items:
  1822. type: string
  1823. type: array
  1824. name:
  1825. description: The name of the ServiceAccount
  1826. resource being referred to.
  1827. maxLength: 253
  1828. minLength: 1
  1829. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  1830. type: string
  1831. namespace:
  1832. description: |-
  1833. Namespace of the resource being referred to.
  1834. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
  1835. maxLength: 63
  1836. minLength: 1
  1837. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  1838. type: string
  1839. required:
  1840. - name
  1841. type: object
  1842. required:
  1843. - mountPath
  1844. - role
  1845. type: object
  1846. ldap:
  1847. description: |-
  1848. Ldap authenticates with Vault by passing username/password pair using
  1849. the LDAP authentication method
  1850. properties:
  1851. path:
  1852. default: ldap
  1853. description: |-
  1854. Path where the LDAP authentication backend is mounted
  1855. in Vault, e.g: "ldap"
  1856. type: string
  1857. secretRef:
  1858. description: |-
  1859. SecretRef to a key in a Secret resource containing password for the LDAP
  1860. user used to authenticate with Vault using the LDAP authentication
  1861. method
  1862. properties:
  1863. key:
  1864. description: |-
  1865. A key in the referenced Secret.
  1866. Some instances of this field may be defaulted, in others it may be required.
  1867. maxLength: 253
  1868. minLength: 1
  1869. pattern: ^[-._a-zA-Z0-9]+$
  1870. type: string
  1871. name:
  1872. description: The name of the Secret resource
  1873. being referred to.
  1874. maxLength: 253
  1875. minLength: 1
  1876. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  1877. type: string
  1878. namespace:
  1879. description: |-
  1880. The namespace of the Secret resource being referred to.
  1881. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
  1882. maxLength: 63
  1883. minLength: 1
  1884. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  1885. type: string
  1886. type: object
  1887. username:
  1888. description: |-
  1889. Username is an LDAP username used to authenticate using the LDAP Vault
  1890. authentication method
  1891. type: string
  1892. required:
  1893. - path
  1894. - username
  1895. type: object
  1896. namespace:
  1897. description: |-
  1898. Name of the vault namespace to authenticate to. This can be different than the namespace your secret is in.
  1899. Namespaces is a set of features within Vault Enterprise that allows
  1900. Vault environments to support Secure Multi-tenancy. e.g: "ns1".
  1901. More about namespaces can be found here https://www.vaultproject.io/docs/enterprise/namespaces
  1902. This will default to Vault.Namespace field if set, or empty otherwise
  1903. type: string
  1904. tokenSecretRef:
  1905. description: TokenSecretRef authenticates with Vault
  1906. by presenting a token.
  1907. properties:
  1908. key:
  1909. description: |-
  1910. A key in the referenced Secret.
  1911. Some instances of this field may be defaulted, in others it may be required.
  1912. maxLength: 253
  1913. minLength: 1
  1914. pattern: ^[-._a-zA-Z0-9]+$
  1915. type: string
  1916. name:
  1917. description: The name of the Secret resource being
  1918. referred to.
  1919. maxLength: 253
  1920. minLength: 1
  1921. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  1922. type: string
  1923. namespace:
  1924. description: |-
  1925. The namespace of the Secret resource being referred to.
  1926. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
  1927. maxLength: 63
  1928. minLength: 1
  1929. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  1930. type: string
  1931. type: object
  1932. userPass:
  1933. description: UserPass authenticates with Vault by
  1934. passing username/password pair
  1935. properties:
  1936. path:
  1937. default: userpass
  1938. description: |-
  1939. Path where the UserPassword authentication backend is mounted
  1940. in Vault, e.g: "userpass"
  1941. type: string
  1942. secretRef:
  1943. description: |-
  1944. SecretRef to a key in a Secret resource containing password for the
  1945. user used to authenticate with Vault using the UserPass authentication
  1946. method
  1947. properties:
  1948. key:
  1949. description: |-
  1950. A key in the referenced Secret.
  1951. Some instances of this field may be defaulted, in others it may be required.
  1952. maxLength: 253
  1953. minLength: 1
  1954. pattern: ^[-._a-zA-Z0-9]+$
  1955. type: string
  1956. name:
  1957. description: The name of the Secret resource
  1958. being referred to.
  1959. maxLength: 253
  1960. minLength: 1
  1961. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  1962. type: string
  1963. namespace:
  1964. description: |-
  1965. The namespace of the Secret resource being referred to.
  1966. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
  1967. maxLength: 63
  1968. minLength: 1
  1969. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  1970. type: string
  1971. type: object
  1972. username:
  1973. description: |-
  1974. Username is a username used to authenticate using the UserPass Vault
  1975. authentication method
  1976. type: string
  1977. required:
  1978. - path
  1979. - username
  1980. type: object
  1981. type: object
  1982. caBundle:
  1983. description: |-
  1984. PEM encoded CA bundle used to validate Vault server certificate. Only used
  1985. if the Server URL is using HTTPS protocol. This parameter is ignored for
  1986. plain HTTP protocol connection. If not set the system root certificates
  1987. are used to validate the TLS connection.
  1988. format: byte
  1989. type: string
  1990. caProvider:
  1991. description: The provider for the CA bundle to use to
  1992. validate Vault server certificate.
  1993. properties:
  1994. key:
  1995. description: The key where the CA certificate can
  1996. be found in the Secret or ConfigMap.
  1997. maxLength: 253
  1998. minLength: 1
  1999. pattern: ^[-._a-zA-Z0-9]+$
  2000. type: string
  2001. name:
  2002. description: The name of the object located at the
  2003. provider type.
  2004. maxLength: 253
  2005. minLength: 1
  2006. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  2007. type: string
  2008. namespace:
  2009. description: |-
  2010. The namespace the Provider type is in.
  2011. Can only be defined when used in a ClusterSecretStore.
  2012. maxLength: 63
  2013. minLength: 1
  2014. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  2015. type: string
  2016. type:
  2017. description: The type of provider to use such as "Secret",
  2018. or "ConfigMap".
  2019. enum:
  2020. - Secret
  2021. - ConfigMap
  2022. type: string
  2023. required:
  2024. - name
  2025. - type
  2026. type: object
  2027. checkAndSet:
  2028. description: |-
  2029. CheckAndSet defines the Check-And-Set (CAS) settings for PushSecret operations.
  2030. Only applies to Vault KV v2 stores. When enabled, write operations must include
  2031. the current version of the secret to prevent unintentional overwrites.
  2032. properties:
  2033. required:
  2034. description: |-
  2035. Required when true, all write operations must include a check-and-set parameter.
  2036. This helps prevent unintentional overwrites of secrets.
  2037. type: boolean
  2038. type: object
  2039. forwardInconsistent:
  2040. description: |-
  2041. ForwardInconsistent tells Vault to forward read-after-write requests to the Vault
  2042. leader instead of simply retrying within a loop. This can increase performance if
  2043. the option is enabled serverside.
  2044. https://www.vaultproject.io/docs/configuration/replication#allow_forwarding_via_header
  2045. type: boolean
  2046. headers:
  2047. additionalProperties:
  2048. type: string
  2049. description: Headers to be added in Vault request
  2050. type: object
  2051. namespace:
  2052. description: |-
  2053. Name of the vault namespace. Namespaces is a set of features within Vault Enterprise that allows
  2054. Vault environments to support Secure Multi-tenancy. e.g: "ns1".
  2055. More about namespaces can be found here https://www.vaultproject.io/docs/enterprise/namespaces
  2056. type: string
  2057. path:
  2058. description: |-
  2059. Path is the mount path of the Vault KV backend endpoint, e.g:
  2060. "secret". The v2 KV secret engine version specific "/data" path suffix
  2061. for fetching secrets from Vault is optional and will be appended
  2062. if not present in specified path.
  2063. type: string
  2064. readYourWrites:
  2065. description: |-
  2066. ReadYourWrites ensures isolated read-after-write semantics by
  2067. providing discovered cluster replication states in each request.
  2068. More information about eventual consistency in Vault can be found here
  2069. https://www.vaultproject.io/docs/enterprise/consistency
  2070. type: boolean
  2071. server:
  2072. description: 'Server is the connection address for the
  2073. Vault server, e.g: "https://vault.example.com:8200".'
  2074. type: string
  2075. tls:
  2076. description: |-
  2077. The configuration used for client side related TLS communication, when the Vault server
  2078. requires mutual authentication. Only used if the Server URL is using HTTPS protocol.
  2079. This parameter is ignored for plain HTTP protocol connection.
  2080. It's worth noting this configuration is different from the "TLS certificates auth method",
  2081. which is available under the `auth.cert` section.
  2082. properties:
  2083. certSecretRef:
  2084. description: |-
  2085. CertSecretRef is a certificate added to the transport layer
  2086. when communicating with the Vault server.
  2087. If no key for the Secret is specified, external-secret will default to 'tls.crt'.
  2088. properties:
  2089. key:
  2090. description: |-
  2091. A key in the referenced Secret.
  2092. Some instances of this field may be defaulted, in others it may be required.
  2093. maxLength: 253
  2094. minLength: 1
  2095. pattern: ^[-._a-zA-Z0-9]+$
  2096. type: string
  2097. name:
  2098. description: The name of the Secret resource being
  2099. referred to.
  2100. maxLength: 253
  2101. minLength: 1
  2102. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  2103. type: string
  2104. namespace:
  2105. description: |-
  2106. The namespace of the Secret resource being referred to.
  2107. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
  2108. maxLength: 63
  2109. minLength: 1
  2110. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  2111. type: string
  2112. type: object
  2113. keySecretRef:
  2114. description: |-
  2115. KeySecretRef to a key in a Secret resource containing client private key
  2116. added to the transport layer when communicating with the Vault server.
  2117. If no key for the Secret is specified, external-secret will default to 'tls.key'.
  2118. properties:
  2119. key:
  2120. description: |-
  2121. A key in the referenced Secret.
  2122. Some instances of this field may be defaulted, in others it may be required.
  2123. maxLength: 253
  2124. minLength: 1
  2125. pattern: ^[-._a-zA-Z0-9]+$
  2126. type: string
  2127. name:
  2128. description: The name of the Secret resource being
  2129. referred to.
  2130. maxLength: 253
  2131. minLength: 1
  2132. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  2133. type: string
  2134. namespace:
  2135. description: |-
  2136. The namespace of the Secret resource being referred to.
  2137. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
  2138. maxLength: 63
  2139. minLength: 1
  2140. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  2141. type: string
  2142. type: object
  2143. type: object
  2144. version:
  2145. default: v2
  2146. description: |-
  2147. Version is the Vault KV secret engine version. This can be either "v1" or
  2148. "v2". Version defaults to "v2".
  2149. enum:
  2150. - v1
  2151. - v2
  2152. type: string
  2153. required:
  2154. - server
  2155. type: object
  2156. resultType:
  2157. default: Data
  2158. description: |-
  2159. Result type defines which data is returned from the generator.
  2160. By default, it is the "data" section of the Vault API response.
  2161. When using e.g. /auth/token/create the "data" section is empty but
  2162. the "auth" section contains the generated token.
  2163. Please refer to the vault docs regarding the result data structure.
  2164. Additionally, accessing the raw response is possibly by using "Raw" result type.
  2165. enum:
  2166. - Data
  2167. - Auth
  2168. - Raw
  2169. type: string
  2170. retrySettings:
  2171. description: Used to configure http retries if failed
  2172. properties:
  2173. maxRetries:
  2174. format: int32
  2175. type: integer
  2176. retryInterval:
  2177. type: string
  2178. type: object
  2179. required:
  2180. - path
  2181. - provider
  2182. type: object
  2183. webhookSpec:
  2184. description: WebhookSpec controls the behavior of the external
  2185. generator. Any body parameters should be passed to the server
  2186. through the parameters field.
  2187. properties:
  2188. auth:
  2189. description: Auth specifies a authorization protocol. Only
  2190. one protocol may be set.
  2191. maxProperties: 1
  2192. minProperties: 1
  2193. properties:
  2194. ntlm:
  2195. description: NTLMProtocol configures the store to use
  2196. NTLM for auth
  2197. properties:
  2198. passwordSecret:
  2199. description: |-
  2200. SecretKeySelector is a reference to a specific 'key' within a Secret resource.
  2201. In some instances, `key` is a required field.
  2202. properties:
  2203. key:
  2204. description: |-
  2205. A key in the referenced Secret.
  2206. Some instances of this field may be defaulted, in others it may be required.
  2207. maxLength: 253
  2208. minLength: 1
  2209. pattern: ^[-._a-zA-Z0-9]+$
  2210. type: string
  2211. name:
  2212. description: The name of the Secret resource being
  2213. referred to.
  2214. maxLength: 253
  2215. minLength: 1
  2216. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  2217. type: string
  2218. namespace:
  2219. description: |-
  2220. The namespace of the Secret resource being referred to.
  2221. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
  2222. maxLength: 63
  2223. minLength: 1
  2224. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  2225. type: string
  2226. type: object
  2227. usernameSecret:
  2228. description: |-
  2229. SecretKeySelector is a reference to a specific 'key' within a Secret resource.
  2230. In some instances, `key` is a required field.
  2231. properties:
  2232. key:
  2233. description: |-
  2234. A key in the referenced Secret.
  2235. Some instances of this field may be defaulted, in others it may be required.
  2236. maxLength: 253
  2237. minLength: 1
  2238. pattern: ^[-._a-zA-Z0-9]+$
  2239. type: string
  2240. name:
  2241. description: The name of the Secret resource being
  2242. referred to.
  2243. maxLength: 253
  2244. minLength: 1
  2245. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  2246. type: string
  2247. namespace:
  2248. description: |-
  2249. The namespace of the Secret resource being referred to.
  2250. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
  2251. maxLength: 63
  2252. minLength: 1
  2253. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  2254. type: string
  2255. type: object
  2256. required:
  2257. - passwordSecret
  2258. - usernameSecret
  2259. type: object
  2260. type: object
  2261. body:
  2262. description: Body
  2263. type: string
  2264. caBundle:
  2265. description: |-
  2266. PEM encoded CA bundle used to validate webhook server certificate. Only used
  2267. if the Server URL is using HTTPS protocol. This parameter is ignored for
  2268. plain HTTP protocol connection. If not set the system root certificates
  2269. are used to validate the TLS connection.
  2270. format: byte
  2271. type: string
  2272. caProvider:
  2273. description: The provider for the CA bundle to use to validate
  2274. webhook server certificate.
  2275. properties:
  2276. key:
  2277. description: The key where the CA certificate can be found
  2278. in the Secret or ConfigMap.
  2279. maxLength: 253
  2280. minLength: 1
  2281. pattern: ^[-._a-zA-Z0-9]+$
  2282. type: string
  2283. name:
  2284. description: The name of the object located at the provider
  2285. type.
  2286. maxLength: 253
  2287. minLength: 1
  2288. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  2289. type: string
  2290. namespace:
  2291. description: The namespace the Provider type is in.
  2292. maxLength: 63
  2293. minLength: 1
  2294. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
  2295. type: string
  2296. type:
  2297. description: The type of provider to use such as "Secret",
  2298. or "ConfigMap".
  2299. enum:
  2300. - Secret
  2301. - ConfigMap
  2302. type: string
  2303. required:
  2304. - name
  2305. - type
  2306. type: object
  2307. headers:
  2308. additionalProperties:
  2309. type: string
  2310. description: Headers
  2311. type: object
  2312. method:
  2313. description: Webhook Method
  2314. type: string
  2315. result:
  2316. description: Result formatting
  2317. properties:
  2318. jsonPath:
  2319. description: Json path of return value
  2320. type: string
  2321. type: object
  2322. secrets:
  2323. description: |-
  2324. Secrets to fill in templates
  2325. These secrets will be passed to the templating function as key value pairs under the given name
  2326. items:
  2327. description: WebhookSecret defines a secret reference that
  2328. will be used in webhook templates.
  2329. properties:
  2330. name:
  2331. description: Name of this secret in templates
  2332. type: string
  2333. secretRef:
  2334. description: Secret ref to fill in credentials
  2335. properties:
  2336. key:
  2337. description: The key where the token is found.
  2338. maxLength: 253
  2339. minLength: 1
  2340. pattern: ^[-._a-zA-Z0-9]+$
  2341. type: string
  2342. name:
  2343. description: The name of the Secret resource being
  2344. referred to.
  2345. maxLength: 253
  2346. minLength: 1
  2347. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  2348. type: string
  2349. type: object
  2350. required:
  2351. - name
  2352. - secretRef
  2353. type: object
  2354. type: array
  2355. timeout:
  2356. description: Timeout
  2357. type: string
  2358. url:
  2359. description: Webhook url to call
  2360. type: string
  2361. required:
  2362. - result
  2363. - url
  2364. type: object
  2365. type: object
  2366. kind:
  2367. description: Kind the kind of this generator.
  2368. enum:
  2369. - ACRAccessToken
  2370. - CloudsmithAccessToken
  2371. - ECRAuthorizationToken
  2372. - Fake
  2373. - GCRAccessToken
  2374. - GithubAccessToken
  2375. - QuayAccessToken
  2376. - Password
  2377. - SSHKey
  2378. - STSSessionToken
  2379. - UUID
  2380. - VaultDynamicSecret
  2381. - Webhook
  2382. - Grafana
  2383. type: string
  2384. required:
  2385. - generator
  2386. - kind
  2387. type: object
  2388. type: object
  2389. served: true
  2390. storage: true
  2391. subresources:
  2392. status: {}