external-secrets.io_pushsecrets.yaml 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528
  1. apiVersion: apiextensions.k8s.io/v1
  2. kind: CustomResourceDefinition
  3. metadata:
  4. annotations:
  5. controller-gen.kubebuilder.io/version: v0.19.0
  6. labels:
  7. external-secrets.io/component: controller
  8. name: pushsecrets.external-secrets.io
  9. spec:
  10. group: external-secrets.io
  11. names:
  12. categories:
  13. - external-secrets
  14. kind: PushSecret
  15. listKind: PushSecretList
  16. plural: pushsecrets
  17. shortNames:
  18. - ps
  19. singular: pushsecret
  20. scope: Namespaced
  21. versions:
  22. - additionalPrinterColumns:
  23. - jsonPath: .metadata.creationTimestamp
  24. name: AGE
  25. type: date
  26. - jsonPath: .status.conditions[?(@.type=="Ready")].reason
  27. name: Status
  28. type: string
  29. - jsonPath: .status.refreshTime
  30. name: Last Sync
  31. type: date
  32. name: v1alpha1
  33. schema:
  34. openAPIV3Schema:
  35. description: PushSecret is the Schema for the PushSecrets API that enables
  36. pushing Kubernetes secrets to external secret providers.
  37. properties:
  38. apiVersion:
  39. description: |-
  40. APIVersion defines the versioned schema of this representation of an object.
  41. Servers should convert recognized schemas to the latest internal value, and
  42. may reject unrecognized values.
  43. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
  44. type: string
  45. kind:
  46. description: |-
  47. Kind is a string value representing the REST resource this object represents.
  48. Servers may infer this from the endpoint the client submits requests to.
  49. Cannot be updated.
  50. In CamelCase.
  51. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
  52. type: string
  53. metadata:
  54. type: object
  55. spec:
  56. description: PushSecretSpec configures the behavior of the PushSecret.
  57. properties:
  58. data:
  59. description: Secret Data that should be pushed to providers
  60. items:
  61. description: PushSecretData defines data to be pushed to the provider
  62. and associated metadata.
  63. properties:
  64. conversionStrategy:
  65. default: None
  66. description: Used to define a conversion Strategy for the secret
  67. keys
  68. enum:
  69. - None
  70. - ReverseUnicode
  71. type: string
  72. match:
  73. description: Match a given Secret Key to be pushed to the provider.
  74. properties:
  75. remoteRef:
  76. description: Remote Refs to push to providers.
  77. properties:
  78. property:
  79. description: Name of the property in the resulting secret
  80. type: string
  81. remoteKey:
  82. description: Name of the resulting provider secret.
  83. type: string
  84. required:
  85. - remoteKey
  86. type: object
  87. secretKey:
  88. description: Secret Key to be pushed
  89. type: string
  90. required:
  91. - remoteRef
  92. type: object
  93. metadata:
  94. description: |-
  95. Metadata is metadata attached to the secret.
  96. The structure of metadata is provider specific, please look it up in the provider documentation.
  97. x-kubernetes-preserve-unknown-fields: true
  98. required:
  99. - match
  100. type: object
  101. type: array
  102. deletionPolicy:
  103. default: None
  104. description: Deletion Policy to handle Secrets in the provider.
  105. enum:
  106. - Delete
  107. - None
  108. type: string
  109. refreshInterval:
  110. default: 1h0m0s
  111. description: The Interval to which External Secrets will try to push
  112. a secret definition
  113. type: string
  114. secretStoreRefs:
  115. items:
  116. description: PushSecretStoreRef contains a reference on how to sync
  117. to a SecretStore.
  118. properties:
  119. kind:
  120. default: SecretStore
  121. description: Kind of the SecretStore resource (SecretStore or
  122. ClusterSecretStore)
  123. enum:
  124. - SecretStore
  125. - ClusterSecretStore
  126. type: string
  127. labelSelector:
  128. description: Optionally, sync to secret stores with label selector
  129. properties:
  130. matchExpressions:
  131. description: matchExpressions is a list of label selector
  132. requirements. The requirements are ANDed.
  133. items:
  134. description: |-
  135. A label selector requirement is a selector that contains values, a key, and an operator that
  136. relates the key and values.
  137. properties:
  138. key:
  139. description: key is the label key that the selector
  140. applies to.
  141. type: string
  142. operator:
  143. description: |-
  144. operator represents a key's relationship to a set of values.
  145. Valid operators are In, NotIn, Exists and DoesNotExist.
  146. type: string
  147. values:
  148. description: |-
  149. values is an array of string values. If the operator is In or NotIn,
  150. the values array must be non-empty. If the operator is Exists or DoesNotExist,
  151. the values array must be empty. This array is replaced during a strategic
  152. merge patch.
  153. items:
  154. type: string
  155. type: array
  156. x-kubernetes-list-type: atomic
  157. required:
  158. - key
  159. - operator
  160. type: object
  161. type: array
  162. x-kubernetes-list-type: atomic
  163. matchLabels:
  164. additionalProperties:
  165. type: string
  166. description: |-
  167. matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
  168. map is equivalent to an element of matchExpressions, whose key field is "key", the
  169. operator is "In", and the values array contains only "value". The requirements are ANDed.
  170. type: object
  171. type: object
  172. x-kubernetes-map-type: atomic
  173. name:
  174. description: Optionally, sync to the SecretStore of the given
  175. name
  176. maxLength: 253
  177. minLength: 1
  178. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  179. type: string
  180. type: object
  181. type: array
  182. selector:
  183. description: The Secret Selector (k8s source) for the Push Secret
  184. maxProperties: 1
  185. minProperties: 1
  186. properties:
  187. generatorRef:
  188. description: Point to a generator to create a Secret.
  189. properties:
  190. apiVersion:
  191. default: generators.external-secrets.io/v1alpha1
  192. description: Specify the apiVersion of the generator resource
  193. type: string
  194. kind:
  195. description: Specify the Kind of the generator resource
  196. enum:
  197. - ACRAccessToken
  198. - ClusterGenerator
  199. - CloudsmithAccessToken
  200. - ECRAuthorizationToken
  201. - Fake
  202. - GCRAccessToken
  203. - GithubAccessToken
  204. - QuayAccessToken
  205. - Password
  206. - SSHKey
  207. - STSSessionToken
  208. - UUID
  209. - VaultDynamicSecret
  210. - Webhook
  211. - Grafana
  212. - MFA
  213. type: string
  214. name:
  215. description: Specify the name of the generator resource
  216. maxLength: 253
  217. minLength: 1
  218. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  219. type: string
  220. required:
  221. - kind
  222. - name
  223. type: object
  224. secret:
  225. description: Select a Secret to Push.
  226. properties:
  227. name:
  228. description: |-
  229. Name of the Secret.
  230. The Secret must exist in the same namespace as the PushSecret manifest.
  231. maxLength: 253
  232. minLength: 1
  233. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  234. type: string
  235. selector:
  236. description: Selector chooses secrets using a labelSelector.
  237. properties:
  238. matchExpressions:
  239. description: matchExpressions is a list of label selector
  240. requirements. The requirements are ANDed.
  241. items:
  242. description: |-
  243. A label selector requirement is a selector that contains values, a key, and an operator that
  244. relates the key and values.
  245. properties:
  246. key:
  247. description: key is the label key that the selector
  248. applies to.
  249. type: string
  250. operator:
  251. description: |-
  252. operator represents a key's relationship to a set of values.
  253. Valid operators are In, NotIn, Exists and DoesNotExist.
  254. type: string
  255. values:
  256. description: |-
  257. values is an array of string values. If the operator is In or NotIn,
  258. the values array must be non-empty. If the operator is Exists or DoesNotExist,
  259. the values array must be empty. This array is replaced during a strategic
  260. merge patch.
  261. items:
  262. type: string
  263. type: array
  264. x-kubernetes-list-type: atomic
  265. required:
  266. - key
  267. - operator
  268. type: object
  269. type: array
  270. x-kubernetes-list-type: atomic
  271. matchLabels:
  272. additionalProperties:
  273. type: string
  274. description: |-
  275. matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
  276. map is equivalent to an element of matchExpressions, whose key field is "key", the
  277. operator is "In", and the values array contains only "value". The requirements are ANDed.
  278. type: object
  279. type: object
  280. x-kubernetes-map-type: atomic
  281. type: object
  282. type: object
  283. template:
  284. description: Template defines a blueprint for the created Secret resource.
  285. properties:
  286. data:
  287. additionalProperties:
  288. type: string
  289. type: object
  290. engineVersion:
  291. default: v2
  292. description: |-
  293. EngineVersion specifies the template engine version
  294. that should be used to compile/execute the
  295. template specified in .data and .templateFrom[].
  296. enum:
  297. - v2
  298. type: string
  299. mergePolicy:
  300. default: Replace
  301. description: TemplateMergePolicy defines how the rendered template
  302. should be merged with the existing Secret data.
  303. enum:
  304. - Replace
  305. - Merge
  306. type: string
  307. metadata:
  308. description: ExternalSecretTemplateMetadata defines metadata fields
  309. for the Secret blueprint.
  310. properties:
  311. annotations:
  312. additionalProperties:
  313. type: string
  314. type: object
  315. finalizers:
  316. items:
  317. type: string
  318. type: array
  319. labels:
  320. additionalProperties:
  321. type: string
  322. type: object
  323. type: object
  324. templateFrom:
  325. items:
  326. description: |-
  327. TemplateFrom specifies a source for templates.
  328. Each item in the list can either reference a ConfigMap or a Secret resource.
  329. properties:
  330. configMap:
  331. description: TemplateRef specifies a reference to either
  332. a ConfigMap or a Secret resource.
  333. properties:
  334. items:
  335. description: A list of keys in the ConfigMap/Secret
  336. to use as templates for Secret data
  337. items:
  338. description: TemplateRefItem specifies a key in the
  339. ConfigMap/Secret to use as a template for Secret
  340. data.
  341. properties:
  342. key:
  343. description: A key in the ConfigMap/Secret
  344. maxLength: 253
  345. minLength: 1
  346. pattern: ^[-._a-zA-Z0-9]+$
  347. type: string
  348. templateAs:
  349. default: Values
  350. description: TemplateScope specifies how the template
  351. keys should be interpreted.
  352. enum:
  353. - Values
  354. - KeysAndValues
  355. type: string
  356. required:
  357. - key
  358. type: object
  359. type: array
  360. name:
  361. description: The name of the ConfigMap/Secret resource
  362. maxLength: 253
  363. minLength: 1
  364. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  365. type: string
  366. required:
  367. - items
  368. - name
  369. type: object
  370. literal:
  371. type: string
  372. secret:
  373. description: TemplateRef specifies a reference to either
  374. a ConfigMap or a Secret resource.
  375. properties:
  376. items:
  377. description: A list of keys in the ConfigMap/Secret
  378. to use as templates for Secret data
  379. items:
  380. description: TemplateRefItem specifies a key in the
  381. ConfigMap/Secret to use as a template for Secret
  382. data.
  383. properties:
  384. key:
  385. description: A key in the ConfigMap/Secret
  386. maxLength: 253
  387. minLength: 1
  388. pattern: ^[-._a-zA-Z0-9]+$
  389. type: string
  390. templateAs:
  391. default: Values
  392. description: TemplateScope specifies how the template
  393. keys should be interpreted.
  394. enum:
  395. - Values
  396. - KeysAndValues
  397. type: string
  398. required:
  399. - key
  400. type: object
  401. type: array
  402. name:
  403. description: The name of the ConfigMap/Secret resource
  404. maxLength: 253
  405. minLength: 1
  406. pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
  407. type: string
  408. required:
  409. - items
  410. - name
  411. type: object
  412. target:
  413. default: Data
  414. description: |-
  415. Target specifies where to place the template result.
  416. For Secret resources, common values are: "Data", "Annotations", "Labels".
  417. For custom resources (when spec.target.manifest is set), this supports
  418. nested paths like "spec.database.config" or "data".
  419. type: string
  420. type: object
  421. type: array
  422. type:
  423. type: string
  424. type: object
  425. updatePolicy:
  426. default: Replace
  427. description: UpdatePolicy to handle Secrets in the provider.
  428. enum:
  429. - Replace
  430. - IfNotExists
  431. type: string
  432. required:
  433. - secretStoreRefs
  434. - selector
  435. type: object
  436. status:
  437. description: PushSecretStatus indicates the history of the status of PushSecret.
  438. properties:
  439. conditions:
  440. items:
  441. description: PushSecretStatusCondition indicates the status of the
  442. PushSecret.
  443. properties:
  444. lastTransitionTime:
  445. format: date-time
  446. type: string
  447. message:
  448. type: string
  449. reason:
  450. type: string
  451. status:
  452. type: string
  453. type:
  454. description: PushSecretConditionType indicates the condition
  455. of the PushSecret.
  456. type: string
  457. required:
  458. - status
  459. - type
  460. type: object
  461. type: array
  462. refreshTime:
  463. description: |-
  464. refreshTime is the time and date the external secret was fetched and
  465. the target secret updated
  466. format: date-time
  467. nullable: true
  468. type: string
  469. syncedPushSecrets:
  470. additionalProperties:
  471. additionalProperties:
  472. description: PushSecretData defines data to be pushed to the provider
  473. and associated metadata.
  474. properties:
  475. conversionStrategy:
  476. default: None
  477. description: Used to define a conversion Strategy for the
  478. secret keys
  479. enum:
  480. - None
  481. - ReverseUnicode
  482. type: string
  483. match:
  484. description: Match a given Secret Key to be pushed to the
  485. provider.
  486. properties:
  487. remoteRef:
  488. description: Remote Refs to push to providers.
  489. properties:
  490. property:
  491. description: Name of the property in the resulting
  492. secret
  493. type: string
  494. remoteKey:
  495. description: Name of the resulting provider secret.
  496. type: string
  497. required:
  498. - remoteKey
  499. type: object
  500. secretKey:
  501. description: Secret Key to be pushed
  502. type: string
  503. required:
  504. - remoteRef
  505. type: object
  506. metadata:
  507. description: |-
  508. Metadata is metadata attached to the secret.
  509. The structure of metadata is provider specific, please look it up in the provider documentation.
  510. x-kubernetes-preserve-unknown-fields: true
  511. required:
  512. - match
  513. type: object
  514. type: object
  515. description: |-
  516. Synced PushSecrets, including secrets that already exist in provider.
  517. Matches secret stores to PushSecretData that was stored to that secret store.
  518. type: object
  519. syncedResourceVersion:
  520. description: SyncedResourceVersion keeps track of the last synced
  521. version.
  522. type: string
  523. type: object
  524. type: object
  525. served: true
  526. storage: true
  527. subresources:
  528. status: {}