generators.external-secrets.io_clustergenerators.yaml 140 KB

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