generators.external-secrets.io_clustergenerators.yaml 139 KB

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