external-secrets.io_secretstores.yaml 151 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809
  1. apiVersion: apiextensions.k8s.io/v1
  2. kind: CustomResourceDefinition
  3. metadata:
  4. annotations:
  5. controller-gen.kubebuilder.io/version: v0.8.0
  6. creationTimestamp: null
  7. name: secretstores.external-secrets.io
  8. spec:
  9. group: external-secrets.io
  10. names:
  11. categories:
  12. - externalsecrets
  13. kind: SecretStore
  14. listKind: SecretStoreList
  15. plural: secretstores
  16. shortNames:
  17. - ss
  18. singular: secretstore
  19. scope: Namespaced
  20. versions:
  21. - additionalPrinterColumns:
  22. - jsonPath: .metadata.creationTimestamp
  23. name: AGE
  24. type: date
  25. - jsonPath: .status.conditions[?(@.type=="Ready")].reason
  26. name: Status
  27. type: string
  28. deprecated: true
  29. name: v1alpha1
  30. schema:
  31. openAPIV3Schema:
  32. description: SecretStore represents a secure external location for storing
  33. secrets, which can be referenced as part of `storeRef` fields.
  34. properties:
  35. apiVersion:
  36. description: 'APIVersion defines the versioned schema of this representation
  37. of an object. Servers should convert recognized schemas to the latest
  38. internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
  39. type: string
  40. kind:
  41. description: 'Kind is a string value representing the REST resource this
  42. object represents. Servers may infer this from the endpoint the client
  43. submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
  44. type: string
  45. metadata:
  46. type: object
  47. spec:
  48. description: SecretStoreSpec defines the desired state of SecretStore.
  49. properties:
  50. controller:
  51. description: 'Used to select the correct KES controller (think: ingress.ingressClassName)
  52. The KES controller is instantiated with a specific controller name
  53. and filters ES based on this property'
  54. type: string
  55. provider:
  56. description: Used to configure the provider. Only one provider may
  57. be set
  58. maxProperties: 1
  59. minProperties: 1
  60. properties:
  61. akeyless:
  62. description: Akeyless configures this store to sync secrets using
  63. Akeyless Vault provider
  64. properties:
  65. akeylessGWApiURL:
  66. description: Akeyless GW API Url from which the secrets to
  67. be fetched from.
  68. type: string
  69. authSecretRef:
  70. description: Auth configures how the operator authenticates
  71. with Akeyless.
  72. properties:
  73. secretRef:
  74. description: 'AkeylessAuthSecretRef AKEYLESS_ACCESS_TYPE_PARAM:
  75. AZURE_OBJ_ID OR GCP_AUDIENCE OR ACCESS_KEY OR KUB_CONFIG_NAME.'
  76. properties:
  77. accessID:
  78. description: The SecretAccessID is used for authentication
  79. properties:
  80. key:
  81. description: The key of the entry in the Secret
  82. resource's `data` field to be used. Some instances
  83. of this field may be defaulted, in others it
  84. may be required.
  85. type: string
  86. name:
  87. description: The name of the Secret resource being
  88. referred to.
  89. type: string
  90. namespace:
  91. description: Namespace of the resource being referred
  92. to. Ignored if referent is not cluster-scoped.
  93. cluster-scoped defaults to the namespace of
  94. the referent.
  95. type: string
  96. type: object
  97. accessType:
  98. description: A reference to a specific 'key' within
  99. a Secret resource, In some instances, `key` is a
  100. required field.
  101. properties:
  102. key:
  103. description: The key of the entry in the Secret
  104. resource's `data` field to be used. Some instances
  105. of this field may be defaulted, in others it
  106. may be required.
  107. type: string
  108. name:
  109. description: The name of the Secret resource being
  110. referred to.
  111. type: string
  112. namespace:
  113. description: Namespace of the resource being referred
  114. to. Ignored if referent is not cluster-scoped.
  115. cluster-scoped defaults to the namespace of
  116. the referent.
  117. type: string
  118. type: object
  119. accessTypeParam:
  120. description: A reference to a specific 'key' within
  121. a Secret resource, In some instances, `key` is a
  122. required field.
  123. properties:
  124. key:
  125. description: The key of the entry in the Secret
  126. resource's `data` field to be used. Some instances
  127. of this field may be defaulted, in others it
  128. may be required.
  129. type: string
  130. name:
  131. description: The name of the Secret resource being
  132. referred to.
  133. type: string
  134. namespace:
  135. description: Namespace of the resource being referred
  136. to. Ignored if referent is not cluster-scoped.
  137. cluster-scoped defaults to the namespace of
  138. the referent.
  139. type: string
  140. type: object
  141. type: object
  142. required:
  143. - secretRef
  144. type: object
  145. required:
  146. - akeylessGWApiURL
  147. - authSecretRef
  148. type: object
  149. alibaba:
  150. description: Alibaba configures this store to sync secrets using
  151. Alibaba Cloud provider
  152. properties:
  153. auth:
  154. description: AlibabaAuth contains a secretRef for credentials.
  155. properties:
  156. secretRef:
  157. description: AlibabaAuthSecretRef holds secret references
  158. for Alibaba credentials.
  159. properties:
  160. accessKeyIDSecretRef:
  161. description: The AccessKeyID is used for authentication
  162. properties:
  163. key:
  164. description: The key of the entry in the Secret
  165. resource's `data` field to be used. Some instances
  166. of this field may be defaulted, in others it
  167. may be required.
  168. type: string
  169. name:
  170. description: The name of the Secret resource being
  171. referred to.
  172. type: string
  173. namespace:
  174. description: Namespace of the resource being referred
  175. to. Ignored if referent is not cluster-scoped.
  176. cluster-scoped defaults to the namespace of
  177. the referent.
  178. type: string
  179. type: object
  180. accessKeySecretSecretRef:
  181. description: The AccessKeySecret is used for authentication
  182. properties:
  183. key:
  184. description: The key of the entry in the Secret
  185. resource's `data` field to be used. Some instances
  186. of this field may be defaulted, in others it
  187. may be required.
  188. type: string
  189. name:
  190. description: The name of the Secret resource being
  191. referred to.
  192. type: string
  193. namespace:
  194. description: Namespace of the resource being referred
  195. to. Ignored if referent is not cluster-scoped.
  196. cluster-scoped defaults to the namespace of
  197. the referent.
  198. type: string
  199. type: object
  200. required:
  201. - accessKeyIDSecretRef
  202. - accessKeySecretSecretRef
  203. type: object
  204. required:
  205. - secretRef
  206. type: object
  207. endpoint:
  208. type: string
  209. regionID:
  210. description: Alibaba Region to be used for the provider
  211. type: string
  212. required:
  213. - auth
  214. - regionID
  215. type: object
  216. aws:
  217. description: AWS configures this store to sync secrets using AWS
  218. Secret Manager provider
  219. properties:
  220. auth:
  221. description: 'Auth defines the information necessary to authenticate
  222. against AWS if not set aws sdk will infer credentials from
  223. your environment see: https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials'
  224. properties:
  225. jwt:
  226. description: Authenticate against AWS using service account
  227. tokens.
  228. properties:
  229. serviceAccountRef:
  230. description: A reference to a ServiceAccount resource.
  231. properties:
  232. name:
  233. description: The name of the ServiceAccount resource
  234. being referred to.
  235. type: string
  236. namespace:
  237. description: Namespace of the resource being referred
  238. to. Ignored if referent is not cluster-scoped.
  239. cluster-scoped defaults to the namespace of
  240. the referent.
  241. type: string
  242. required:
  243. - name
  244. type: object
  245. type: object
  246. secretRef:
  247. description: AWSAuthSecretRef holds secret references
  248. for AWS credentials both AccessKeyID and SecretAccessKey
  249. must be defined in order to properly authenticate.
  250. properties:
  251. accessKeyIDSecretRef:
  252. description: The AccessKeyID is used for authentication
  253. properties:
  254. key:
  255. description: The key of the entry in the Secret
  256. resource's `data` field to be used. Some instances
  257. of this field may be defaulted, in others it
  258. may be required.
  259. type: string
  260. name:
  261. description: The name of the Secret resource being
  262. referred to.
  263. type: string
  264. namespace:
  265. description: Namespace of the resource being referred
  266. to. Ignored if referent is not cluster-scoped.
  267. cluster-scoped defaults to the namespace of
  268. the referent.
  269. type: string
  270. type: object
  271. secretAccessKeySecretRef:
  272. description: The SecretAccessKey is used for authentication
  273. properties:
  274. key:
  275. description: The key of the entry in the Secret
  276. resource's `data` field to be used. Some instances
  277. of this field may be defaulted, in others it
  278. may be required.
  279. type: string
  280. name:
  281. description: The name of the Secret resource being
  282. referred to.
  283. type: string
  284. namespace:
  285. description: Namespace of the resource being referred
  286. to. Ignored if referent is not cluster-scoped.
  287. cluster-scoped defaults to the namespace of
  288. the referent.
  289. type: string
  290. type: object
  291. type: object
  292. type: object
  293. region:
  294. description: AWS Region to be used for the provider
  295. type: string
  296. role:
  297. description: Role is a Role ARN which the SecretManager provider
  298. will assume
  299. type: string
  300. service:
  301. description: Service defines which service should be used
  302. to fetch the secrets
  303. enum:
  304. - SecretsManager
  305. - ParameterStore
  306. type: string
  307. required:
  308. - region
  309. - service
  310. type: object
  311. azurekv:
  312. description: AzureKV configures this store to sync secrets using
  313. Azure Key Vault provider
  314. properties:
  315. authSecretRef:
  316. description: Auth configures how the operator authenticates
  317. with Azure. Required for ServicePrincipal auth type.
  318. properties:
  319. clientId:
  320. description: The Azure clientId of the service principle
  321. used for authentication.
  322. properties:
  323. key:
  324. description: The key of the entry in the Secret resource's
  325. `data` field to be used. Some instances of this
  326. field may be defaulted, in others it may be required.
  327. type: string
  328. name:
  329. description: The name of the Secret resource being
  330. referred to.
  331. type: string
  332. namespace:
  333. description: Namespace of the resource being referred
  334. to. Ignored if referent is not cluster-scoped. cluster-scoped
  335. defaults to the namespace of the referent.
  336. type: string
  337. type: object
  338. clientSecret:
  339. description: The Azure ClientSecret of the service principle
  340. used for authentication.
  341. properties:
  342. key:
  343. description: The key of the entry in the Secret resource's
  344. `data` field to be used. Some instances of this
  345. field may be defaulted, in others it may be required.
  346. type: string
  347. name:
  348. description: The name of the Secret resource being
  349. referred to.
  350. type: string
  351. namespace:
  352. description: Namespace of the resource being referred
  353. to. Ignored if referent is not cluster-scoped. cluster-scoped
  354. defaults to the namespace of the referent.
  355. type: string
  356. type: object
  357. type: object
  358. authType:
  359. default: ServicePrincipal
  360. description: 'Auth type defines how to authenticate to the
  361. keyvault service. Valid values are: - "ServicePrincipal"
  362. (default): Using a service principal (tenantId, clientId,
  363. clientSecret) - "ManagedIdentity": Using Managed Identity
  364. assigned to the pod (see aad-pod-identity)'
  365. enum:
  366. - ServicePrincipal
  367. - ManagedIdentity
  368. - WorkloadIdentity
  369. type: string
  370. identityId:
  371. description: If multiple Managed Identity is assigned to the
  372. pod, you can select the one to be used
  373. type: string
  374. serviceAccountRef:
  375. description: ServiceAccountRef specified the service account
  376. that should be used when authenticating with WorkloadIdentity.
  377. properties:
  378. name:
  379. description: The name of the ServiceAccount resource being
  380. referred to.
  381. type: string
  382. namespace:
  383. description: Namespace of the resource being referred
  384. to. Ignored if referent is not cluster-scoped. cluster-scoped
  385. defaults to the namespace of the referent.
  386. type: string
  387. required:
  388. - name
  389. type: object
  390. tenantId:
  391. description: TenantID configures the Azure Tenant to send
  392. requests to. Required for ServicePrincipal auth type.
  393. type: string
  394. vaultUrl:
  395. description: Vault Url from which the secrets to be fetched
  396. from.
  397. type: string
  398. required:
  399. - vaultUrl
  400. type: object
  401. fake:
  402. description: Fake configures a store with static key/value pairs
  403. properties:
  404. data:
  405. items:
  406. properties:
  407. key:
  408. type: string
  409. value:
  410. type: string
  411. valueMap:
  412. additionalProperties:
  413. type: string
  414. type: object
  415. version:
  416. type: string
  417. required:
  418. - key
  419. type: object
  420. type: array
  421. required:
  422. - data
  423. type: object
  424. gcpsm:
  425. description: GCPSM configures this store to sync secrets using
  426. Google Cloud Platform Secret Manager provider
  427. properties:
  428. auth:
  429. description: Auth defines the information necessary to authenticate
  430. against GCP
  431. properties:
  432. secretRef:
  433. properties:
  434. secretAccessKeySecretRef:
  435. description: The SecretAccessKey is used for authentication
  436. properties:
  437. key:
  438. description: The key of the entry in the Secret
  439. resource's `data` field to be used. Some instances
  440. of this field may be defaulted, in others it
  441. may be required.
  442. type: string
  443. name:
  444. description: The name of the Secret resource being
  445. referred to.
  446. type: string
  447. namespace:
  448. description: Namespace of the resource being referred
  449. to. Ignored if referent is not cluster-scoped.
  450. cluster-scoped defaults to the namespace of
  451. the referent.
  452. type: string
  453. type: object
  454. type: object
  455. workloadIdentity:
  456. properties:
  457. clusterLocation:
  458. type: string
  459. clusterName:
  460. type: string
  461. clusterProjectID:
  462. type: string
  463. serviceAccountRef:
  464. description: A reference to a ServiceAccount resource.
  465. properties:
  466. name:
  467. description: The name of the ServiceAccount resource
  468. being referred to.
  469. type: string
  470. namespace:
  471. description: Namespace of the resource being referred
  472. to. Ignored if referent is not cluster-scoped.
  473. cluster-scoped defaults to the namespace of
  474. the referent.
  475. type: string
  476. required:
  477. - name
  478. type: object
  479. required:
  480. - clusterLocation
  481. - clusterName
  482. - serviceAccountRef
  483. type: object
  484. type: object
  485. projectID:
  486. description: ProjectID project where secret is located
  487. type: string
  488. type: object
  489. gitlab:
  490. description: Gitlab configures this store to sync secrets using
  491. Gitlab Variables provider
  492. properties:
  493. auth:
  494. description: Auth configures how secret-manager authenticates
  495. with a GitLab instance.
  496. properties:
  497. SecretRef:
  498. properties:
  499. accessToken:
  500. description: AccessToken is used for authentication.
  501. properties:
  502. key:
  503. description: The key of the entry in the Secret
  504. resource's `data` field to be used. Some instances
  505. of this field may be defaulted, in others it
  506. may be required.
  507. type: string
  508. name:
  509. description: The name of the Secret resource being
  510. referred to.
  511. type: string
  512. namespace:
  513. description: Namespace of the resource being referred
  514. to. Ignored if referent is not cluster-scoped.
  515. cluster-scoped defaults to the namespace of
  516. the referent.
  517. type: string
  518. type: object
  519. type: object
  520. required:
  521. - SecretRef
  522. type: object
  523. projectID:
  524. description: ProjectID specifies a project where secrets are
  525. located.
  526. type: string
  527. url:
  528. description: URL configures the GitLab instance URL. Defaults
  529. to https://gitlab.com/.
  530. type: string
  531. required:
  532. - auth
  533. type: object
  534. ibm:
  535. description: IBM configures this store to sync secrets using IBM
  536. Cloud provider
  537. properties:
  538. auth:
  539. description: Auth configures how secret-manager authenticates
  540. with the IBM secrets manager.
  541. properties:
  542. secretRef:
  543. properties:
  544. secretApiKeySecretRef:
  545. description: The SecretAccessKey is used for authentication
  546. properties:
  547. key:
  548. description: The key of the entry in the Secret
  549. resource's `data` field to be used. Some instances
  550. of this field may be defaulted, in others it
  551. may be required.
  552. type: string
  553. name:
  554. description: The name of the Secret resource being
  555. referred to.
  556. type: string
  557. namespace:
  558. description: Namespace of the resource being referred
  559. to. Ignored if referent is not cluster-scoped.
  560. cluster-scoped defaults to the namespace of
  561. the referent.
  562. type: string
  563. type: object
  564. type: object
  565. required:
  566. - secretRef
  567. type: object
  568. serviceUrl:
  569. description: ServiceURL is the Endpoint URL that is specific
  570. to the Secrets Manager service instance
  571. type: string
  572. required:
  573. - auth
  574. type: object
  575. kubernetes:
  576. description: Kubernetes configures this store to sync secrets
  577. using a Kubernetes cluster provider
  578. properties:
  579. auth:
  580. description: Auth configures how secret-manager authenticates
  581. with a Kubernetes instance.
  582. maxProperties: 1
  583. minProperties: 1
  584. properties:
  585. cert:
  586. description: has both clientCert and clientKey as secretKeySelector
  587. properties:
  588. clientCert:
  589. description: A reference to a specific 'key' within
  590. a Secret resource, In some instances, `key` is a
  591. required field.
  592. properties:
  593. key:
  594. description: The key of the entry in the Secret
  595. resource's `data` field to be used. Some instances
  596. of this field may be defaulted, in others it
  597. may be required.
  598. type: string
  599. name:
  600. description: The name of the Secret resource being
  601. referred to.
  602. type: string
  603. namespace:
  604. description: Namespace of the resource being referred
  605. to. Ignored if referent is not cluster-scoped.
  606. cluster-scoped defaults to the namespace of
  607. the referent.
  608. type: string
  609. type: object
  610. clientKey:
  611. description: A reference to a specific 'key' within
  612. a Secret resource, In some instances, `key` is a
  613. required field.
  614. properties:
  615. key:
  616. description: The key of the entry in the Secret
  617. resource's `data` field to be used. Some instances
  618. of this field may be defaulted, in others it
  619. may be required.
  620. type: string
  621. name:
  622. description: The name of the Secret resource being
  623. referred to.
  624. type: string
  625. namespace:
  626. description: Namespace of the resource being referred
  627. to. Ignored if referent is not cluster-scoped.
  628. cluster-scoped defaults to the namespace of
  629. the referent.
  630. type: string
  631. type: object
  632. type: object
  633. serviceAccount:
  634. description: points to a service account that should be
  635. used for authentication
  636. properties:
  637. serviceAccount:
  638. description: A reference to a ServiceAccount resource.
  639. properties:
  640. name:
  641. description: The name of the ServiceAccount resource
  642. being referred to.
  643. type: string
  644. namespace:
  645. description: Namespace of the resource being referred
  646. to. Ignored if referent is not cluster-scoped.
  647. cluster-scoped defaults to the namespace of
  648. the referent.
  649. type: string
  650. required:
  651. - name
  652. type: object
  653. type: object
  654. token:
  655. description: use static token to authenticate with
  656. properties:
  657. bearerToken:
  658. description: A reference to a specific 'key' within
  659. a Secret resource, In some instances, `key` is a
  660. required field.
  661. properties:
  662. key:
  663. description: The key of the entry in the Secret
  664. resource's `data` field to be used. Some instances
  665. of this field may be defaulted, in others it
  666. may be required.
  667. type: string
  668. name:
  669. description: The name of the Secret resource being
  670. referred to.
  671. type: string
  672. namespace:
  673. description: Namespace of the resource being referred
  674. to. Ignored if referent is not cluster-scoped.
  675. cluster-scoped defaults to the namespace of
  676. the referent.
  677. type: string
  678. type: object
  679. type: object
  680. type: object
  681. remoteNamespace:
  682. default: default
  683. description: Remote namespace to fetch the secrets from
  684. type: string
  685. server:
  686. description: configures the Kubernetes server Address.
  687. properties:
  688. caBundle:
  689. description: CABundle is a base64-encoded CA certificate
  690. format: byte
  691. type: string
  692. caProvider:
  693. description: 'see: https://external-secrets.io/v0.4.1/spec/#external-secrets.io/v1alpha1.CAProvider'
  694. properties:
  695. key:
  696. description: The key the value inside of the provider
  697. type to use, only used with "Secret" type
  698. type: string
  699. name:
  700. description: The name of the object located at the
  701. provider type.
  702. type: string
  703. namespace:
  704. description: The namespace the Provider type is in.
  705. type: string
  706. type:
  707. description: The type of provider to use such as "Secret",
  708. or "ConfigMap".
  709. enum:
  710. - Secret
  711. - ConfigMap
  712. type: string
  713. required:
  714. - name
  715. - type
  716. type: object
  717. url:
  718. default: kubernetes.default
  719. description: configures the Kubernetes server Address.
  720. type: string
  721. type: object
  722. required:
  723. - auth
  724. type: object
  725. oracle:
  726. description: Oracle configures this store to sync secrets using
  727. Oracle Vault provider
  728. properties:
  729. auth:
  730. description: Auth configures how secret-manager authenticates
  731. with the Oracle Vault. If empty, use the instance principal,
  732. otherwise the user credentials specified in Auth.
  733. properties:
  734. secretRef:
  735. description: SecretRef to pass through sensitive information.
  736. properties:
  737. fingerprint:
  738. description: Fingerprint is the fingerprint of the
  739. API private key.
  740. properties:
  741. key:
  742. description: The key of the entry in the Secret
  743. resource's `data` field to be used. Some instances
  744. of this field may be defaulted, in others it
  745. may be required.
  746. type: string
  747. name:
  748. description: The name of the Secret resource being
  749. referred to.
  750. type: string
  751. namespace:
  752. description: Namespace of the resource being referred
  753. to. Ignored if referent is not cluster-scoped.
  754. cluster-scoped defaults to the namespace of
  755. the referent.
  756. type: string
  757. type: object
  758. privatekey:
  759. description: PrivateKey is the user's API Signing
  760. Key in PEM format, used for authentication.
  761. properties:
  762. key:
  763. description: The key of the entry in the Secret
  764. resource's `data` field to be used. Some instances
  765. of this field may be defaulted, in others it
  766. may be required.
  767. type: string
  768. name:
  769. description: The name of the Secret resource being
  770. referred to.
  771. type: string
  772. namespace:
  773. description: Namespace of the resource being referred
  774. to. Ignored if referent is not cluster-scoped.
  775. cluster-scoped defaults to the namespace of
  776. the referent.
  777. type: string
  778. type: object
  779. required:
  780. - fingerprint
  781. - privatekey
  782. type: object
  783. tenancy:
  784. description: Tenancy is the tenancy OCID where user is
  785. located.
  786. type: string
  787. user:
  788. description: User is an access OCID specific to the account.
  789. type: string
  790. required:
  791. - secretRef
  792. - tenancy
  793. - user
  794. type: object
  795. region:
  796. description: Region is the region where vault is located.
  797. type: string
  798. vault:
  799. description: Vault is the vault's OCID of the specific vault
  800. where secret is located.
  801. type: string
  802. required:
  803. - region
  804. - vault
  805. type: object
  806. vault:
  807. description: Vault configures this store to sync secrets using
  808. Hashi provider
  809. properties:
  810. auth:
  811. description: Auth configures how secret-manager authenticates
  812. with the Vault server.
  813. properties:
  814. appRole:
  815. description: AppRole authenticates with Vault using the
  816. App Role auth mechanism, with the role and secret stored
  817. in a Kubernetes Secret resource.
  818. properties:
  819. path:
  820. default: approle
  821. description: 'Path where the App Role authentication
  822. backend is mounted in Vault, e.g: "approle"'
  823. type: string
  824. roleId:
  825. description: RoleID configured in the App Role authentication
  826. backend when setting up the authentication backend
  827. in Vault.
  828. type: string
  829. secretRef:
  830. description: Reference to a key in a Secret that contains
  831. the App Role secret used to authenticate with Vault.
  832. The `key` field must be specified and denotes which
  833. entry within the Secret resource is used as the
  834. app role secret.
  835. properties:
  836. key:
  837. description: The key of the entry in the Secret
  838. resource's `data` field to be used. Some instances
  839. of this field may be defaulted, in others it
  840. may be required.
  841. type: string
  842. name:
  843. description: The name of the Secret resource being
  844. referred to.
  845. type: string
  846. namespace:
  847. description: Namespace of the resource being referred
  848. to. Ignored if referent is not cluster-scoped.
  849. cluster-scoped defaults to the namespace of
  850. the referent.
  851. type: string
  852. type: object
  853. required:
  854. - path
  855. - roleId
  856. - secretRef
  857. type: object
  858. cert:
  859. description: Cert authenticates with TLS Certificates
  860. by passing client certificate, private key and ca certificate
  861. Cert authentication method
  862. properties:
  863. clientCert:
  864. description: ClientCert is a certificate to authenticate
  865. using the Cert Vault authentication method
  866. properties:
  867. key:
  868. description: The key of the entry in the Secret
  869. resource's `data` field to be used. Some instances
  870. of this field may be defaulted, in others it
  871. may be required.
  872. type: string
  873. name:
  874. description: The name of the Secret resource being
  875. referred to.
  876. type: string
  877. namespace:
  878. description: Namespace of the resource being referred
  879. to. Ignored if referent is not cluster-scoped.
  880. cluster-scoped defaults to the namespace of
  881. the referent.
  882. type: string
  883. type: object
  884. secretRef:
  885. description: SecretRef to a key in a Secret resource
  886. containing client private key to authenticate with
  887. Vault using the Cert authentication method
  888. properties:
  889. key:
  890. description: The key of the entry in the Secret
  891. resource's `data` field to be used. Some instances
  892. of this field may be defaulted, in others it
  893. may be required.
  894. type: string
  895. name:
  896. description: The name of the Secret resource being
  897. referred to.
  898. type: string
  899. namespace:
  900. description: Namespace of the resource being referred
  901. to. Ignored if referent is not cluster-scoped.
  902. cluster-scoped defaults to the namespace of
  903. the referent.
  904. type: string
  905. type: object
  906. type: object
  907. jwt:
  908. description: Jwt authenticates with Vault by passing role
  909. and JWT token using the JWT/OIDC authentication method
  910. properties:
  911. kubernetesServiceAccountToken:
  912. description: Optional ServiceAccountToken specifies
  913. the Kubernetes service account for which to request
  914. a token for with the `TokenRequest` API.
  915. properties:
  916. audiences:
  917. description: Optional audiences field that will
  918. be used to request a temporary Kubernetes service
  919. account token for the service account referenced
  920. by `serviceAccountRef`. Defaults to a single
  921. audience `vault` it not specified.
  922. items:
  923. type: string
  924. type: array
  925. expirationSeconds:
  926. description: Optional expiration time in seconds
  927. that will be used to request a temporary Kubernetes
  928. service account token for the service account
  929. referenced by `serviceAccountRef`. Defaults
  930. to 10 minutes.
  931. format: int64
  932. type: integer
  933. serviceAccountRef:
  934. description: Service account field containing
  935. the name of a kubernetes ServiceAccount.
  936. properties:
  937. name:
  938. description: The name of the ServiceAccount
  939. resource being referred to.
  940. type: string
  941. namespace:
  942. description: Namespace of the resource being
  943. referred to. Ignored if referent is not
  944. cluster-scoped. cluster-scoped defaults
  945. to the namespace of the referent.
  946. type: string
  947. required:
  948. - name
  949. type: object
  950. required:
  951. - serviceAccountRef
  952. type: object
  953. path:
  954. default: jwt
  955. description: 'Path where the JWT authentication backend
  956. is mounted in Vault, e.g: "jwt"'
  957. type: string
  958. role:
  959. description: Role is a JWT role to authenticate using
  960. the JWT/OIDC Vault authentication method
  961. type: string
  962. secretRef:
  963. description: Optional SecretRef that refers to a key
  964. in a Secret resource containing JWT token to authenticate
  965. with Vault using the JWT/OIDC authentication method.
  966. properties:
  967. key:
  968. description: The key of the entry in the Secret
  969. resource's `data` field to be used. Some instances
  970. of this field may be defaulted, in others it
  971. may be required.
  972. type: string
  973. name:
  974. description: The name of the Secret resource being
  975. referred to.
  976. type: string
  977. namespace:
  978. description: Namespace of the resource being referred
  979. to. Ignored if referent is not cluster-scoped.
  980. cluster-scoped defaults to the namespace of
  981. the referent.
  982. type: string
  983. type: object
  984. required:
  985. - path
  986. type: object
  987. kubernetes:
  988. description: Kubernetes authenticates with Vault by passing
  989. the ServiceAccount token stored in the named Secret
  990. resource to the Vault server.
  991. properties:
  992. mountPath:
  993. default: kubernetes
  994. description: 'Path where the Kubernetes authentication
  995. backend is mounted in Vault, e.g: "kubernetes"'
  996. type: string
  997. role:
  998. description: A required field containing the Vault
  999. Role to assume. A Role binds a Kubernetes ServiceAccount
  1000. with a set of Vault policies.
  1001. type: string
  1002. secretRef:
  1003. description: Optional secret field containing a Kubernetes
  1004. ServiceAccount JWT used for authenticating with
  1005. Vault. If a name is specified without a key, `token`
  1006. is the default. If one is not specified, the one
  1007. bound to the controller will be used.
  1008. properties:
  1009. key:
  1010. description: The key of the entry in the Secret
  1011. resource's `data` field to be used. Some instances
  1012. of this field may be defaulted, in others it
  1013. may be required.
  1014. type: string
  1015. name:
  1016. description: The name of the Secret resource being
  1017. referred to.
  1018. type: string
  1019. namespace:
  1020. description: Namespace of the resource being referred
  1021. to. Ignored if referent is not cluster-scoped.
  1022. cluster-scoped defaults to the namespace of
  1023. the referent.
  1024. type: string
  1025. type: object
  1026. serviceAccountRef:
  1027. description: Optional service account field containing
  1028. the name of a kubernetes ServiceAccount. If the
  1029. service account is specified, the service account
  1030. secret token JWT will be used for authenticating
  1031. with Vault. If the service account selector is not
  1032. supplied, the secretRef will be used instead.
  1033. properties:
  1034. name:
  1035. description: The name of the ServiceAccount resource
  1036. being referred to.
  1037. type: string
  1038. namespace:
  1039. description: Namespace of the resource being referred
  1040. to. Ignored if referent is not cluster-scoped.
  1041. cluster-scoped defaults to the namespace of
  1042. the referent.
  1043. type: string
  1044. required:
  1045. - name
  1046. type: object
  1047. required:
  1048. - mountPath
  1049. - role
  1050. type: object
  1051. ldap:
  1052. description: Ldap authenticates with Vault by passing
  1053. username/password pair using the LDAP authentication
  1054. method
  1055. properties:
  1056. path:
  1057. default: ldap
  1058. description: 'Path where the LDAP authentication backend
  1059. is mounted in Vault, e.g: "ldap"'
  1060. type: string
  1061. secretRef:
  1062. description: SecretRef to a key in a Secret resource
  1063. containing password for the LDAP user used to authenticate
  1064. with Vault using the LDAP authentication method
  1065. properties:
  1066. key:
  1067. description: The key of the entry in the Secret
  1068. resource's `data` field to be used. Some instances
  1069. of this field may be defaulted, in others it
  1070. may be required.
  1071. type: string
  1072. name:
  1073. description: The name of the Secret resource being
  1074. referred to.
  1075. type: string
  1076. namespace:
  1077. description: Namespace of the resource being referred
  1078. to. Ignored if referent is not cluster-scoped.
  1079. cluster-scoped defaults to the namespace of
  1080. the referent.
  1081. type: string
  1082. type: object
  1083. username:
  1084. description: Username is a LDAP user name used to
  1085. authenticate using the LDAP Vault authentication
  1086. method
  1087. type: string
  1088. required:
  1089. - path
  1090. - username
  1091. type: object
  1092. tokenSecretRef:
  1093. description: TokenSecretRef authenticates with Vault by
  1094. presenting a token.
  1095. properties:
  1096. key:
  1097. description: The key of the entry in the Secret resource's
  1098. `data` field to be used. Some instances of this
  1099. field may be defaulted, in others it may be required.
  1100. type: string
  1101. name:
  1102. description: The name of the Secret resource being
  1103. referred to.
  1104. type: string
  1105. namespace:
  1106. description: Namespace of the resource being referred
  1107. to. Ignored if referent is not cluster-scoped. cluster-scoped
  1108. defaults to the namespace of the referent.
  1109. type: string
  1110. type: object
  1111. type: object
  1112. caBundle:
  1113. description: PEM encoded CA bundle used to validate Vault
  1114. server certificate. Only used if the Server URL is using
  1115. HTTPS protocol. This parameter is ignored for plain HTTP
  1116. protocol connection. If not set the system root certificates
  1117. are used to validate the TLS connection.
  1118. format: byte
  1119. type: string
  1120. caProvider:
  1121. description: The provider for the CA bundle to use to validate
  1122. Vault server certificate.
  1123. properties:
  1124. key:
  1125. description: The key the value inside of the provider
  1126. type to use, only used with "Secret" type
  1127. type: string
  1128. name:
  1129. description: The name of the object located at the provider
  1130. type.
  1131. type: string
  1132. namespace:
  1133. description: The namespace the Provider type is in.
  1134. type: string
  1135. type:
  1136. description: The type of provider to use such as "Secret",
  1137. or "ConfigMap".
  1138. enum:
  1139. - Secret
  1140. - ConfigMap
  1141. type: string
  1142. required:
  1143. - name
  1144. - type
  1145. type: object
  1146. forwardInconsistent:
  1147. description: ForwardInconsistent tells Vault to forward read-after-write
  1148. requests to the Vault leader instead of simply retrying
  1149. within a loop. This can increase performance if the option
  1150. is enabled serverside. https://www.vaultproject.io/docs/configuration/replication#allow_forwarding_via_header
  1151. type: boolean
  1152. namespace:
  1153. description: 'Name of the vault namespace. Namespaces is a
  1154. set of features within Vault Enterprise that allows Vault
  1155. environments to support Secure Multi-tenancy. e.g: "ns1".
  1156. More about namespaces can be found here https://www.vaultproject.io/docs/enterprise/namespaces'
  1157. type: string
  1158. path:
  1159. description: 'Path is the mount path of the Vault KV backend
  1160. endpoint, e.g: "secret". The v2 KV secret engine version
  1161. specific "/data" path suffix for fetching secrets from Vault
  1162. is optional and will be appended if not present in specified
  1163. path.'
  1164. type: string
  1165. readYourWrites:
  1166. description: ReadYourWrites ensures isolated read-after-write
  1167. semantics by providing discovered cluster replication states
  1168. in each request. More information about eventual consistency
  1169. in Vault can be found here https://www.vaultproject.io/docs/enterprise/consistency
  1170. type: boolean
  1171. server:
  1172. description: 'Server is the connection address for the Vault
  1173. server, e.g: "https://vault.example.com:8200".'
  1174. type: string
  1175. version:
  1176. default: v2
  1177. description: Version is the Vault KV secret engine version.
  1178. This can be either "v1" or "v2". Version defaults to "v2".
  1179. enum:
  1180. - v1
  1181. - v2
  1182. type: string
  1183. required:
  1184. - auth
  1185. - server
  1186. type: object
  1187. webhook:
  1188. description: Webhook configures this store to sync secrets using
  1189. a generic templated webhook
  1190. properties:
  1191. body:
  1192. description: Body
  1193. type: string
  1194. caBundle:
  1195. description: PEM encoded CA bundle used to validate webhook
  1196. server certificate. Only used if the Server URL is using
  1197. HTTPS protocol. This parameter is ignored for plain HTTP
  1198. protocol connection. If not set the system root certificates
  1199. are used to validate the TLS connection.
  1200. format: byte
  1201. type: string
  1202. caProvider:
  1203. description: The provider for the CA bundle to use to validate
  1204. webhook server certificate.
  1205. properties:
  1206. key:
  1207. description: The key the value inside of the provider
  1208. type to use, only used with "Secret" type
  1209. type: string
  1210. name:
  1211. description: The name of the object located at the provider
  1212. type.
  1213. type: string
  1214. namespace:
  1215. description: The namespace the Provider type is in.
  1216. type: string
  1217. type:
  1218. description: The type of provider to use such as "Secret",
  1219. or "ConfigMap".
  1220. enum:
  1221. - Secret
  1222. - ConfigMap
  1223. type: string
  1224. required:
  1225. - name
  1226. - type
  1227. type: object
  1228. headers:
  1229. additionalProperties:
  1230. type: string
  1231. description: Headers
  1232. type: object
  1233. method:
  1234. description: Webhook Method
  1235. type: string
  1236. result:
  1237. description: Result formatting
  1238. properties:
  1239. jsonPath:
  1240. description: Json path of return value
  1241. type: string
  1242. type: object
  1243. secrets:
  1244. description: Secrets to fill in templates These secrets will
  1245. be passed to the templating function as key value pairs
  1246. under the given name
  1247. items:
  1248. properties:
  1249. name:
  1250. description: Name of this secret in templates
  1251. type: string
  1252. secretRef:
  1253. description: Secret ref to fill in credentials
  1254. properties:
  1255. key:
  1256. description: The key of the entry in the Secret
  1257. resource's `data` field to be used. Some instances
  1258. of this field may be defaulted, in others it may
  1259. be required.
  1260. type: string
  1261. name:
  1262. description: The name of the Secret resource being
  1263. referred to.
  1264. type: string
  1265. namespace:
  1266. description: Namespace of the resource being referred
  1267. to. Ignored if referent is not cluster-scoped.
  1268. cluster-scoped defaults to the namespace of the
  1269. referent.
  1270. type: string
  1271. type: object
  1272. required:
  1273. - name
  1274. - secretRef
  1275. type: object
  1276. type: array
  1277. timeout:
  1278. description: Timeout
  1279. type: string
  1280. url:
  1281. description: Webhook url to call
  1282. type: string
  1283. required:
  1284. - result
  1285. - url
  1286. type: object
  1287. yandexlockbox:
  1288. description: YandexLockbox configures this store to sync secrets
  1289. using Yandex Lockbox provider
  1290. properties:
  1291. apiEndpoint:
  1292. description: Yandex.Cloud API endpoint (e.g. 'api.cloud.yandex.net:443')
  1293. type: string
  1294. auth:
  1295. description: Auth defines the information necessary to authenticate
  1296. against Yandex Lockbox
  1297. properties:
  1298. authorizedKeySecretRef:
  1299. description: The authorized key used for authentication
  1300. properties:
  1301. key:
  1302. description: The key of the entry in the Secret resource's
  1303. `data` field to be used. Some instances of this
  1304. field may be defaulted, in others it may be required.
  1305. type: string
  1306. name:
  1307. description: The name of the Secret resource being
  1308. referred to.
  1309. type: string
  1310. namespace:
  1311. description: Namespace of the resource being referred
  1312. to. Ignored if referent is not cluster-scoped. cluster-scoped
  1313. defaults to the namespace of the referent.
  1314. type: string
  1315. type: object
  1316. type: object
  1317. caProvider:
  1318. description: The provider for the CA bundle to use to validate
  1319. Yandex.Cloud server certificate.
  1320. properties:
  1321. certSecretRef:
  1322. description: A reference to a specific 'key' within a
  1323. Secret resource, In some instances, `key` is a required
  1324. field.
  1325. properties:
  1326. key:
  1327. description: The key of the entry in the Secret resource's
  1328. `data` field to be used. Some instances of this
  1329. field may be defaulted, in others it may be required.
  1330. type: string
  1331. name:
  1332. description: The name of the Secret resource being
  1333. referred to.
  1334. type: string
  1335. namespace:
  1336. description: Namespace of the resource being referred
  1337. to. Ignored if referent is not cluster-scoped. cluster-scoped
  1338. defaults to the namespace of the referent.
  1339. type: string
  1340. type: object
  1341. type: object
  1342. required:
  1343. - auth
  1344. type: object
  1345. type: object
  1346. retrySettings:
  1347. description: Used to configure http retries if failed
  1348. properties:
  1349. maxRetries:
  1350. format: int32
  1351. type: integer
  1352. retryInterval:
  1353. type: string
  1354. type: object
  1355. required:
  1356. - provider
  1357. type: object
  1358. status:
  1359. description: SecretStoreStatus defines the observed state of the SecretStore.
  1360. properties:
  1361. conditions:
  1362. items:
  1363. properties:
  1364. lastTransitionTime:
  1365. format: date-time
  1366. type: string
  1367. message:
  1368. type: string
  1369. reason:
  1370. type: string
  1371. status:
  1372. type: string
  1373. type:
  1374. type: string
  1375. required:
  1376. - status
  1377. - type
  1378. type: object
  1379. type: array
  1380. type: object
  1381. type: object
  1382. served: true
  1383. storage: false
  1384. subresources:
  1385. status: {}
  1386. - additionalPrinterColumns:
  1387. - jsonPath: .metadata.creationTimestamp
  1388. name: AGE
  1389. type: date
  1390. - jsonPath: .status.conditions[?(@.type=="Ready")].reason
  1391. name: Status
  1392. type: string
  1393. name: v1beta1
  1394. schema:
  1395. openAPIV3Schema:
  1396. description: SecretStore represents a secure external location for storing
  1397. secrets, which can be referenced as part of `storeRef` fields.
  1398. properties:
  1399. apiVersion:
  1400. description: 'APIVersion defines the versioned schema of this representation
  1401. of an object. Servers should convert recognized schemas to the latest
  1402. internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
  1403. type: string
  1404. kind:
  1405. description: 'Kind is a string value representing the REST resource this
  1406. object represents. Servers may infer this from the endpoint the client
  1407. submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
  1408. type: string
  1409. metadata:
  1410. type: object
  1411. spec:
  1412. description: SecretStoreSpec defines the desired state of SecretStore.
  1413. properties:
  1414. controller:
  1415. description: 'Used to select the correct KES controller (think: ingress.ingressClassName)
  1416. The KES controller is instantiated with a specific controller name
  1417. and filters ES based on this property'
  1418. type: string
  1419. provider:
  1420. description: Used to configure the provider. Only one provider may
  1421. be set
  1422. maxProperties: 1
  1423. minProperties: 1
  1424. properties:
  1425. akeyless:
  1426. description: Akeyless configures this store to sync secrets using
  1427. Akeyless Vault provider
  1428. properties:
  1429. akeylessGWApiURL:
  1430. description: Akeyless GW API Url from which the secrets to
  1431. be fetched from.
  1432. type: string
  1433. authSecretRef:
  1434. description: Auth configures how the operator authenticates
  1435. with Akeyless.
  1436. properties:
  1437. secretRef:
  1438. description: 'AkeylessAuthSecretRef AKEYLESS_ACCESS_TYPE_PARAM:
  1439. AZURE_OBJ_ID OR GCP_AUDIENCE OR ACCESS_KEY OR KUB_CONFIG_NAME.'
  1440. properties:
  1441. accessID:
  1442. description: The SecretAccessID is used for authentication
  1443. properties:
  1444. key:
  1445. description: The key of the entry in the Secret
  1446. resource's `data` field to be used. Some instances
  1447. of this field may be defaulted, in others it
  1448. may be required.
  1449. type: string
  1450. name:
  1451. description: The name of the Secret resource being
  1452. referred to.
  1453. type: string
  1454. namespace:
  1455. description: Namespace of the resource being referred
  1456. to. Ignored if referent is not cluster-scoped.
  1457. cluster-scoped defaults to the namespace of
  1458. the referent.
  1459. type: string
  1460. type: object
  1461. accessType:
  1462. description: A reference to a specific 'key' within
  1463. a Secret resource, In some instances, `key` is a
  1464. required field.
  1465. properties:
  1466. key:
  1467. description: The key of the entry in the Secret
  1468. resource's `data` field to be used. Some instances
  1469. of this field may be defaulted, in others it
  1470. may be required.
  1471. type: string
  1472. name:
  1473. description: The name of the Secret resource being
  1474. referred to.
  1475. type: string
  1476. namespace:
  1477. description: Namespace of the resource being referred
  1478. to. Ignored if referent is not cluster-scoped.
  1479. cluster-scoped defaults to the namespace of
  1480. the referent.
  1481. type: string
  1482. type: object
  1483. accessTypeParam:
  1484. description: A reference to a specific 'key' within
  1485. a Secret resource, In some instances, `key` is a
  1486. required field.
  1487. properties:
  1488. key:
  1489. description: The key of the entry in the Secret
  1490. resource's `data` field to be used. Some instances
  1491. of this field may be defaulted, in others it
  1492. may be required.
  1493. type: string
  1494. name:
  1495. description: The name of the Secret resource being
  1496. referred to.
  1497. type: string
  1498. namespace:
  1499. description: Namespace of the resource being referred
  1500. to. Ignored if referent is not cluster-scoped.
  1501. cluster-scoped defaults to the namespace of
  1502. the referent.
  1503. type: string
  1504. type: object
  1505. type: object
  1506. required:
  1507. - secretRef
  1508. type: object
  1509. required:
  1510. - akeylessGWApiURL
  1511. - authSecretRef
  1512. type: object
  1513. alibaba:
  1514. description: Alibaba configures this store to sync secrets using
  1515. Alibaba Cloud provider
  1516. properties:
  1517. auth:
  1518. description: AlibabaAuth contains a secretRef for credentials.
  1519. properties:
  1520. secretRef:
  1521. description: AlibabaAuthSecretRef holds secret references
  1522. for Alibaba credentials.
  1523. properties:
  1524. accessKeyIDSecretRef:
  1525. description: The AccessKeyID is used for authentication
  1526. properties:
  1527. key:
  1528. description: The key of the entry in the Secret
  1529. resource's `data` field to be used. Some instances
  1530. of this field may be defaulted, in others it
  1531. may be required.
  1532. type: string
  1533. name:
  1534. description: The name of the Secret resource being
  1535. referred to.
  1536. type: string
  1537. namespace:
  1538. description: Namespace of the resource being referred
  1539. to. Ignored if referent is not cluster-scoped.
  1540. cluster-scoped defaults to the namespace of
  1541. the referent.
  1542. type: string
  1543. type: object
  1544. accessKeySecretSecretRef:
  1545. description: The AccessKeySecret is used for authentication
  1546. properties:
  1547. key:
  1548. description: The key of the entry in the Secret
  1549. resource's `data` field to be used. Some instances
  1550. of this field may be defaulted, in others it
  1551. may be required.
  1552. type: string
  1553. name:
  1554. description: The name of the Secret resource being
  1555. referred to.
  1556. type: string
  1557. namespace:
  1558. description: Namespace of the resource being referred
  1559. to. Ignored if referent is not cluster-scoped.
  1560. cluster-scoped defaults to the namespace of
  1561. the referent.
  1562. type: string
  1563. type: object
  1564. required:
  1565. - accessKeyIDSecretRef
  1566. - accessKeySecretSecretRef
  1567. type: object
  1568. required:
  1569. - secretRef
  1570. type: object
  1571. endpoint:
  1572. type: string
  1573. regionID:
  1574. description: Alibaba Region to be used for the provider
  1575. type: string
  1576. required:
  1577. - auth
  1578. - regionID
  1579. type: object
  1580. aws:
  1581. description: AWS configures this store to sync secrets using AWS
  1582. Secret Manager provider
  1583. properties:
  1584. auth:
  1585. description: 'Auth defines the information necessary to authenticate
  1586. against AWS if not set aws sdk will infer credentials from
  1587. your environment see: https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials'
  1588. properties:
  1589. jwt:
  1590. description: Authenticate against AWS using service account
  1591. tokens.
  1592. properties:
  1593. serviceAccountRef:
  1594. description: A reference to a ServiceAccount resource.
  1595. properties:
  1596. name:
  1597. description: The name of the ServiceAccount resource
  1598. being referred to.
  1599. type: string
  1600. namespace:
  1601. description: Namespace of the resource being referred
  1602. to. Ignored if referent is not cluster-scoped.
  1603. cluster-scoped defaults to the namespace of
  1604. the referent.
  1605. type: string
  1606. required:
  1607. - name
  1608. type: object
  1609. type: object
  1610. secretRef:
  1611. description: AWSAuthSecretRef holds secret references
  1612. for AWS credentials both AccessKeyID and SecretAccessKey
  1613. must be defined in order to properly authenticate.
  1614. properties:
  1615. accessKeyIDSecretRef:
  1616. description: The AccessKeyID is used for authentication
  1617. properties:
  1618. key:
  1619. description: The key of the entry in the Secret
  1620. resource's `data` field to be used. Some instances
  1621. of this field may be defaulted, in others it
  1622. may be required.
  1623. type: string
  1624. name:
  1625. description: The name of the Secret resource being
  1626. referred to.
  1627. type: string
  1628. namespace:
  1629. description: Namespace of the resource being referred
  1630. to. Ignored if referent is not cluster-scoped.
  1631. cluster-scoped defaults to the namespace of
  1632. the referent.
  1633. type: string
  1634. type: object
  1635. secretAccessKeySecretRef:
  1636. description: The SecretAccessKey is used for authentication
  1637. properties:
  1638. key:
  1639. description: The key of the entry in the Secret
  1640. resource's `data` field to be used. Some instances
  1641. of this field may be defaulted, in others it
  1642. may be required.
  1643. type: string
  1644. name:
  1645. description: The name of the Secret resource being
  1646. referred to.
  1647. type: string
  1648. namespace:
  1649. description: Namespace of the resource being referred
  1650. to. Ignored if referent is not cluster-scoped.
  1651. cluster-scoped defaults to the namespace of
  1652. the referent.
  1653. type: string
  1654. type: object
  1655. type: object
  1656. type: object
  1657. region:
  1658. description: AWS Region to be used for the provider
  1659. type: string
  1660. role:
  1661. description: Role is a Role ARN which the SecretManager provider
  1662. will assume
  1663. type: string
  1664. service:
  1665. description: Service defines which service should be used
  1666. to fetch the secrets
  1667. enum:
  1668. - SecretsManager
  1669. - ParameterStore
  1670. type: string
  1671. required:
  1672. - region
  1673. - service
  1674. type: object
  1675. azurekv:
  1676. description: AzureKV configures this store to sync secrets using
  1677. Azure Key Vault provider
  1678. properties:
  1679. authSecretRef:
  1680. description: Auth configures how the operator authenticates
  1681. with Azure. Required for ServicePrincipal auth type.
  1682. properties:
  1683. clientId:
  1684. description: The Azure clientId of the service principle
  1685. used for authentication.
  1686. properties:
  1687. key:
  1688. description: The key of the entry in the Secret resource's
  1689. `data` field to be used. Some instances of this
  1690. field may be defaulted, in others it may be required.
  1691. type: string
  1692. name:
  1693. description: The name of the Secret resource being
  1694. referred to.
  1695. type: string
  1696. namespace:
  1697. description: Namespace of the resource being referred
  1698. to. Ignored if referent is not cluster-scoped. cluster-scoped
  1699. defaults to the namespace of the referent.
  1700. type: string
  1701. type: object
  1702. clientSecret:
  1703. description: The Azure ClientSecret of the service principle
  1704. used for authentication.
  1705. properties:
  1706. key:
  1707. description: The key of the entry in the Secret resource's
  1708. `data` field to be used. Some instances of this
  1709. field may be defaulted, in others it may be required.
  1710. type: string
  1711. name:
  1712. description: The name of the Secret resource being
  1713. referred to.
  1714. type: string
  1715. namespace:
  1716. description: Namespace of the resource being referred
  1717. to. Ignored if referent is not cluster-scoped. cluster-scoped
  1718. defaults to the namespace of the referent.
  1719. type: string
  1720. type: object
  1721. type: object
  1722. authType:
  1723. default: ServicePrincipal
  1724. description: 'Auth type defines how to authenticate to the
  1725. keyvault service. Valid values are: - "ServicePrincipal"
  1726. (default): Using a service principal (tenantId, clientId,
  1727. clientSecret) - "ManagedIdentity": Using Managed Identity
  1728. assigned to the pod (see aad-pod-identity)'
  1729. enum:
  1730. - ServicePrincipal
  1731. - ManagedIdentity
  1732. - WorkloadIdentity
  1733. type: string
  1734. identityId:
  1735. description: If multiple Managed Identity is assigned to the
  1736. pod, you can select the one to be used
  1737. type: string
  1738. serviceAccountRef:
  1739. description: ServiceAccountRef specified the service account
  1740. that should be used when authenticating with WorkloadIdentity.
  1741. properties:
  1742. name:
  1743. description: The name of the ServiceAccount resource being
  1744. referred to.
  1745. type: string
  1746. namespace:
  1747. description: Namespace of the resource being referred
  1748. to. Ignored if referent is not cluster-scoped. cluster-scoped
  1749. defaults to the namespace of the referent.
  1750. type: string
  1751. required:
  1752. - name
  1753. type: object
  1754. tenantId:
  1755. description: TenantID configures the Azure Tenant to send
  1756. requests to. Required for ServicePrincipal auth type.
  1757. type: string
  1758. vaultUrl:
  1759. description: Vault Url from which the secrets to be fetched
  1760. from.
  1761. type: string
  1762. required:
  1763. - vaultUrl
  1764. type: object
  1765. fake:
  1766. description: Fake configures a store with static key/value pairs
  1767. properties:
  1768. data:
  1769. items:
  1770. properties:
  1771. key:
  1772. type: string
  1773. value:
  1774. type: string
  1775. valueMap:
  1776. additionalProperties:
  1777. type: string
  1778. type: object
  1779. version:
  1780. type: string
  1781. required:
  1782. - key
  1783. type: object
  1784. type: array
  1785. required:
  1786. - data
  1787. type: object
  1788. gcpsm:
  1789. description: GCPSM configures this store to sync secrets using
  1790. Google Cloud Platform Secret Manager provider
  1791. properties:
  1792. auth:
  1793. description: Auth defines the information necessary to authenticate
  1794. against GCP
  1795. properties:
  1796. secretRef:
  1797. properties:
  1798. secretAccessKeySecretRef:
  1799. description: The SecretAccessKey is used for authentication
  1800. properties:
  1801. key:
  1802. description: The key of the entry in the Secret
  1803. resource's `data` field to be used. Some instances
  1804. of this field may be defaulted, in others it
  1805. may be required.
  1806. type: string
  1807. name:
  1808. description: The name of the Secret resource being
  1809. referred to.
  1810. type: string
  1811. namespace:
  1812. description: Namespace of the resource being referred
  1813. to. Ignored if referent is not cluster-scoped.
  1814. cluster-scoped defaults to the namespace of
  1815. the referent.
  1816. type: string
  1817. type: object
  1818. type: object
  1819. workloadIdentity:
  1820. properties:
  1821. clusterLocation:
  1822. type: string
  1823. clusterName:
  1824. type: string
  1825. clusterProjectID:
  1826. type: string
  1827. serviceAccountRef:
  1828. description: A reference to a ServiceAccount resource.
  1829. properties:
  1830. name:
  1831. description: The name of the ServiceAccount resource
  1832. being referred to.
  1833. type: string
  1834. namespace:
  1835. description: Namespace of the resource being referred
  1836. to. Ignored if referent is not cluster-scoped.
  1837. cluster-scoped defaults to the namespace of
  1838. the referent.
  1839. type: string
  1840. required:
  1841. - name
  1842. type: object
  1843. required:
  1844. - clusterLocation
  1845. - clusterName
  1846. - serviceAccountRef
  1847. type: object
  1848. type: object
  1849. projectID:
  1850. description: ProjectID project where secret is located
  1851. type: string
  1852. type: object
  1853. gitlab:
  1854. description: Gitlab configures this store to sync secrets using
  1855. Gitlab Variables provider
  1856. properties:
  1857. auth:
  1858. description: Auth configures how secret-manager authenticates
  1859. with a GitLab instance.
  1860. properties:
  1861. SecretRef:
  1862. properties:
  1863. accessToken:
  1864. description: AccessToken is used for authentication.
  1865. properties:
  1866. key:
  1867. description: The key of the entry in the Secret
  1868. resource's `data` field to be used. Some instances
  1869. of this field may be defaulted, in others it
  1870. may be required.
  1871. type: string
  1872. name:
  1873. description: The name of the Secret resource being
  1874. referred to.
  1875. type: string
  1876. namespace:
  1877. description: Namespace of the resource being referred
  1878. to. Ignored if referent is not cluster-scoped.
  1879. cluster-scoped defaults to the namespace of
  1880. the referent.
  1881. type: string
  1882. type: object
  1883. type: object
  1884. required:
  1885. - SecretRef
  1886. type: object
  1887. projectID:
  1888. description: ProjectID specifies a project where secrets are
  1889. located.
  1890. type: string
  1891. url:
  1892. description: URL configures the GitLab instance URL. Defaults
  1893. to https://gitlab.com/.
  1894. type: string
  1895. required:
  1896. - auth
  1897. type: object
  1898. ibm:
  1899. description: IBM configures this store to sync secrets using IBM
  1900. Cloud provider
  1901. properties:
  1902. auth:
  1903. description: Auth configures how secret-manager authenticates
  1904. with the IBM secrets manager.
  1905. properties:
  1906. secretRef:
  1907. properties:
  1908. secretApiKeySecretRef:
  1909. description: The SecretAccessKey is used for authentication
  1910. properties:
  1911. key:
  1912. description: The key of the entry in the Secret
  1913. resource's `data` field to be used. Some instances
  1914. of this field may be defaulted, in others it
  1915. may be required.
  1916. type: string
  1917. name:
  1918. description: The name of the Secret resource being
  1919. referred to.
  1920. type: string
  1921. namespace:
  1922. description: Namespace of the resource being referred
  1923. to. Ignored if referent is not cluster-scoped.
  1924. cluster-scoped defaults to the namespace of
  1925. the referent.
  1926. type: string
  1927. type: object
  1928. type: object
  1929. required:
  1930. - secretRef
  1931. type: object
  1932. serviceUrl:
  1933. description: ServiceURL is the Endpoint URL that is specific
  1934. to the Secrets Manager service instance
  1935. type: string
  1936. required:
  1937. - auth
  1938. type: object
  1939. kubernetes:
  1940. description: Kubernetes configures this store to sync secrets
  1941. using a Kubernetes cluster provider
  1942. properties:
  1943. auth:
  1944. description: Auth configures how secret-manager authenticates
  1945. with a Kubernetes instance.
  1946. maxProperties: 1
  1947. minProperties: 1
  1948. properties:
  1949. cert:
  1950. description: has both clientCert and clientKey as secretKeySelector
  1951. properties:
  1952. clientCert:
  1953. description: A reference to a specific 'key' within
  1954. a Secret resource, In some instances, `key` is a
  1955. required field.
  1956. properties:
  1957. key:
  1958. description: The key of the entry in the Secret
  1959. resource's `data` field to be used. Some instances
  1960. of this field may be defaulted, in others it
  1961. may be required.
  1962. type: string
  1963. name:
  1964. description: The name of the Secret resource being
  1965. referred to.
  1966. type: string
  1967. namespace:
  1968. description: Namespace of the resource being referred
  1969. to. Ignored if referent is not cluster-scoped.
  1970. cluster-scoped defaults to the namespace of
  1971. the referent.
  1972. type: string
  1973. type: object
  1974. clientKey:
  1975. description: A reference to a specific 'key' within
  1976. a Secret resource, In some instances, `key` is a
  1977. required field.
  1978. properties:
  1979. key:
  1980. description: The key of the entry in the Secret
  1981. resource's `data` field to be used. Some instances
  1982. of this field may be defaulted, in others it
  1983. may be required.
  1984. type: string
  1985. name:
  1986. description: The name of the Secret resource being
  1987. referred to.
  1988. type: string
  1989. namespace:
  1990. description: Namespace of the resource being referred
  1991. to. Ignored if referent is not cluster-scoped.
  1992. cluster-scoped defaults to the namespace of
  1993. the referent.
  1994. type: string
  1995. type: object
  1996. type: object
  1997. serviceAccount:
  1998. description: points to a service account that should be
  1999. used for authentication
  2000. properties:
  2001. serviceAccount:
  2002. description: A reference to a ServiceAccount resource.
  2003. properties:
  2004. name:
  2005. description: The name of the ServiceAccount resource
  2006. being referred to.
  2007. type: string
  2008. namespace:
  2009. description: Namespace of the resource being referred
  2010. to. Ignored if referent is not cluster-scoped.
  2011. cluster-scoped defaults to the namespace of
  2012. the referent.
  2013. type: string
  2014. required:
  2015. - name
  2016. type: object
  2017. type: object
  2018. token:
  2019. description: use static token to authenticate with
  2020. properties:
  2021. bearerToken:
  2022. description: A reference to a specific 'key' within
  2023. a Secret resource, In some instances, `key` is a
  2024. required field.
  2025. properties:
  2026. key:
  2027. description: The key of the entry in the Secret
  2028. resource's `data` field to be used. Some instances
  2029. of this field may be defaulted, in others it
  2030. may be required.
  2031. type: string
  2032. name:
  2033. description: The name of the Secret resource being
  2034. referred to.
  2035. type: string
  2036. namespace:
  2037. description: Namespace of the resource being referred
  2038. to. Ignored if referent is not cluster-scoped.
  2039. cluster-scoped defaults to the namespace of
  2040. the referent.
  2041. type: string
  2042. type: object
  2043. type: object
  2044. type: object
  2045. remoteNamespace:
  2046. default: default
  2047. description: Remote namespace to fetch the secrets from
  2048. type: string
  2049. server:
  2050. description: configures the Kubernetes server Address.
  2051. properties:
  2052. caBundle:
  2053. description: CABundle is a base64-encoded CA certificate
  2054. format: byte
  2055. type: string
  2056. caProvider:
  2057. description: 'see: https://external-secrets.io/v0.4.1/spec/#external-secrets.io/v1alpha1.CAProvider'
  2058. properties:
  2059. key:
  2060. description: The key the value inside of the provider
  2061. type to use, only used with "Secret" type
  2062. type: string
  2063. name:
  2064. description: The name of the object located at the
  2065. provider type.
  2066. type: string
  2067. namespace:
  2068. description: The namespace the Provider type is in.
  2069. type: string
  2070. type:
  2071. description: The type of provider to use such as "Secret",
  2072. or "ConfigMap".
  2073. enum:
  2074. - Secret
  2075. - ConfigMap
  2076. type: string
  2077. required:
  2078. - name
  2079. - type
  2080. type: object
  2081. url:
  2082. default: kubernetes.default
  2083. description: configures the Kubernetes server Address.
  2084. type: string
  2085. type: object
  2086. required:
  2087. - auth
  2088. type: object
  2089. oracle:
  2090. description: Oracle configures this store to sync secrets using
  2091. Oracle Vault provider
  2092. properties:
  2093. auth:
  2094. description: Auth configures how secret-manager authenticates
  2095. with the Oracle Vault. If empty, use the instance principal,
  2096. otherwise the user credentials specified in Auth.
  2097. properties:
  2098. secretRef:
  2099. description: SecretRef to pass through sensitive information.
  2100. properties:
  2101. fingerprint:
  2102. description: Fingerprint is the fingerprint of the
  2103. API private key.
  2104. properties:
  2105. key:
  2106. description: The key of the entry in the Secret
  2107. resource's `data` field to be used. Some instances
  2108. of this field may be defaulted, in others it
  2109. may be required.
  2110. type: string
  2111. name:
  2112. description: The name of the Secret resource being
  2113. referred to.
  2114. type: string
  2115. namespace:
  2116. description: Namespace of the resource being referred
  2117. to. Ignored if referent is not cluster-scoped.
  2118. cluster-scoped defaults to the namespace of
  2119. the referent.
  2120. type: string
  2121. type: object
  2122. privatekey:
  2123. description: PrivateKey is the user's API Signing
  2124. Key in PEM format, used for authentication.
  2125. properties:
  2126. key:
  2127. description: The key of the entry in the Secret
  2128. resource's `data` field to be used. Some instances
  2129. of this field may be defaulted, in others it
  2130. may be required.
  2131. type: string
  2132. name:
  2133. description: The name of the Secret resource being
  2134. referred to.
  2135. type: string
  2136. namespace:
  2137. description: Namespace of the resource being referred
  2138. to. Ignored if referent is not cluster-scoped.
  2139. cluster-scoped defaults to the namespace of
  2140. the referent.
  2141. type: string
  2142. type: object
  2143. required:
  2144. - fingerprint
  2145. - privatekey
  2146. type: object
  2147. tenancy:
  2148. description: Tenancy is the tenancy OCID where user is
  2149. located.
  2150. type: string
  2151. user:
  2152. description: User is an access OCID specific to the account.
  2153. type: string
  2154. required:
  2155. - secretRef
  2156. - tenancy
  2157. - user
  2158. type: object
  2159. region:
  2160. description: Region is the region where vault is located.
  2161. type: string
  2162. vault:
  2163. description: Vault is the vault's OCID of the specific vault
  2164. where secret is located.
  2165. type: string
  2166. required:
  2167. - region
  2168. - vault
  2169. type: object
  2170. senhasegura:
  2171. description: Senhasegura configures this store to sync secrets
  2172. using senhasegura provider
  2173. properties:
  2174. auth:
  2175. description: Auth defines parameters to authenticate in senhasegura
  2176. properties:
  2177. clientId:
  2178. type: string
  2179. clientSecretSecretRef:
  2180. description: A reference to a specific 'key' within a
  2181. Secret resource, In some instances, `key` is a required
  2182. field.
  2183. properties:
  2184. key:
  2185. description: The key of the entry in the Secret resource's
  2186. `data` field to be used. Some instances of this
  2187. field may be defaulted, in others it may be required.
  2188. type: string
  2189. name:
  2190. description: The name of the Secret resource being
  2191. referred to.
  2192. type: string
  2193. namespace:
  2194. description: Namespace of the resource being referred
  2195. to. Ignored if referent is not cluster-scoped. cluster-scoped
  2196. defaults to the namespace of the referent.
  2197. type: string
  2198. type: object
  2199. required:
  2200. - clientId
  2201. - clientSecretSecretRef
  2202. type: object
  2203. ignoreSslCertificate:
  2204. default: false
  2205. description: IgnoreSslCertificate defines if SSL certificate
  2206. must be ignored
  2207. type: boolean
  2208. module:
  2209. description: Module defines which senhasegura module should
  2210. be used to get secrets
  2211. type: string
  2212. url:
  2213. description: URL of senhasegura
  2214. type: string
  2215. required:
  2216. - auth
  2217. - module
  2218. - url
  2219. type: object
  2220. vault:
  2221. description: Vault configures this store to sync secrets using
  2222. Hashi provider
  2223. properties:
  2224. auth:
  2225. description: Auth configures how secret-manager authenticates
  2226. with the Vault server.
  2227. properties:
  2228. appRole:
  2229. description: AppRole authenticates with Vault using the
  2230. App Role auth mechanism, with the role and secret stored
  2231. in a Kubernetes Secret resource.
  2232. properties:
  2233. path:
  2234. default: approle
  2235. description: 'Path where the App Role authentication
  2236. backend is mounted in Vault, e.g: "approle"'
  2237. type: string
  2238. roleId:
  2239. description: RoleID configured in the App Role authentication
  2240. backend when setting up the authentication backend
  2241. in Vault.
  2242. type: string
  2243. secretRef:
  2244. description: Reference to a key in a Secret that contains
  2245. the App Role secret used to authenticate with Vault.
  2246. The `key` field must be specified and denotes which
  2247. entry within the Secret resource is used as the
  2248. app role secret.
  2249. properties:
  2250. key:
  2251. description: The key of the entry in the Secret
  2252. resource's `data` field to be used. Some instances
  2253. of this field may be defaulted, in others it
  2254. may be required.
  2255. type: string
  2256. name:
  2257. description: The name of the Secret resource being
  2258. referred to.
  2259. type: string
  2260. namespace:
  2261. description: Namespace of the resource being referred
  2262. to. Ignored if referent is not cluster-scoped.
  2263. cluster-scoped defaults to the namespace of
  2264. the referent.
  2265. type: string
  2266. type: object
  2267. required:
  2268. - path
  2269. - roleId
  2270. - secretRef
  2271. type: object
  2272. cert:
  2273. description: Cert authenticates with TLS Certificates
  2274. by passing client certificate, private key and ca certificate
  2275. Cert authentication method
  2276. properties:
  2277. clientCert:
  2278. description: ClientCert is a certificate to authenticate
  2279. using the Cert Vault authentication method
  2280. properties:
  2281. key:
  2282. description: The key of the entry in the Secret
  2283. resource's `data` field to be used. Some instances
  2284. of this field may be defaulted, in others it
  2285. may be required.
  2286. type: string
  2287. name:
  2288. description: The name of the Secret resource being
  2289. referred to.
  2290. type: string
  2291. namespace:
  2292. description: Namespace of the resource being referred
  2293. to. Ignored if referent is not cluster-scoped.
  2294. cluster-scoped defaults to the namespace of
  2295. the referent.
  2296. type: string
  2297. type: object
  2298. secretRef:
  2299. description: SecretRef to a key in a Secret resource
  2300. containing client private key to authenticate with
  2301. Vault using the Cert authentication method
  2302. properties:
  2303. key:
  2304. description: The key of the entry in the Secret
  2305. resource's `data` field to be used. Some instances
  2306. of this field may be defaulted, in others it
  2307. may be required.
  2308. type: string
  2309. name:
  2310. description: The name of the Secret resource being
  2311. referred to.
  2312. type: string
  2313. namespace:
  2314. description: Namespace of the resource being referred
  2315. to. Ignored if referent is not cluster-scoped.
  2316. cluster-scoped defaults to the namespace of
  2317. the referent.
  2318. type: string
  2319. type: object
  2320. type: object
  2321. jwt:
  2322. description: Jwt authenticates with Vault by passing role
  2323. and JWT token using the JWT/OIDC authentication method
  2324. properties:
  2325. kubernetesServiceAccountToken:
  2326. description: Optional ServiceAccountToken specifies
  2327. the Kubernetes service account for which to request
  2328. a token for with the `TokenRequest` API.
  2329. properties:
  2330. audiences:
  2331. description: Optional audiences field that will
  2332. be used to request a temporary Kubernetes service
  2333. account token for the service account referenced
  2334. by `serviceAccountRef`. Defaults to a single
  2335. audience `vault` it not specified.
  2336. items:
  2337. type: string
  2338. type: array
  2339. expirationSeconds:
  2340. description: Optional expiration time in seconds
  2341. that will be used to request a temporary Kubernetes
  2342. service account token for the service account
  2343. referenced by `serviceAccountRef`. Defaults
  2344. to 10 minutes.
  2345. format: int64
  2346. type: integer
  2347. serviceAccountRef:
  2348. description: Service account field containing
  2349. the name of a kubernetes ServiceAccount.
  2350. properties:
  2351. name:
  2352. description: The name of the ServiceAccount
  2353. resource being referred to.
  2354. type: string
  2355. namespace:
  2356. description: Namespace of the resource being
  2357. referred to. Ignored if referent is not
  2358. cluster-scoped. cluster-scoped defaults
  2359. to the namespace of the referent.
  2360. type: string
  2361. required:
  2362. - name
  2363. type: object
  2364. required:
  2365. - serviceAccountRef
  2366. type: object
  2367. path:
  2368. default: jwt
  2369. description: 'Path where the JWT authentication backend
  2370. is mounted in Vault, e.g: "jwt"'
  2371. type: string
  2372. role:
  2373. description: Role is a JWT role to authenticate using
  2374. the JWT/OIDC Vault authentication method
  2375. type: string
  2376. secretRef:
  2377. description: Optional SecretRef that refers to a key
  2378. in a Secret resource containing JWT token to authenticate
  2379. with Vault using the JWT/OIDC authentication method.
  2380. properties:
  2381. key:
  2382. description: The key of the entry in the Secret
  2383. resource's `data` field to be used. Some instances
  2384. of this field may be defaulted, in others it
  2385. may be required.
  2386. type: string
  2387. name:
  2388. description: The name of the Secret resource being
  2389. referred to.
  2390. type: string
  2391. namespace:
  2392. description: Namespace of the resource being referred
  2393. to. Ignored if referent is not cluster-scoped.
  2394. cluster-scoped defaults to the namespace of
  2395. the referent.
  2396. type: string
  2397. type: object
  2398. required:
  2399. - path
  2400. type: object
  2401. kubernetes:
  2402. description: Kubernetes authenticates with Vault by passing
  2403. the ServiceAccount token stored in the named Secret
  2404. resource to the Vault server.
  2405. properties:
  2406. mountPath:
  2407. default: kubernetes
  2408. description: 'Path where the Kubernetes authentication
  2409. backend is mounted in Vault, e.g: "kubernetes"'
  2410. type: string
  2411. role:
  2412. description: A required field containing the Vault
  2413. Role to assume. A Role binds a Kubernetes ServiceAccount
  2414. with a set of Vault policies.
  2415. type: string
  2416. secretRef:
  2417. description: Optional secret field containing a Kubernetes
  2418. ServiceAccount JWT used for authenticating with
  2419. Vault. If a name is specified without a key, `token`
  2420. is the default. If one is not specified, the one
  2421. bound to the controller will be used.
  2422. properties:
  2423. key:
  2424. description: The key of the entry in the Secret
  2425. resource's `data` field to be used. Some instances
  2426. of this field may be defaulted, in others it
  2427. may be required.
  2428. type: string
  2429. name:
  2430. description: The name of the Secret resource being
  2431. referred to.
  2432. type: string
  2433. namespace:
  2434. description: Namespace of the resource being referred
  2435. to. Ignored if referent is not cluster-scoped.
  2436. cluster-scoped defaults to the namespace of
  2437. the referent.
  2438. type: string
  2439. type: object
  2440. serviceAccountRef:
  2441. description: Optional service account field containing
  2442. the name of a kubernetes ServiceAccount. If the
  2443. service account is specified, the service account
  2444. secret token JWT will be used for authenticating
  2445. with Vault. If the service account selector is not
  2446. supplied, the secretRef will be used instead.
  2447. properties:
  2448. name:
  2449. description: The name of the ServiceAccount resource
  2450. being referred to.
  2451. type: string
  2452. namespace:
  2453. description: Namespace of the resource being referred
  2454. to. Ignored if referent is not cluster-scoped.
  2455. cluster-scoped defaults to the namespace of
  2456. the referent.
  2457. type: string
  2458. required:
  2459. - name
  2460. type: object
  2461. required:
  2462. - mountPath
  2463. - role
  2464. type: object
  2465. ldap:
  2466. description: Ldap authenticates with Vault by passing
  2467. username/password pair using the LDAP authentication
  2468. method
  2469. properties:
  2470. path:
  2471. default: ldap
  2472. description: 'Path where the LDAP authentication backend
  2473. is mounted in Vault, e.g: "ldap"'
  2474. type: string
  2475. secretRef:
  2476. description: SecretRef to a key in a Secret resource
  2477. containing password for the LDAP user used to authenticate
  2478. with Vault using the LDAP authentication method
  2479. properties:
  2480. key:
  2481. description: The key of the entry in the Secret
  2482. resource's `data` field to be used. Some instances
  2483. of this field may be defaulted, in others it
  2484. may be required.
  2485. type: string
  2486. name:
  2487. description: The name of the Secret resource being
  2488. referred to.
  2489. type: string
  2490. namespace:
  2491. description: Namespace of the resource being referred
  2492. to. Ignored if referent is not cluster-scoped.
  2493. cluster-scoped defaults to the namespace of
  2494. the referent.
  2495. type: string
  2496. type: object
  2497. username:
  2498. description: Username is a LDAP user name used to
  2499. authenticate using the LDAP Vault authentication
  2500. method
  2501. type: string
  2502. required:
  2503. - path
  2504. - username
  2505. type: object
  2506. tokenSecretRef:
  2507. description: TokenSecretRef authenticates with Vault by
  2508. presenting a token.
  2509. properties:
  2510. key:
  2511. description: The key of the entry in the Secret resource's
  2512. `data` field to be used. Some instances of this
  2513. field may be defaulted, in others it may be required.
  2514. type: string
  2515. name:
  2516. description: The name of the Secret resource being
  2517. referred to.
  2518. type: string
  2519. namespace:
  2520. description: Namespace of the resource being referred
  2521. to. Ignored if referent is not cluster-scoped. cluster-scoped
  2522. defaults to the namespace of the referent.
  2523. type: string
  2524. type: object
  2525. type: object
  2526. caBundle:
  2527. description: PEM encoded CA bundle used to validate Vault
  2528. server certificate. Only used if the Server URL is using
  2529. HTTPS protocol. This parameter is ignored for plain HTTP
  2530. protocol connection. If not set the system root certificates
  2531. are used to validate the TLS connection.
  2532. format: byte
  2533. type: string
  2534. caProvider:
  2535. description: The provider for the CA bundle to use to validate
  2536. Vault server certificate.
  2537. properties:
  2538. key:
  2539. description: The key the value inside of the provider
  2540. type to use, only used with "Secret" type
  2541. type: string
  2542. name:
  2543. description: The name of the object located at the provider
  2544. type.
  2545. type: string
  2546. namespace:
  2547. description: The namespace the Provider type is in.
  2548. type: string
  2549. type:
  2550. description: The type of provider to use such as "Secret",
  2551. or "ConfigMap".
  2552. enum:
  2553. - Secret
  2554. - ConfigMap
  2555. type: string
  2556. required:
  2557. - name
  2558. - type
  2559. type: object
  2560. forwardInconsistent:
  2561. description: ForwardInconsistent tells Vault to forward read-after-write
  2562. requests to the Vault leader instead of simply retrying
  2563. within a loop. This can increase performance if the option
  2564. is enabled serverside. https://www.vaultproject.io/docs/configuration/replication#allow_forwarding_via_header
  2565. type: boolean
  2566. namespace:
  2567. description: 'Name of the vault namespace. Namespaces is a
  2568. set of features within Vault Enterprise that allows Vault
  2569. environments to support Secure Multi-tenancy. e.g: "ns1".
  2570. More about namespaces can be found here https://www.vaultproject.io/docs/enterprise/namespaces'
  2571. type: string
  2572. path:
  2573. description: 'Path is the mount path of the Vault KV backend
  2574. endpoint, e.g: "secret". The v2 KV secret engine version
  2575. specific "/data" path suffix for fetching secrets from Vault
  2576. is optional and will be appended if not present in specified
  2577. path.'
  2578. type: string
  2579. readYourWrites:
  2580. description: ReadYourWrites ensures isolated read-after-write
  2581. semantics by providing discovered cluster replication states
  2582. in each request. More information about eventual consistency
  2583. in Vault can be found here https://www.vaultproject.io/docs/enterprise/consistency
  2584. type: boolean
  2585. server:
  2586. description: 'Server is the connection address for the Vault
  2587. server, e.g: "https://vault.example.com:8200".'
  2588. type: string
  2589. version:
  2590. default: v2
  2591. description: Version is the Vault KV secret engine version.
  2592. This can be either "v1" or "v2". Version defaults to "v2".
  2593. enum:
  2594. - v1
  2595. - v2
  2596. type: string
  2597. required:
  2598. - auth
  2599. - server
  2600. type: object
  2601. webhook:
  2602. description: Webhook configures this store to sync secrets using
  2603. a generic templated webhook
  2604. properties:
  2605. body:
  2606. description: Body
  2607. type: string
  2608. caBundle:
  2609. description: PEM encoded CA bundle used to validate webhook
  2610. server certificate. Only used if the Server URL is using
  2611. HTTPS protocol. This parameter is ignored for plain HTTP
  2612. protocol connection. If not set the system root certificates
  2613. are used to validate the TLS connection.
  2614. format: byte
  2615. type: string
  2616. caProvider:
  2617. description: The provider for the CA bundle to use to validate
  2618. webhook server certificate.
  2619. properties:
  2620. key:
  2621. description: The key the value inside of the provider
  2622. type to use, only used with "Secret" type
  2623. type: string
  2624. name:
  2625. description: The name of the object located at the provider
  2626. type.
  2627. type: string
  2628. namespace:
  2629. description: The namespace the Provider type is in.
  2630. type: string
  2631. type:
  2632. description: The type of provider to use such as "Secret",
  2633. or "ConfigMap".
  2634. enum:
  2635. - Secret
  2636. - ConfigMap
  2637. type: string
  2638. required:
  2639. - name
  2640. - type
  2641. type: object
  2642. headers:
  2643. additionalProperties:
  2644. type: string
  2645. description: Headers
  2646. type: object
  2647. method:
  2648. description: Webhook Method
  2649. type: string
  2650. result:
  2651. description: Result formatting
  2652. properties:
  2653. jsonPath:
  2654. description: Json path of return value
  2655. type: string
  2656. type: object
  2657. secrets:
  2658. description: Secrets to fill in templates These secrets will
  2659. be passed to the templating function as key value pairs
  2660. under the given name
  2661. items:
  2662. properties:
  2663. name:
  2664. description: Name of this secret in templates
  2665. type: string
  2666. secretRef:
  2667. description: Secret ref to fill in credentials
  2668. properties:
  2669. key:
  2670. description: The key of the entry in the Secret
  2671. resource's `data` field to be used. Some instances
  2672. of this field may be defaulted, in others it may
  2673. be required.
  2674. type: string
  2675. name:
  2676. description: The name of the Secret resource being
  2677. referred to.
  2678. type: string
  2679. namespace:
  2680. description: Namespace of the resource being referred
  2681. to. Ignored if referent is not cluster-scoped.
  2682. cluster-scoped defaults to the namespace of the
  2683. referent.
  2684. type: string
  2685. type: object
  2686. required:
  2687. - name
  2688. - secretRef
  2689. type: object
  2690. type: array
  2691. timeout:
  2692. description: Timeout
  2693. type: string
  2694. url:
  2695. description: Webhook url to call
  2696. type: string
  2697. required:
  2698. - result
  2699. - url
  2700. type: object
  2701. yandexlockbox:
  2702. description: YandexLockbox configures this store to sync secrets
  2703. using Yandex Lockbox provider
  2704. properties:
  2705. apiEndpoint:
  2706. description: Yandex.Cloud API endpoint (e.g. 'api.cloud.yandex.net:443')
  2707. type: string
  2708. auth:
  2709. description: Auth defines the information necessary to authenticate
  2710. against Yandex Lockbox
  2711. properties:
  2712. authorizedKeySecretRef:
  2713. description: The authorized key used for authentication
  2714. properties:
  2715. key:
  2716. description: The key of the entry in the Secret resource's
  2717. `data` field to be used. Some instances of this
  2718. field may be defaulted, in others it may be required.
  2719. type: string
  2720. name:
  2721. description: The name of the Secret resource being
  2722. referred to.
  2723. type: string
  2724. namespace:
  2725. description: Namespace of the resource being referred
  2726. to. Ignored if referent is not cluster-scoped. cluster-scoped
  2727. defaults to the namespace of the referent.
  2728. type: string
  2729. type: object
  2730. type: object
  2731. caProvider:
  2732. description: The provider for the CA bundle to use to validate
  2733. Yandex.Cloud server certificate.
  2734. properties:
  2735. certSecretRef:
  2736. description: A reference to a specific 'key' within a
  2737. Secret resource, In some instances, `key` is a required
  2738. field.
  2739. properties:
  2740. key:
  2741. description: The key of the entry in the Secret resource's
  2742. `data` field to be used. Some instances of this
  2743. field may be defaulted, in others it may be required.
  2744. type: string
  2745. name:
  2746. description: The name of the Secret resource being
  2747. referred to.
  2748. type: string
  2749. namespace:
  2750. description: Namespace of the resource being referred
  2751. to. Ignored if referent is not cluster-scoped. cluster-scoped
  2752. defaults to the namespace of the referent.
  2753. type: string
  2754. type: object
  2755. type: object
  2756. required:
  2757. - auth
  2758. type: object
  2759. type: object
  2760. refreshInterval:
  2761. description: Used to configure store refresh interval in seconds.
  2762. Empty or 0 will default to the controller config.
  2763. type: integer
  2764. retrySettings:
  2765. description: Used to configure http retries if failed
  2766. properties:
  2767. maxRetries:
  2768. format: int32
  2769. type: integer
  2770. retryInterval:
  2771. type: string
  2772. type: object
  2773. required:
  2774. - provider
  2775. type: object
  2776. status:
  2777. description: SecretStoreStatus defines the observed state of the SecretStore.
  2778. properties:
  2779. conditions:
  2780. items:
  2781. properties:
  2782. lastTransitionTime:
  2783. format: date-time
  2784. type: string
  2785. message:
  2786. type: string
  2787. reason:
  2788. type: string
  2789. status:
  2790. type: string
  2791. type:
  2792. type: string
  2793. required:
  2794. - status
  2795. - type
  2796. type: object
  2797. type: array
  2798. type: object
  2799. type: object
  2800. served: true
  2801. storage: true
  2802. subresources:
  2803. status: {}
  2804. status:
  2805. acceptedNames:
  2806. kind: ""
  2807. plural: ""
  2808. conditions: []
  2809. storedVersions: []