external-secrets.io_externalsecrets.yaml 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568
  1. apiVersion: apiextensions.k8s.io/v1
  2. kind: CustomResourceDefinition
  3. metadata:
  4. annotations:
  5. controller-gen.kubebuilder.io/version: v0.9.0
  6. creationTimestamp: null
  7. name: externalsecrets.external-secrets.io
  8. spec:
  9. group: external-secrets.io
  10. names:
  11. categories:
  12. - externalsecrets
  13. kind: ExternalSecret
  14. listKind: ExternalSecretList
  15. plural: externalsecrets
  16. shortNames:
  17. - es
  18. singular: externalsecret
  19. scope: Namespaced
  20. versions:
  21. - additionalPrinterColumns:
  22. - jsonPath: .spec.secretStoreRef.name
  23. name: Store
  24. type: string
  25. - jsonPath: .spec.refreshInterval
  26. name: Refresh Interval
  27. type: string
  28. - jsonPath: .status.conditions[?(@.type=="Ready")].reason
  29. name: Status
  30. type: string
  31. deprecated: true
  32. name: v1alpha1
  33. schema:
  34. openAPIV3Schema:
  35. description: ExternalSecret is the Schema for the external-secrets API.
  36. properties:
  37. apiVersion:
  38. description: 'APIVersion defines the versioned schema of this representation
  39. of an object. Servers should convert recognized schemas to the latest
  40. internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
  41. type: string
  42. kind:
  43. description: 'Kind is a string value representing the REST resource this
  44. object represents. Servers may infer this from the endpoint the client
  45. submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
  46. type: string
  47. metadata:
  48. type: object
  49. spec:
  50. description: ExternalSecretSpec defines the desired state of ExternalSecret.
  51. properties:
  52. data:
  53. description: Data defines the connection between the Kubernetes Secret
  54. keys and the Provider data
  55. items:
  56. description: ExternalSecretData defines the connection between the
  57. Kubernetes Secret key (spec.data.<key>) and the Provider data.
  58. properties:
  59. remoteRef:
  60. description: ExternalSecretDataRemoteRef defines Provider data
  61. location.
  62. properties:
  63. conversionStrategy:
  64. default: Default
  65. description: Used to define a conversion Strategy
  66. type: string
  67. key:
  68. description: Key is the key used in the Provider, mandatory
  69. type: string
  70. property:
  71. description: Used to select a specific property of the Provider
  72. value (if a map), if supported
  73. type: string
  74. version:
  75. description: Used to select a specific version of the Provider
  76. value, if supported
  77. type: string
  78. required:
  79. - key
  80. type: object
  81. secretKey:
  82. type: string
  83. required:
  84. - remoteRef
  85. - secretKey
  86. type: object
  87. type: array
  88. dataFrom:
  89. description: DataFrom is used to fetch all properties from a specific
  90. Provider data If multiple entries are specified, the Secret keys
  91. are merged in the specified order
  92. items:
  93. description: ExternalSecretDataRemoteRef defines Provider data location.
  94. properties:
  95. conversionStrategy:
  96. default: Default
  97. description: Used to define a conversion Strategy
  98. type: string
  99. key:
  100. description: Key is the key used in the Provider, mandatory
  101. type: string
  102. property:
  103. description: Used to select a specific property of the Provider
  104. value (if a map), if supported
  105. type: string
  106. version:
  107. description: Used to select a specific version of the Provider
  108. value, if supported
  109. type: string
  110. required:
  111. - key
  112. type: object
  113. type: array
  114. refreshInterval:
  115. default: 1h
  116. description: RefreshInterval is the amount of time before the values
  117. are read again from the SecretStore provider Valid time units are
  118. "ns", "us" (or "µs"), "ms", "s", "m", "h" May be set to zero to
  119. fetch and create it once. Defaults to 1h.
  120. type: string
  121. secretStoreRef:
  122. description: SecretStoreRef defines which SecretStore to fetch the
  123. ExternalSecret data.
  124. properties:
  125. kind:
  126. description: Kind of the SecretStore resource (SecretStore or
  127. ClusterSecretStore) Defaults to `SecretStore`
  128. type: string
  129. name:
  130. description: Name of the SecretStore resource
  131. type: string
  132. required:
  133. - name
  134. type: object
  135. target:
  136. description: ExternalSecretTarget defines the Kubernetes Secret to
  137. be created There can be only one target per ExternalSecret.
  138. properties:
  139. creationPolicy:
  140. default: Owner
  141. description: CreationPolicy defines rules on how to create the
  142. resulting Secret Defaults to 'Owner'
  143. type: string
  144. immutable:
  145. description: Immutable defines if the final secret will be immutable
  146. type: boolean
  147. name:
  148. description: Name defines the name of the Secret resource to be
  149. managed This field is immutable Defaults to the .metadata.name
  150. of the ExternalSecret resource
  151. type: string
  152. template:
  153. description: Template defines a blueprint for the created Secret
  154. resource.
  155. properties:
  156. data:
  157. additionalProperties:
  158. type: string
  159. type: object
  160. engineVersion:
  161. default: v1
  162. description: EngineVersion specifies the template engine version
  163. that should be used to compile/execute the template specified
  164. in .data and .templateFrom[].
  165. type: string
  166. metadata:
  167. description: ExternalSecretTemplateMetadata defines metadata
  168. fields for the Secret blueprint.
  169. properties:
  170. annotations:
  171. additionalProperties:
  172. type: string
  173. type: object
  174. labels:
  175. additionalProperties:
  176. type: string
  177. type: object
  178. type: object
  179. templateFrom:
  180. items:
  181. maxProperties: 1
  182. minProperties: 1
  183. properties:
  184. configMap:
  185. properties:
  186. items:
  187. items:
  188. properties:
  189. key:
  190. type: string
  191. required:
  192. - key
  193. type: object
  194. type: array
  195. name:
  196. type: string
  197. required:
  198. - items
  199. - name
  200. type: object
  201. secret:
  202. properties:
  203. items:
  204. items:
  205. properties:
  206. key:
  207. type: string
  208. required:
  209. - key
  210. type: object
  211. type: array
  212. name:
  213. type: string
  214. required:
  215. - items
  216. - name
  217. type: object
  218. type: object
  219. type: array
  220. type:
  221. type: string
  222. type: object
  223. type: object
  224. required:
  225. - secretStoreRef
  226. - target
  227. type: object
  228. status:
  229. properties:
  230. conditions:
  231. items:
  232. properties:
  233. lastTransitionTime:
  234. format: date-time
  235. type: string
  236. message:
  237. type: string
  238. reason:
  239. type: string
  240. status:
  241. type: string
  242. type:
  243. type: string
  244. required:
  245. - status
  246. - type
  247. type: object
  248. type: array
  249. refreshTime:
  250. description: refreshTime is the time and date the external secret
  251. was fetched and the target secret updated
  252. format: date-time
  253. nullable: true
  254. type: string
  255. syncedResourceVersion:
  256. description: SyncedResourceVersion keeps track of the last synced
  257. version
  258. type: string
  259. type: object
  260. type: object
  261. served: true
  262. storage: false
  263. subresources:
  264. status: {}
  265. - additionalPrinterColumns:
  266. - jsonPath: .spec.secretStoreRef.name
  267. name: Store
  268. type: string
  269. - jsonPath: .spec.refreshInterval
  270. name: Refresh Interval
  271. type: string
  272. - jsonPath: .status.conditions[?(@.type=="Ready")].reason
  273. name: Status
  274. type: string
  275. name: v1beta1
  276. schema:
  277. openAPIV3Schema:
  278. description: ExternalSecret is the Schema for the external-secrets API.
  279. properties:
  280. apiVersion:
  281. description: 'APIVersion defines the versioned schema of this representation
  282. of an object. Servers should convert recognized schemas to the latest
  283. internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
  284. type: string
  285. kind:
  286. description: 'Kind is a string value representing the REST resource this
  287. object represents. Servers may infer this from the endpoint the client
  288. submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
  289. type: string
  290. metadata:
  291. type: object
  292. spec:
  293. description: ExternalSecretSpec defines the desired state of ExternalSecret.
  294. properties:
  295. data:
  296. description: Data defines the connection between the Kubernetes Secret
  297. keys and the Provider data
  298. items:
  299. description: ExternalSecretData defines the connection between the
  300. Kubernetes Secret key (spec.data.<key>) and the Provider data.
  301. properties:
  302. remoteRef:
  303. description: ExternalSecretDataRemoteRef defines Provider data
  304. location.
  305. properties:
  306. conversionStrategy:
  307. default: Default
  308. description: Used to define a conversion Strategy
  309. type: string
  310. decodingStrategy:
  311. default: None
  312. description: Used to define a conversion Strategy
  313. type: string
  314. key:
  315. description: Key is the key used in the Provider, mandatory
  316. type: string
  317. metadataPolicy:
  318. description: Policy for fetching tags/labels from provider
  319. secrets, possible options are Fetch, None. Defaults to
  320. None
  321. type: string
  322. property:
  323. description: Used to select a specific property of the Provider
  324. value (if a map), if supported
  325. type: string
  326. version:
  327. description: Used to select a specific version of the Provider
  328. value, if supported
  329. type: string
  330. required:
  331. - key
  332. type: object
  333. secretKey:
  334. type: string
  335. required:
  336. - remoteRef
  337. - secretKey
  338. type: object
  339. type: array
  340. dataFrom:
  341. description: DataFrom is used to fetch all properties from a specific
  342. Provider data If multiple entries are specified, the Secret keys
  343. are merged in the specified order
  344. items:
  345. maxProperties: 1
  346. minProperties: 1
  347. properties:
  348. extract:
  349. description: Used to extract multiple key/value pairs from one
  350. secret
  351. properties:
  352. conversionStrategy:
  353. default: Default
  354. description: Used to define a conversion Strategy
  355. type: string
  356. decodingStrategy:
  357. default: None
  358. description: Used to define a conversion Strategy
  359. type: string
  360. key:
  361. description: Key is the key used in the Provider, mandatory
  362. type: string
  363. metadataPolicy:
  364. description: Policy for fetching tags/labels from provider
  365. secrets, possible options are Fetch, None. Defaults to
  366. None
  367. type: string
  368. property:
  369. description: Used to select a specific property of the Provider
  370. value (if a map), if supported
  371. type: string
  372. version:
  373. description: Used to select a specific version of the Provider
  374. value, if supported
  375. type: string
  376. required:
  377. - key
  378. type: object
  379. find:
  380. description: Used to find secrets based on tags or regular expressions
  381. properties:
  382. conversionStrategy:
  383. default: Default
  384. description: Used to define a conversion Strategy
  385. type: string
  386. decodingStrategy:
  387. default: None
  388. description: Used to define a conversion Strategy
  389. type: string
  390. name:
  391. description: Finds secrets based on the name.
  392. properties:
  393. regexp:
  394. description: Finds secrets base
  395. type: string
  396. type: object
  397. path:
  398. description: A root path to start the find operations.
  399. type: string
  400. tags:
  401. additionalProperties:
  402. type: string
  403. description: Find secrets based on tags.
  404. type: object
  405. type: object
  406. type: object
  407. type: array
  408. refreshInterval:
  409. default: 1h
  410. description: RefreshInterval is the amount of time before the values
  411. are read again from the SecretStore provider Valid time units are
  412. "ns", "us" (or "µs"), "ms", "s", "m", "h" May be set to zero to
  413. fetch and create it once. Defaults to 1h.
  414. type: string
  415. secretStoreRef:
  416. description: SecretStoreRef defines which SecretStore to fetch the
  417. ExternalSecret data.
  418. properties:
  419. kind:
  420. description: Kind of the SecretStore resource (SecretStore or
  421. ClusterSecretStore) Defaults to `SecretStore`
  422. type: string
  423. name:
  424. description: Name of the SecretStore resource
  425. type: string
  426. required:
  427. - name
  428. type: object
  429. target:
  430. description: ExternalSecretTarget defines the Kubernetes Secret to
  431. be created There can be only one target per ExternalSecret.
  432. properties:
  433. creationPolicy:
  434. default: Owner
  435. description: CreationPolicy defines rules on how to create the
  436. resulting Secret Defaults to 'Owner'
  437. enum:
  438. - Owner
  439. - Orphan
  440. - Merge
  441. - None
  442. type: string
  443. deletionPolicy:
  444. default: Retain
  445. description: DeletionPolicy defines rules on how to delete the
  446. resulting Secret Defaults to 'Retain'
  447. enum:
  448. - Delete
  449. - Merge
  450. - Retain
  451. type: string
  452. immutable:
  453. description: Immutable defines if the final secret will be immutable
  454. type: boolean
  455. name:
  456. description: Name defines the name of the Secret resource to be
  457. managed This field is immutable Defaults to the .metadata.name
  458. of the ExternalSecret resource
  459. type: string
  460. template:
  461. description: Template defines a blueprint for the created Secret
  462. resource.
  463. properties:
  464. data:
  465. additionalProperties:
  466. type: string
  467. type: object
  468. engineVersion:
  469. default: v2
  470. type: string
  471. metadata:
  472. description: ExternalSecretTemplateMetadata defines metadata
  473. fields for the Secret blueprint.
  474. properties:
  475. annotations:
  476. additionalProperties:
  477. type: string
  478. type: object
  479. labels:
  480. additionalProperties:
  481. type: string
  482. type: object
  483. type: object
  484. templateFrom:
  485. items:
  486. maxProperties: 1
  487. minProperties: 1
  488. properties:
  489. configMap:
  490. properties:
  491. items:
  492. items:
  493. properties:
  494. key:
  495. type: string
  496. required:
  497. - key
  498. type: object
  499. type: array
  500. name:
  501. type: string
  502. required:
  503. - items
  504. - name
  505. type: object
  506. secret:
  507. properties:
  508. items:
  509. items:
  510. properties:
  511. key:
  512. type: string
  513. required:
  514. - key
  515. type: object
  516. type: array
  517. name:
  518. type: string
  519. required:
  520. - items
  521. - name
  522. type: object
  523. type: object
  524. type: array
  525. type:
  526. type: string
  527. type: object
  528. type: object
  529. required:
  530. - secretStoreRef
  531. type: object
  532. status:
  533. properties:
  534. conditions:
  535. items:
  536. properties:
  537. lastTransitionTime:
  538. format: date-time
  539. type: string
  540. message:
  541. type: string
  542. reason:
  543. type: string
  544. status:
  545. type: string
  546. type:
  547. type: string
  548. required:
  549. - status
  550. - type
  551. type: object
  552. type: array
  553. refreshTime:
  554. description: refreshTime is the time and date the external secret
  555. was fetched and the target secret updated
  556. format: date-time
  557. nullable: true
  558. type: string
  559. syncedResourceVersion:
  560. description: SyncedResourceVersion keeps track of the last synced
  561. version
  562. type: string
  563. type: object
  564. type: object
  565. served: true
  566. storage: true
  567. subresources:
  568. status: {}