external-secrets.io_externalsecrets.yaml 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571
  1. apiVersion: apiextensions.k8s.io/v1
  2. kind: CustomResourceDefinition
  3. metadata:
  4. annotations:
  5. controller-gen.kubebuilder.io/version: v0.9.2
  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. - jsonPath: .status.conditions[?(@.type=="Ready")].status
  276. name: Ready
  277. type: string
  278. name: v1beta1
  279. schema:
  280. openAPIV3Schema:
  281. description: ExternalSecret is the Schema for the external-secrets API.
  282. properties:
  283. apiVersion:
  284. description: 'APIVersion defines the versioned schema of this representation
  285. of an object. Servers should convert recognized schemas to the latest
  286. internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
  287. type: string
  288. kind:
  289. description: 'Kind is a string value representing the REST resource this
  290. object represents. Servers may infer this from the endpoint the client
  291. submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
  292. type: string
  293. metadata:
  294. type: object
  295. spec:
  296. description: ExternalSecretSpec defines the desired state of ExternalSecret.
  297. properties:
  298. data:
  299. description: Data defines the connection between the Kubernetes Secret
  300. keys and the Provider data
  301. items:
  302. description: ExternalSecretData defines the connection between the
  303. Kubernetes Secret key (spec.data.<key>) and the Provider data.
  304. properties:
  305. remoteRef:
  306. description: ExternalSecretDataRemoteRef defines Provider data
  307. location.
  308. properties:
  309. conversionStrategy:
  310. default: Default
  311. description: Used to define a conversion Strategy
  312. type: string
  313. decodingStrategy:
  314. default: None
  315. description: Used to define a conversion Strategy
  316. type: string
  317. key:
  318. description: Key is the key used in the Provider, mandatory
  319. type: string
  320. metadataPolicy:
  321. description: Policy for fetching tags/labels from provider
  322. secrets, possible options are Fetch, None. Defaults to
  323. None
  324. type: string
  325. property:
  326. description: Used to select a specific property of the Provider
  327. value (if a map), if supported
  328. type: string
  329. version:
  330. description: Used to select a specific version of the Provider
  331. value, if supported
  332. type: string
  333. required:
  334. - key
  335. type: object
  336. secretKey:
  337. type: string
  338. required:
  339. - remoteRef
  340. - secretKey
  341. type: object
  342. type: array
  343. dataFrom:
  344. description: DataFrom is used to fetch all properties from a specific
  345. Provider data If multiple entries are specified, the Secret keys
  346. are merged in the specified order
  347. items:
  348. maxProperties: 1
  349. minProperties: 1
  350. properties:
  351. extract:
  352. description: Used to extract multiple key/value pairs from one
  353. secret
  354. properties:
  355. conversionStrategy:
  356. default: Default
  357. description: Used to define a conversion Strategy
  358. type: string
  359. decodingStrategy:
  360. default: None
  361. description: Used to define a conversion Strategy
  362. type: string
  363. key:
  364. description: Key is the key used in the Provider, mandatory
  365. type: string
  366. metadataPolicy:
  367. description: Policy for fetching tags/labels from provider
  368. secrets, possible options are Fetch, None. Defaults to
  369. None
  370. type: string
  371. property:
  372. description: Used to select a specific property of the Provider
  373. value (if a map), if supported
  374. type: string
  375. version:
  376. description: Used to select a specific version of the Provider
  377. value, if supported
  378. type: string
  379. required:
  380. - key
  381. type: object
  382. find:
  383. description: Used to find secrets based on tags or regular expressions
  384. properties:
  385. conversionStrategy:
  386. default: Default
  387. description: Used to define a conversion Strategy
  388. type: string
  389. decodingStrategy:
  390. default: None
  391. description: Used to define a conversion Strategy
  392. type: string
  393. name:
  394. description: Finds secrets based on the name.
  395. properties:
  396. regexp:
  397. description: Finds secrets base
  398. type: string
  399. type: object
  400. path:
  401. description: A root path to start the find operations.
  402. type: string
  403. tags:
  404. additionalProperties:
  405. type: string
  406. description: Find secrets based on tags.
  407. type: object
  408. type: object
  409. type: object
  410. type: array
  411. refreshInterval:
  412. default: 1h
  413. description: RefreshInterval is the amount of time before the values
  414. are read again from the SecretStore provider Valid time units are
  415. "ns", "us" (or "µs"), "ms", "s", "m", "h" May be set to zero to
  416. fetch and create it once. Defaults to 1h.
  417. type: string
  418. secretStoreRef:
  419. description: SecretStoreRef defines which SecretStore to fetch the
  420. ExternalSecret data.
  421. properties:
  422. kind:
  423. description: Kind of the SecretStore resource (SecretStore or
  424. ClusterSecretStore) Defaults to `SecretStore`
  425. type: string
  426. name:
  427. description: Name of the SecretStore resource
  428. type: string
  429. required:
  430. - name
  431. type: object
  432. target:
  433. description: ExternalSecretTarget defines the Kubernetes Secret to
  434. be created There can be only one target per ExternalSecret.
  435. properties:
  436. creationPolicy:
  437. default: Owner
  438. description: CreationPolicy defines rules on how to create the
  439. resulting Secret Defaults to 'Owner'
  440. enum:
  441. - Owner
  442. - Orphan
  443. - Merge
  444. - None
  445. type: string
  446. deletionPolicy:
  447. default: Retain
  448. description: DeletionPolicy defines rules on how to delete the
  449. resulting Secret Defaults to 'Retain'
  450. enum:
  451. - Delete
  452. - Merge
  453. - Retain
  454. type: string
  455. immutable:
  456. description: Immutable defines if the final secret will be immutable
  457. type: boolean
  458. name:
  459. description: Name defines the name of the Secret resource to be
  460. managed This field is immutable Defaults to the .metadata.name
  461. of the ExternalSecret resource
  462. type: string
  463. template:
  464. description: Template defines a blueprint for the created Secret
  465. resource.
  466. properties:
  467. data:
  468. additionalProperties:
  469. type: string
  470. type: object
  471. engineVersion:
  472. default: v2
  473. type: string
  474. metadata:
  475. description: ExternalSecretTemplateMetadata defines metadata
  476. fields for the Secret blueprint.
  477. properties:
  478. annotations:
  479. additionalProperties:
  480. type: string
  481. type: object
  482. labels:
  483. additionalProperties:
  484. type: string
  485. type: object
  486. type: object
  487. templateFrom:
  488. items:
  489. maxProperties: 1
  490. minProperties: 1
  491. properties:
  492. configMap:
  493. properties:
  494. items:
  495. items:
  496. properties:
  497. key:
  498. type: string
  499. required:
  500. - key
  501. type: object
  502. type: array
  503. name:
  504. type: string
  505. required:
  506. - items
  507. - name
  508. type: object
  509. secret:
  510. properties:
  511. items:
  512. items:
  513. properties:
  514. key:
  515. type: string
  516. required:
  517. - key
  518. type: object
  519. type: array
  520. name:
  521. type: string
  522. required:
  523. - items
  524. - name
  525. type: object
  526. type: object
  527. type: array
  528. type:
  529. type: string
  530. type: object
  531. type: object
  532. required:
  533. - secretStoreRef
  534. type: object
  535. status:
  536. properties:
  537. conditions:
  538. items:
  539. properties:
  540. lastTransitionTime:
  541. format: date-time
  542. type: string
  543. message:
  544. type: string
  545. reason:
  546. type: string
  547. status:
  548. type: string
  549. type:
  550. type: string
  551. required:
  552. - status
  553. - type
  554. type: object
  555. type: array
  556. refreshTime:
  557. description: refreshTime is the time and date the external secret
  558. was fetched and the target secret updated
  559. format: date-time
  560. nullable: true
  561. type: string
  562. syncedResourceVersion:
  563. description: SyncedResourceVersion keeps track of the last synced
  564. version
  565. type: string
  566. type: object
  567. type: object
  568. served: true
  569. storage: true
  570. subresources:
  571. status: {}