external-secrets.io_secretstores.yaml 67 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256
  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. name: v1alpha1
  26. schema:
  27. openAPIV3Schema:
  28. description: SecretStore represents a secure external location for storing
  29. secrets, which can be referenced as part of `storeRef` fields.
  30. properties:
  31. apiVersion:
  32. description: 'APIVersion defines the versioned schema of this representation
  33. of an object. Servers should convert recognized schemas to the latest
  34. internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
  35. type: string
  36. kind:
  37. description: 'Kind is a string value representing the REST resource this
  38. object represents. Servers may infer this from the endpoint the client
  39. submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
  40. type: string
  41. metadata:
  42. type: object
  43. spec:
  44. description: SecretStoreSpec defines the desired state of SecretStore.
  45. properties:
  46. controller:
  47. description: 'Used to select the correct KES controller (think: ingress.ingressClassName)
  48. The KES controller is instantiated with a specific controller name
  49. and filters ES based on this property'
  50. type: string
  51. provider:
  52. description: Used to configure the provider. Only one provider may
  53. be set
  54. maxProperties: 1
  55. minProperties: 1
  56. properties:
  57. akeyless:
  58. description: Akeyless configures this store to sync secrets using
  59. Akeyless Vault provider
  60. properties:
  61. akeylessGWApiURL:
  62. description: Akeyless GW API Url from which the secrets to
  63. be fetched from.
  64. type: string
  65. authSecretRef:
  66. description: Auth configures how the operator authenticates
  67. with Akeyless.
  68. properties:
  69. secretRef:
  70. description: 'AkeylessAuthSecretRef AKEYLESS_ACCESS_TYPE_PARAM:
  71. AZURE_OBJ_ID OR GCP_AUDIENCE OR ACCESS_KEY OR KUB_CONFIG_NAME.'
  72. properties:
  73. accessID:
  74. description: The SecretAccessID is used for authentication
  75. properties:
  76. key:
  77. description: The key of the entry in the Secret
  78. resource's `data` field to be used. Some instances
  79. of this field may be defaulted, in others it
  80. may be required.
  81. type: string
  82. name:
  83. description: The name of the Secret resource being
  84. referred to.
  85. type: string
  86. namespace:
  87. description: Namespace of the resource being referred
  88. to. Ignored if referent is not cluster-scoped.
  89. cluster-scoped defaults to the namespace of
  90. the referent.
  91. type: string
  92. type: object
  93. accessType:
  94. description: A reference to a specific 'key' within
  95. a Secret resource, In some instances, `key` is a
  96. required field.
  97. properties:
  98. key:
  99. description: The key of the entry in the Secret
  100. resource's `data` field to be used. Some instances
  101. of this field may be defaulted, in others it
  102. may be required.
  103. type: string
  104. name:
  105. description: The name of the Secret resource being
  106. referred to.
  107. type: string
  108. namespace:
  109. description: Namespace of the resource being referred
  110. to. Ignored if referent is not cluster-scoped.
  111. cluster-scoped defaults to the namespace of
  112. the referent.
  113. type: string
  114. type: object
  115. accessTypeParam:
  116. description: A reference to a specific 'key' within
  117. a Secret resource, In some instances, `key` is a
  118. required field.
  119. properties:
  120. key:
  121. description: The key of the entry in the Secret
  122. resource's `data` field to be used. Some instances
  123. of this field may be defaulted, in others it
  124. may be required.
  125. type: string
  126. name:
  127. description: The name of the Secret resource being
  128. referred to.
  129. type: string
  130. namespace:
  131. description: Namespace of the resource being referred
  132. to. Ignored if referent is not cluster-scoped.
  133. cluster-scoped defaults to the namespace of
  134. the referent.
  135. type: string
  136. type: object
  137. type: object
  138. required:
  139. - secretRef
  140. type: object
  141. required:
  142. - akeylessGWApiURL
  143. - authSecretRef
  144. type: object
  145. alibaba:
  146. description: Alibaba configures this store to sync secrets using
  147. Alibaba Cloud provider
  148. properties:
  149. auth:
  150. description: AlibabaAuth contains a secretRef for credentials.
  151. properties:
  152. secretRef:
  153. description: AlibabaAuthSecretRef holds secret references
  154. for Alibaba credentials.
  155. properties:
  156. accessKeyIDSecretRef:
  157. description: The AccessKeyID is used for authentication
  158. properties:
  159. key:
  160. description: The key of the entry in the Secret
  161. resource's `data` field to be used. Some instances
  162. of this field may be defaulted, in others it
  163. may be required.
  164. type: string
  165. name:
  166. description: The name of the Secret resource being
  167. referred to.
  168. type: string
  169. namespace:
  170. description: Namespace of the resource being referred
  171. to. Ignored if referent is not cluster-scoped.
  172. cluster-scoped defaults to the namespace of
  173. the referent.
  174. type: string
  175. type: object
  176. accessKeySecretSecretRef:
  177. description: The AccessKeySecret is used for authentication
  178. properties:
  179. key:
  180. description: The key of the entry in the Secret
  181. resource's `data` field to be used. Some instances
  182. of this field may be defaulted, in others it
  183. may be required.
  184. type: string
  185. name:
  186. description: The name of the Secret resource being
  187. referred to.
  188. type: string
  189. namespace:
  190. description: Namespace of the resource being referred
  191. to. Ignored if referent is not cluster-scoped.
  192. cluster-scoped defaults to the namespace of
  193. the referent.
  194. type: string
  195. type: object
  196. required:
  197. - accessKeyIDSecretRef
  198. - accessKeySecretSecretRef
  199. type: object
  200. required:
  201. - secretRef
  202. type: object
  203. endpoint:
  204. type: string
  205. regionID:
  206. description: Alibaba Region to be used for the provider
  207. type: string
  208. required:
  209. - auth
  210. - regionID
  211. type: object
  212. aws:
  213. description: AWS configures this store to sync secrets using AWS
  214. Secret Manager provider
  215. properties:
  216. auth:
  217. description: 'Auth defines the information necessary to authenticate
  218. against AWS if not set aws sdk will infer credentials from
  219. your environment see: https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials'
  220. properties:
  221. jwt:
  222. description: Authenticate against AWS using service account
  223. tokens.
  224. properties:
  225. serviceAccountRef:
  226. description: A reference to a ServiceAccount resource.
  227. properties:
  228. name:
  229. description: The name of the ServiceAccount resource
  230. being referred to.
  231. type: string
  232. namespace:
  233. description: Namespace of the resource being referred
  234. to. Ignored if referent is not cluster-scoped.
  235. cluster-scoped defaults to the namespace of
  236. the referent.
  237. type: string
  238. required:
  239. - name
  240. type: object
  241. type: object
  242. secretRef:
  243. description: AWSAuthSecretRef holds secret references
  244. for AWS credentials both AccessKeyID and SecretAccessKey
  245. must be defined in order to properly authenticate.
  246. properties:
  247. accessKeyIDSecretRef:
  248. description: The AccessKeyID is used for authentication
  249. properties:
  250. key:
  251. description: The key of the entry in the Secret
  252. resource's `data` field to be used. Some instances
  253. of this field may be defaulted, in others it
  254. may be required.
  255. type: string
  256. name:
  257. description: The name of the Secret resource being
  258. referred to.
  259. type: string
  260. namespace:
  261. description: Namespace of the resource being referred
  262. to. Ignored if referent is not cluster-scoped.
  263. cluster-scoped defaults to the namespace of
  264. the referent.
  265. type: string
  266. type: object
  267. secretAccessKeySecretRef:
  268. description: The SecretAccessKey is used for authentication
  269. properties:
  270. key:
  271. description: The key of the entry in the Secret
  272. resource's `data` field to be used. Some instances
  273. of this field may be defaulted, in others it
  274. may be required.
  275. type: string
  276. name:
  277. description: The name of the Secret resource being
  278. referred to.
  279. type: string
  280. namespace:
  281. description: Namespace of the resource being referred
  282. to. Ignored if referent is not cluster-scoped.
  283. cluster-scoped defaults to the namespace of
  284. the referent.
  285. type: string
  286. type: object
  287. type: object
  288. type: object
  289. region:
  290. description: AWS Region to be used for the provider
  291. type: string
  292. role:
  293. description: Role is a Role ARN which the SecretManager provider
  294. will assume
  295. type: string
  296. service:
  297. description: Service defines which service should be used
  298. to fetch the secrets
  299. enum:
  300. - SecretsManager
  301. - ParameterStore
  302. type: string
  303. required:
  304. - region
  305. - service
  306. type: object
  307. azurekv:
  308. description: AzureKV configures this store to sync secrets using
  309. Azure Key Vault provider
  310. properties:
  311. authSecretRef:
  312. description: Auth configures how the operator authenticates
  313. with Azure. Required for ServicePrincipal auth type.
  314. properties:
  315. clientId:
  316. description: The Azure clientId of the service principle
  317. used for authentication.
  318. properties:
  319. key:
  320. description: The key of the entry in the Secret resource's
  321. `data` field to be used. Some instances of this
  322. field may be defaulted, in others it may be required.
  323. type: string
  324. name:
  325. description: The name of the Secret resource being
  326. referred to.
  327. type: string
  328. namespace:
  329. description: Namespace of the resource being referred
  330. to. Ignored if referent is not cluster-scoped. cluster-scoped
  331. defaults to the namespace of the referent.
  332. type: string
  333. type: object
  334. clientSecret:
  335. description: The Azure ClientSecret of the service principle
  336. used for authentication.
  337. properties:
  338. key:
  339. description: The key of the entry in the Secret resource's
  340. `data` field to be used. Some instances of this
  341. field may be defaulted, in others it may be required.
  342. type: string
  343. name:
  344. description: The name of the Secret resource being
  345. referred to.
  346. type: string
  347. namespace:
  348. description: Namespace of the resource being referred
  349. to. Ignored if referent is not cluster-scoped. cluster-scoped
  350. defaults to the namespace of the referent.
  351. type: string
  352. type: object
  353. required:
  354. - clientId
  355. - clientSecret
  356. type: object
  357. authType:
  358. default: ServicePrincipal
  359. description: 'Auth type defines how to authenticate to the
  360. keyvault service. Valid values are: - "ServicePrincipal"
  361. (default): Using a service principal (tenantId, clientId,
  362. clientSecret) - "ManagedIdentity": Using Managed Identity
  363. assigned to the pod (see aad-pod-identity)'
  364. enum:
  365. - ServicePrincipal
  366. - ManagedIdentity
  367. type: string
  368. identityId:
  369. description: If multiple Managed Identity is assigned to the
  370. pod, you can select the one to be used
  371. type: string
  372. tenantId:
  373. description: TenantID configures the Azure Tenant to send
  374. requests to. Required for ServicePrincipal auth type.
  375. type: string
  376. vaultUrl:
  377. description: Vault Url from which the secrets to be fetched
  378. from.
  379. type: string
  380. required:
  381. - vaultUrl
  382. type: object
  383. gcpsm:
  384. description: GCPSM configures this store to sync secrets using
  385. Google Cloud Platform Secret Manager provider
  386. properties:
  387. auth:
  388. description: Auth defines the information necessary to authenticate
  389. against GCP
  390. properties:
  391. secretRef:
  392. properties:
  393. secretAccessKeySecretRef:
  394. description: The SecretAccessKey is used for authentication
  395. properties:
  396. key:
  397. description: The key of the entry in the Secret
  398. resource's `data` field to be used. Some instances
  399. of this field may be defaulted, in others it
  400. may be required.
  401. type: string
  402. name:
  403. description: The name of the Secret resource being
  404. referred to.
  405. type: string
  406. namespace:
  407. description: Namespace of the resource being referred
  408. to. Ignored if referent is not cluster-scoped.
  409. cluster-scoped defaults to the namespace of
  410. the referent.
  411. type: string
  412. type: object
  413. type: object
  414. workloadIdentity:
  415. properties:
  416. clusterLocation:
  417. type: string
  418. clusterName:
  419. type: string
  420. serviceAccountRef:
  421. description: A reference to a ServiceAccount resource.
  422. properties:
  423. name:
  424. description: The name of the ServiceAccount resource
  425. being referred to.
  426. type: string
  427. namespace:
  428. description: Namespace of the resource being referred
  429. to. Ignored if referent is not cluster-scoped.
  430. cluster-scoped defaults to the namespace of
  431. the referent.
  432. type: string
  433. required:
  434. - name
  435. type: object
  436. required:
  437. - clusterLocation
  438. - clusterName
  439. - serviceAccountRef
  440. type: object
  441. type: object
  442. projectID:
  443. description: ProjectID project where secret is located
  444. type: string
  445. type: object
  446. gitlab:
  447. description: GItlab configures this store to sync secrets using
  448. Gitlab Variables provider
  449. properties:
  450. auth:
  451. description: Auth configures how secret-manager authenticates
  452. with a GitLab instance.
  453. properties:
  454. SecretRef:
  455. properties:
  456. accessToken:
  457. description: AccessToken is used for authentication.
  458. properties:
  459. key:
  460. description: The key of the entry in the Secret
  461. resource's `data` field to be used. Some instances
  462. of this field may be defaulted, in others it
  463. may be required.
  464. type: string
  465. name:
  466. description: The name of the Secret resource being
  467. referred to.
  468. type: string
  469. namespace:
  470. description: Namespace of the resource being referred
  471. to. Ignored if referent is not cluster-scoped.
  472. cluster-scoped defaults to the namespace of
  473. the referent.
  474. type: string
  475. type: object
  476. type: object
  477. required:
  478. - SecretRef
  479. type: object
  480. projectID:
  481. description: ProjectID specifies a project where secrets are
  482. located.
  483. type: string
  484. url:
  485. description: URL configures the GitLab instance URL. Defaults
  486. to https://gitlab.com/.
  487. type: string
  488. required:
  489. - auth
  490. type: object
  491. ibm:
  492. description: IBM configures this store to sync secrets using IBM
  493. Cloud provider
  494. properties:
  495. auth:
  496. description: Auth configures how secret-manager authenticates
  497. with the IBM secrets manager.
  498. properties:
  499. secretRef:
  500. properties:
  501. secretApiKeySecretRef:
  502. description: The SecretAccessKey is used for authentication
  503. properties:
  504. key:
  505. description: The key of the entry in the Secret
  506. resource's `data` field to be used. Some instances
  507. of this field may be defaulted, in others it
  508. may be required.
  509. type: string
  510. name:
  511. description: The name of the Secret resource being
  512. referred to.
  513. type: string
  514. namespace:
  515. description: Namespace of the resource being referred
  516. to. Ignored if referent is not cluster-scoped.
  517. cluster-scoped defaults to the namespace of
  518. the referent.
  519. type: string
  520. type: object
  521. type: object
  522. required:
  523. - secretRef
  524. type: object
  525. serviceUrl:
  526. description: ServiceURL is the Endpoint URL that is specific
  527. to the Secrets Manager service instance
  528. type: string
  529. required:
  530. - auth
  531. type: object
  532. kubernetes:
  533. description: Kubernetes configures this store to sync secrets
  534. using a Kubernetes cluster provider
  535. properties:
  536. auth:
  537. description: Auth configures how secret-manager authenticates
  538. with a Kubernetes instance.
  539. properties:
  540. secretRef:
  541. properties:
  542. bearerToken:
  543. description: A reference to a specific 'key' within
  544. a Secret resource, In some instances, `key` is a
  545. required field.
  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. ca:
  565. description: A reference to a specific 'key' within
  566. a Secret resource, In some instances, `key` is a
  567. required field.
  568. properties:
  569. key:
  570. description: The key of the entry in the Secret
  571. resource's `data` field to be used. Some instances
  572. of this field may be defaulted, in others it
  573. may be required.
  574. type: string
  575. name:
  576. description: The name of the Secret resource being
  577. referred to.
  578. type: string
  579. namespace:
  580. description: Namespace of the resource being referred
  581. to. Ignored if referent is not cluster-scoped.
  582. cluster-scoped defaults to the namespace of
  583. the referent.
  584. type: string
  585. type: object
  586. certificate:
  587. description: Certificate is used for authentication.
  588. properties:
  589. key:
  590. description: The key of the entry in the Secret
  591. resource's `data` field to be used. Some instances
  592. of this field may be defaulted, in others it
  593. may be required.
  594. type: string
  595. name:
  596. description: The name of the Secret resource being
  597. referred to.
  598. type: string
  599. namespace:
  600. description: Namespace of the resource being referred
  601. to. Ignored if referent is not cluster-scoped.
  602. cluster-scoped defaults to the namespace of
  603. the referent.
  604. type: string
  605. type: object
  606. key:
  607. description: A reference to a specific 'key' within
  608. a Secret resource, In some instances, `key` is a
  609. required field.
  610. properties:
  611. key:
  612. description: The key of the entry in the Secret
  613. resource's `data` field to be used. Some instances
  614. of this field may be defaulted, in others it
  615. may be required.
  616. type: string
  617. name:
  618. description: The name of the Secret resource being
  619. referred to.
  620. type: string
  621. namespace:
  622. description: Namespace of the resource being referred
  623. to. Ignored if referent is not cluster-scoped.
  624. cluster-scoped defaults to the namespace of
  625. the referent.
  626. type: string
  627. type: object
  628. type: object
  629. required:
  630. - secretRef
  631. type: object
  632. remoteNamespace:
  633. type: string
  634. server:
  635. description: Server configures the Kubernetes instance URL.
  636. type: string
  637. user:
  638. type: string
  639. type: object
  640. oracle:
  641. description: Oracle configures this store to sync secrets using
  642. Oracle Vault provider
  643. properties:
  644. auth:
  645. description: Auth configures how secret-manager authenticates
  646. with the Oracle Vault.
  647. properties:
  648. secretRef:
  649. description: SecretRef to pass through sensitive information.
  650. properties:
  651. fingerprint:
  652. description: Fingerprint is the fingerprint of the
  653. API private key.
  654. properties:
  655. key:
  656. description: The key of the entry in the Secret
  657. resource's `data` field to be used. Some instances
  658. of this field may be defaulted, in others it
  659. may be required.
  660. type: string
  661. name:
  662. description: The name of the Secret resource being
  663. referred to.
  664. type: string
  665. namespace:
  666. description: Namespace of the resource being referred
  667. to. Ignored if referent is not cluster-scoped.
  668. cluster-scoped defaults to the namespace of
  669. the referent.
  670. type: string
  671. type: object
  672. privatekey:
  673. description: PrivateKey is the user's API Signing
  674. Key in PEM format, used for authentication.
  675. properties:
  676. key:
  677. description: The key of the entry in the Secret
  678. resource's `data` field to be used. Some instances
  679. of this field may be defaulted, in others it
  680. may be required.
  681. type: string
  682. name:
  683. description: The name of the Secret resource being
  684. referred to.
  685. type: string
  686. namespace:
  687. description: Namespace of the resource being referred
  688. to. Ignored if referent is not cluster-scoped.
  689. cluster-scoped defaults to the namespace of
  690. the referent.
  691. type: string
  692. type: object
  693. type: object
  694. required:
  695. - secretRef
  696. type: object
  697. region:
  698. description: Region is the region where secret is located.
  699. type: string
  700. tenancy:
  701. description: Tenancy is the tenancy OCID where secret is located.
  702. type: string
  703. user:
  704. description: User is an access OCID specific to the account.
  705. type: string
  706. vault:
  707. description: Vault is the vault's OCID of the specific vault
  708. where secret is located.
  709. type: string
  710. required:
  711. - auth
  712. type: object
  713. vault:
  714. description: Vault configures this store to sync secrets using
  715. Hashi provider
  716. properties:
  717. auth:
  718. description: Auth configures how secret-manager authenticates
  719. with the Vault server.
  720. properties:
  721. appRole:
  722. description: AppRole authenticates with Vault using the
  723. App Role auth mechanism, with the role and secret stored
  724. in a Kubernetes Secret resource.
  725. properties:
  726. path:
  727. default: approle
  728. description: 'Path where the App Role authentication
  729. backend is mounted in Vault, e.g: "approle"'
  730. type: string
  731. roleId:
  732. description: RoleID configured in the App Role authentication
  733. backend when setting up the authentication backend
  734. in Vault.
  735. type: string
  736. secretRef:
  737. description: Reference to a key in a Secret that contains
  738. the App Role secret used to authenticate with Vault.
  739. The `key` field must be specified and denotes which
  740. entry within the Secret resource is used as the
  741. app role secret.
  742. properties:
  743. key:
  744. description: The key of the entry in the Secret
  745. resource's `data` field to be used. Some instances
  746. of this field may be defaulted, in others it
  747. may be required.
  748. type: string
  749. name:
  750. description: The name of the Secret resource being
  751. referred to.
  752. type: string
  753. namespace:
  754. description: Namespace of the resource being referred
  755. to. Ignored if referent is not cluster-scoped.
  756. cluster-scoped defaults to the namespace of
  757. the referent.
  758. type: string
  759. type: object
  760. required:
  761. - path
  762. - roleId
  763. - secretRef
  764. type: object
  765. cert:
  766. description: Cert authenticates with TLS Certificates
  767. by passing client certificate, private key and ca certificate
  768. Cert authentication method
  769. properties:
  770. clientCert:
  771. description: ClientCert is a certificate to authenticate
  772. using the Cert Vault authentication method
  773. properties:
  774. key:
  775. description: The key of the entry in the Secret
  776. resource's `data` field to be used. Some instances
  777. of this field may be defaulted, in others it
  778. may be required.
  779. type: string
  780. name:
  781. description: The name of the Secret resource being
  782. referred to.
  783. type: string
  784. namespace:
  785. description: Namespace of the resource being referred
  786. to. Ignored if referent is not cluster-scoped.
  787. cluster-scoped defaults to the namespace of
  788. the referent.
  789. type: string
  790. type: object
  791. secretRef:
  792. description: SecretRef to a key in a Secret resource
  793. containing client private key to authenticate with
  794. Vault using the Cert authentication method
  795. properties:
  796. key:
  797. description: The key of the entry in the Secret
  798. resource's `data` field to be used. Some instances
  799. of this field may be defaulted, in others it
  800. may be required.
  801. type: string
  802. name:
  803. description: The name of the Secret resource being
  804. referred to.
  805. type: string
  806. namespace:
  807. description: Namespace of the resource being referred
  808. to. Ignored if referent is not cluster-scoped.
  809. cluster-scoped defaults to the namespace of
  810. the referent.
  811. type: string
  812. type: object
  813. type: object
  814. jwt:
  815. description: Jwt authenticates with Vault by passing role
  816. and JWT token using the JWT/OIDC authentication method
  817. properties:
  818. path:
  819. default: jwt
  820. description: 'Path where the JWT authentication backend
  821. is mounted in Vault, e.g: "jwt"'
  822. type: string
  823. role:
  824. description: Role is a JWT role to authenticate using
  825. the JWT/OIDC Vault authentication method
  826. type: string
  827. secretRef:
  828. description: SecretRef to a key in a Secret resource
  829. containing JWT token to authenticate with Vault
  830. using the JWT/OIDC authentication method
  831. properties:
  832. key:
  833. description: The key of the entry in the Secret
  834. resource's `data` field to be used. Some instances
  835. of this field may be defaulted, in others it
  836. may be required.
  837. type: string
  838. name:
  839. description: The name of the Secret resource being
  840. referred to.
  841. type: string
  842. namespace:
  843. description: Namespace of the resource being referred
  844. to. Ignored if referent is not cluster-scoped.
  845. cluster-scoped defaults to the namespace of
  846. the referent.
  847. type: string
  848. type: object
  849. required:
  850. - path
  851. type: object
  852. kubernetes:
  853. description: Kubernetes authenticates with Vault by passing
  854. the ServiceAccount token stored in the named Secret
  855. resource to the Vault server.
  856. properties:
  857. mountPath:
  858. default: kubernetes
  859. description: 'Path where the Kubernetes authentication
  860. backend is mounted in Vault, e.g: "kubernetes"'
  861. type: string
  862. role:
  863. description: A required field containing the Vault
  864. Role to assume. A Role binds a Kubernetes ServiceAccount
  865. with a set of Vault policies.
  866. type: string
  867. secretRef:
  868. description: Optional secret field containing a Kubernetes
  869. ServiceAccount JWT used for authenticating with
  870. Vault. If a name is specified without a key, `token`
  871. is the default. If one is not specified, the one
  872. bound to the controller will be used.
  873. properties:
  874. key:
  875. description: The key of the entry in the Secret
  876. resource's `data` field to be used. Some instances
  877. of this field may be defaulted, in others it
  878. may be required.
  879. type: string
  880. name:
  881. description: The name of the Secret resource being
  882. referred to.
  883. type: string
  884. namespace:
  885. description: Namespace of the resource being referred
  886. to. Ignored if referent is not cluster-scoped.
  887. cluster-scoped defaults to the namespace of
  888. the referent.
  889. type: string
  890. type: object
  891. serviceAccountRef:
  892. description: Optional service account field containing
  893. the name of a kubernetes ServiceAccount. If the
  894. service account is specified, the service account
  895. secret token JWT will be used for authenticating
  896. with Vault. If the service account selector is not
  897. supplied, the secretRef will be used instead.
  898. properties:
  899. name:
  900. description: The name of the ServiceAccount resource
  901. being referred to.
  902. type: string
  903. namespace:
  904. description: Namespace of the resource being referred
  905. to. Ignored if referent is not cluster-scoped.
  906. cluster-scoped defaults to the namespace of
  907. the referent.
  908. type: string
  909. required:
  910. - name
  911. type: object
  912. required:
  913. - mountPath
  914. - role
  915. type: object
  916. ldap:
  917. description: Ldap authenticates with Vault by passing
  918. username/password pair using the LDAP authentication
  919. method
  920. properties:
  921. path:
  922. default: ldap
  923. description: 'Path where the LDAP authentication backend
  924. is mounted in Vault, e.g: "ldap"'
  925. type: string
  926. secretRef:
  927. description: SecretRef to a key in a Secret resource
  928. containing password for the LDAP user used to authenticate
  929. with Vault using the LDAP authentication method
  930. properties:
  931. key:
  932. description: The key of the entry in the Secret
  933. resource's `data` field to be used. Some instances
  934. of this field may be defaulted, in others it
  935. may be required.
  936. type: string
  937. name:
  938. description: The name of the Secret resource being
  939. referred to.
  940. type: string
  941. namespace:
  942. description: Namespace of the resource being referred
  943. to. Ignored if referent is not cluster-scoped.
  944. cluster-scoped defaults to the namespace of
  945. the referent.
  946. type: string
  947. type: object
  948. username:
  949. description: Username is a LDAP user name used to
  950. authenticate using the LDAP Vault authentication
  951. method
  952. type: string
  953. required:
  954. - path
  955. - username
  956. type: object
  957. tokenSecretRef:
  958. description: TokenSecretRef authenticates with Vault by
  959. presenting a token.
  960. properties:
  961. key:
  962. description: The key of the entry in the Secret resource's
  963. `data` field to be used. Some instances of this
  964. field may be defaulted, in others it may be required.
  965. type: string
  966. name:
  967. description: The name of the Secret resource being
  968. referred to.
  969. type: string
  970. namespace:
  971. description: Namespace of the resource being referred
  972. to. Ignored if referent is not cluster-scoped. cluster-scoped
  973. defaults to the namespace of the referent.
  974. type: string
  975. type: object
  976. type: object
  977. caBundle:
  978. description: PEM encoded CA bundle used to validate Vault
  979. server certificate. Only used if the Server URL is using
  980. HTTPS protocol. This parameter is ignored for plain HTTP
  981. protocol connection. If not set the system root certificates
  982. are used to validate the TLS connection.
  983. format: byte
  984. type: string
  985. caProvider:
  986. description: The provider for the CA bundle to use to validate
  987. Vault server certificate.
  988. properties:
  989. key:
  990. description: The key the value inside of the provider
  991. type to use, only used with "Secret" type
  992. type: string
  993. name:
  994. description: The name of the object located at the provider
  995. type.
  996. type: string
  997. namespace:
  998. description: The namespace the Provider type is in.
  999. type: string
  1000. type:
  1001. description: The type of provider to use such as "Secret",
  1002. or "ConfigMap".
  1003. enum:
  1004. - Secret
  1005. - ConfigMap
  1006. type: string
  1007. required:
  1008. - name
  1009. - type
  1010. type: object
  1011. forwardInconsistent:
  1012. description: ForwardInconsistent tells Vault to forward read-after-write
  1013. requests to the Vault leader instead of simply retrying
  1014. within a loop. This can increase performance if the option
  1015. is enabled serverside. https://www.vaultproject.io/docs/configuration/replication#allow_forwarding_via_header
  1016. type: boolean
  1017. namespace:
  1018. description: 'Name of the vault namespace. Namespaces is a
  1019. set of features within Vault Enterprise that allows Vault
  1020. environments to support Secure Multi-tenancy. e.g: "ns1".
  1021. More about namespaces can be found here https://www.vaultproject.io/docs/enterprise/namespaces'
  1022. type: string
  1023. path:
  1024. description: 'Path is the mount path of the Vault KV backend
  1025. endpoint, e.g: "secret". The v2 KV secret engine version
  1026. specific "/data" path suffix for fetching secrets from Vault
  1027. is optional and will be appended if not present in specified
  1028. path.'
  1029. type: string
  1030. readYourWrites:
  1031. description: ReadYourWrites ensures isolated read-after-write
  1032. semantics by providing discovered cluster replication states
  1033. in each request. More information about eventual consistency
  1034. in Vault can be found here https://www.vaultproject.io/docs/enterprise/consistency
  1035. type: boolean
  1036. server:
  1037. description: 'Server is the connection address for the Vault
  1038. server, e.g: "https://vault.example.com:8200".'
  1039. type: string
  1040. version:
  1041. default: v2
  1042. description: Version is the Vault KV secret engine version.
  1043. This can be either "v1" or "v2". Version defaults to "v2".
  1044. enum:
  1045. - v1
  1046. - v2
  1047. type: string
  1048. required:
  1049. - auth
  1050. - server
  1051. type: object
  1052. webhook:
  1053. description: Webhook configures this store to sync secrets using
  1054. a generic templated webhook
  1055. properties:
  1056. body:
  1057. description: Body
  1058. type: string
  1059. caBundle:
  1060. description: PEM encoded CA bundle used to validate webhook
  1061. server certificate. Only used if the Server URL is using
  1062. HTTPS protocol. This parameter is ignored for plain HTTP
  1063. protocol connection. If not set the system root certificates
  1064. are used to validate the TLS connection.
  1065. format: byte
  1066. type: string
  1067. caProvider:
  1068. description: The provider for the CA bundle to use to validate
  1069. webhook server certificate.
  1070. properties:
  1071. key:
  1072. description: The key the value inside of the provider
  1073. type to use, only used with "Secret" type
  1074. type: string
  1075. name:
  1076. description: The name of the object located at the provider
  1077. type.
  1078. type: string
  1079. namespace:
  1080. description: The namespace the Provider type is in.
  1081. type: string
  1082. type:
  1083. description: The type of provider to use such as "Secret",
  1084. or "ConfigMap".
  1085. enum:
  1086. - Secret
  1087. - ConfigMap
  1088. type: string
  1089. required:
  1090. - name
  1091. - type
  1092. type: object
  1093. headers:
  1094. additionalProperties:
  1095. type: string
  1096. description: Headers
  1097. type: object
  1098. method:
  1099. description: Webhook Method
  1100. type: string
  1101. result:
  1102. description: Result formatting
  1103. properties:
  1104. jsonPath:
  1105. description: Json path of return value
  1106. type: string
  1107. type: object
  1108. secrets:
  1109. description: Secrets to fill in templates These secrets will
  1110. be passed to the templating function as key value pairs
  1111. under the given name
  1112. items:
  1113. properties:
  1114. name:
  1115. description: Name of this secret in templates
  1116. type: string
  1117. secretRef:
  1118. description: Secret ref to fill in credentials
  1119. properties:
  1120. key:
  1121. description: The key of the entry in the Secret
  1122. resource's `data` field to be used. Some instances
  1123. of this field may be defaulted, in others it may
  1124. be required.
  1125. type: string
  1126. name:
  1127. description: The name of the Secret resource being
  1128. referred to.
  1129. type: string
  1130. namespace:
  1131. description: Namespace of the resource being referred
  1132. to. Ignored if referent is not cluster-scoped.
  1133. cluster-scoped defaults to the namespace of the
  1134. referent.
  1135. type: string
  1136. type: object
  1137. required:
  1138. - name
  1139. - secretRef
  1140. type: object
  1141. type: array
  1142. timeout:
  1143. description: Timeout
  1144. type: string
  1145. url:
  1146. description: Webhook url to call
  1147. type: string
  1148. required:
  1149. - result
  1150. - url
  1151. type: object
  1152. yandexlockbox:
  1153. description: YandexLockbox configures this store to sync secrets
  1154. using Yandex Lockbox provider
  1155. properties:
  1156. apiEndpoint:
  1157. description: Yandex.Cloud API endpoint (e.g. 'api.cloud.yandex.net:443')
  1158. type: string
  1159. auth:
  1160. description: Auth defines the information necessary to authenticate
  1161. against Yandex Lockbox
  1162. properties:
  1163. authorizedKeySecretRef:
  1164. description: The authorized key used for authentication
  1165. properties:
  1166. key:
  1167. description: The key of the entry in the Secret resource's
  1168. `data` field to be used. Some instances of this
  1169. field may be defaulted, in others it may be required.
  1170. type: string
  1171. name:
  1172. description: The name of the Secret resource being
  1173. referred to.
  1174. type: string
  1175. namespace:
  1176. description: Namespace of the resource being referred
  1177. to. Ignored if referent is not cluster-scoped. cluster-scoped
  1178. defaults to the namespace of the referent.
  1179. type: string
  1180. type: object
  1181. type: object
  1182. caProvider:
  1183. description: The provider for the CA bundle to use to validate
  1184. Yandex.Cloud server certificate.
  1185. properties:
  1186. certSecretRef:
  1187. description: A reference to a specific 'key' within a
  1188. Secret resource, In some instances, `key` is a required
  1189. field.
  1190. properties:
  1191. key:
  1192. description: The key of the entry in the Secret resource's
  1193. `data` field to be used. Some instances of this
  1194. field may be defaulted, in others it may be required.
  1195. type: string
  1196. name:
  1197. description: The name of the Secret resource being
  1198. referred to.
  1199. type: string
  1200. namespace:
  1201. description: Namespace of the resource being referred
  1202. to. Ignored if referent is not cluster-scoped. cluster-scoped
  1203. defaults to the namespace of the referent.
  1204. type: string
  1205. type: object
  1206. type: object
  1207. required:
  1208. - auth
  1209. type: object
  1210. type: object
  1211. retrySettings:
  1212. description: Used to configure http retries if failed
  1213. properties:
  1214. maxRetries:
  1215. format: int32
  1216. type: integer
  1217. retryInterval:
  1218. type: string
  1219. type: object
  1220. required:
  1221. - provider
  1222. type: object
  1223. status:
  1224. description: SecretStoreStatus defines the observed state of the SecretStore.
  1225. properties:
  1226. conditions:
  1227. items:
  1228. properties:
  1229. lastTransitionTime:
  1230. format: date-time
  1231. type: string
  1232. message:
  1233. type: string
  1234. reason:
  1235. type: string
  1236. status:
  1237. type: string
  1238. type:
  1239. type: string
  1240. required:
  1241. - status
  1242. - type
  1243. type: object
  1244. type: array
  1245. type: object
  1246. type: object
  1247. served: true
  1248. storage: true
  1249. subresources:
  1250. status: {}
  1251. status:
  1252. acceptedNames:
  1253. kind: ""
  1254. plural: ""
  1255. conditions: []
  1256. storedVersions: []