questions.yaml 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624
  1. groups:
  2. - name: Eclipse Mosquitto Configuration
  3. description: Configure Eclipse Mosquitto
  4. - name: User and Group Configuration
  5. description: Configure User and Group for Eclipse Mosquitto
  6. - name: Network Configuration
  7. description: Configure Network for Eclipse Mosquitto
  8. - name: Storage Configuration
  9. description: Configure Storage for Eclipse Mosquitto
  10. - name: Labels Configuration
  11. description: Configure Labels for Eclipse Mosquitto
  12. - name: Resources Configuration
  13. description: Configure Resources for Eclipse Mosquitto
  14. questions:
  15. - variable: TZ
  16. group: Eclipse Mosquitto Configuration
  17. label: Timezone
  18. schema:
  19. type: string
  20. default: Etc/UTC
  21. required: true
  22. $ref:
  23. - definitions/timezone
  24. - variable: mosquitto
  25. label: ""
  26. group: Eclipse Mosquitto Configuration
  27. schema:
  28. type: dict
  29. attrs:
  30. - variable: enable_persistence
  31. label: Enable Persistence
  32. description: If enabled, connection, subscription and message data will be written to the disk in mosquitto.db
  33. schema:
  34. type: boolean
  35. default: true
  36. - variable: autosave_interval
  37. label: Autosave Interval
  38. description: |
  39. The number of seconds that mosquitto will wait between each time it saves the in-memory database to disk. </br>
  40. If set to 0, the in-memory database will only be saved when mosquitto exits or when receiving the SIGUSR1 signal. </br
  41. Note that this setting only has an effect if persistence is enabled.
  42. schema:
  43. type: int
  44. show_if: [["enable_persistence", "=", true]]
  45. min: 0
  46. default: 1800
  47. - variable: allow_anonymous
  48. label: Allow Anonymous
  49. description: Boolean value that determines whether clients that connect without providing a username are allowed to connect.
  50. schema:
  51. type: boolean
  52. default: false
  53. - variable: additional_envs
  54. label: Additional Environment Variables
  55. schema:
  56. type: list
  57. default: []
  58. items:
  59. - variable: env
  60. label: Environment Variable
  61. schema:
  62. type: dict
  63. attrs:
  64. - variable: name
  65. label: Name
  66. schema:
  67. type: string
  68. required: true
  69. - variable: value
  70. label: Value
  71. schema:
  72. type: string
  73. - variable: run_as
  74. label: ""
  75. group: User and Group Configuration
  76. schema:
  77. type: dict
  78. attrs:
  79. - variable: user
  80. label: User ID
  81. description: The user id that Actual Budget files will be owned by.
  82. schema:
  83. type: int
  84. min: 568
  85. default: 568
  86. required: true
  87. - variable: group
  88. label: Group ID
  89. description: The group id that Actual Budget files will be owned by.
  90. schema:
  91. type: int
  92. min: 568
  93. default: 568
  94. required: true
  95. - variable: network
  96. label: ""
  97. group: Network Configuration
  98. schema:
  99. type: dict
  100. attrs:
  101. - variable: broker_port
  102. label: Broker Port
  103. schema:
  104. type: dict
  105. attrs:
  106. - variable: bind_mode
  107. label: Port Bind Mode
  108. description: |
  109. The port bind mode.</br>
  110. - Publish: The port will be published on the host for external access.</br>
  111. - Expose: The port will be exposed for inter-container communication.</br>
  112. - None: The port will not be exposed or published.</br>
  113. Note: If the Dockerfile defines an EXPOSE directive,
  114. the port will still be exposed for inter-container communication regardless of this setting.
  115. schema:
  116. type: string
  117. default: "published"
  118. enum:
  119. - value: "published"
  120. description: Publish port on the host for external access
  121. - value: "exposed"
  122. description: Expose port for inter-container communication
  123. - value: ""
  124. description: None
  125. - variable: port_number
  126. label: Port Number
  127. schema:
  128. type: int
  129. default: 1883
  130. min: 1
  131. max: 65535
  132. required: true
  133. - variable: host_ips
  134. label: Host IPs
  135. description: IPs on the host to bind this port
  136. schema:
  137. type: list
  138. show_if: [["bind_mode", "=", "published"]]
  139. default: []
  140. items:
  141. - variable: host_ip
  142. label: Host IP
  143. schema:
  144. type: string
  145. required: true
  146. $ref:
  147. - definitions/node_bind_ip
  148. - variable: ws_port
  149. label: Web Sockets Port
  150. schema:
  151. type: dict
  152. attrs:
  153. - variable: bind_mode
  154. label: Port Bind Mode
  155. description: |
  156. The port bind mode.</br>
  157. - Publish: The port will be published on the host for external access.</br>
  158. - Expose: The port will be exposed for inter-container communication.</br>
  159. - None: The port will not be exposed or published.</br>
  160. Note: If the Dockerfile defines an EXPOSE directive,
  161. the port will still be exposed for inter-container communication regardless of this setting.
  162. schema:
  163. type: string
  164. default: "published"
  165. enum:
  166. - value: "published"
  167. description: Publish port on the host for external access
  168. - value: "exposed"
  169. description: Expose port for inter-container communication
  170. - value: ""
  171. description: None
  172. - variable: port_number
  173. label: Port Number
  174. schema:
  175. type: int
  176. default: 8081
  177. min: 1
  178. max: 65535
  179. required: true
  180. - variable: host_ips
  181. label: Host IPs
  182. description: IPs on the host to bind this port
  183. schema:
  184. type: list
  185. show_if: [["bind_mode", "=", "published"]]
  186. default: []
  187. items:
  188. - variable: host_ip
  189. label: Host IP
  190. schema:
  191. type: string
  192. required: true
  193. $ref:
  194. - definitions/node_bind_ip
  195. - variable: additional_ports
  196. label: Additional Ports
  197. schema:
  198. type: list
  199. show_if: [["host_network", "=", false]]
  200. items:
  201. - variable: port
  202. label: Port
  203. schema:
  204. type: dict
  205. attrs:
  206. - variable: bind_mode
  207. label: Port Bind Mode
  208. description: |
  209. The port bind mode.</br>
  210. - Publish: The port will be published on the host for external access.</br>
  211. - Expose: The port will be exposed for inter-container communication.</br>
  212. schema:
  213. type: string
  214. default: "published"
  215. enum:
  216. - value: "published"
  217. description: Publish port on the host for external access
  218. - value: "exposed"
  219. description: Expose port for inter-container communication
  220. - variable: port_number
  221. label: Port Number
  222. schema:
  223. type: int
  224. min: 1
  225. max: 65535
  226. required: true
  227. - variable: container_port
  228. label: Container Port
  229. schema:
  230. type: int
  231. min: 1
  232. max: 65535
  233. required: true
  234. - variable: protocol
  235. label: Protocol
  236. schema:
  237. type: string
  238. required: true
  239. default: "tcp"
  240. enum:
  241. - value: "tcp"
  242. description: TCP
  243. - value: "udp"
  244. description: UDP
  245. - variable: host_ips
  246. label: Host IPs
  247. description: IPs on the host to bind this port
  248. schema:
  249. type: list
  250. show_if: [["bind_mode", "=", "published"]]
  251. default: []
  252. items:
  253. - variable: host_ip
  254. label: Host IP
  255. schema:
  256. type: string
  257. required: true
  258. $ref:
  259. - definitions/node_bind_ip
  260. - variable: host_network
  261. label: Host Network
  262. description: |
  263. Bind to the host network. It's recommended to keep this disabled.
  264. schema:
  265. type: boolean
  266. default: false
  267. - variable: storage
  268. label: ""
  269. group: Storage Configuration
  270. schema:
  271. type: dict
  272. attrs:
  273. - variable: data
  274. label: Eclipse Mosquitto Data Storage
  275. description: The path to store Eclipse Mosquitto Data.
  276. schema:
  277. type: dict
  278. attrs:
  279. - variable: type
  280. label: Type
  281. description: |
  282. ixVolume: Is dataset created automatically by the system.</br>
  283. Host Path: Is a path that already exists on the system.
  284. schema:
  285. type: string
  286. required: true
  287. default: "ix_volume"
  288. enum:
  289. - value: "host_path"
  290. description: Host Path (Path that already exists on the system)
  291. - value: "ix_volume"
  292. description: ixVolume (Dataset created automatically by the system)
  293. - variable: ix_volume_config
  294. label: ixVolume Configuration
  295. description: The configuration for the ixVolume dataset.
  296. schema:
  297. type: dict
  298. show_if: [["type", "=", "ix_volume"]]
  299. $ref:
  300. - "normalize/ix_volume"
  301. attrs:
  302. - variable: acl_enable
  303. label: Enable ACL
  304. description: Enable ACL for the storage.
  305. schema:
  306. type: boolean
  307. default: false
  308. - variable: dataset_name
  309. label: Dataset Name
  310. description: The name of the dataset to use for storage.
  311. schema:
  312. type: string
  313. required: true
  314. hidden: true
  315. default: "data"
  316. - variable: acl_entries
  317. label: ACL Configuration
  318. schema:
  319. type: dict
  320. show_if: [["acl_enable", "=", true]]
  321. attrs: []
  322. - variable: host_path_config
  323. label: Host Path Configuration
  324. schema:
  325. type: dict
  326. show_if: [["type", "=", "host_path"]]
  327. attrs:
  328. - variable: acl_enable
  329. label: Enable ACL
  330. description: Enable ACL for the storage.
  331. schema:
  332. type: boolean
  333. default: false
  334. - variable: acl
  335. label: ACL Configuration
  336. schema:
  337. type: dict
  338. show_if: [["acl_enable", "=", true]]
  339. attrs: []
  340. $ref:
  341. - "normalize/acl"
  342. - variable: path
  343. label: Host Path
  344. description: The host path to use for storage.
  345. schema:
  346. type: hostpath
  347. show_if: [["acl_enable", "=", false]]
  348. required: true
  349. - variable: config
  350. label: Eclipse Mosquitto Config Storage
  351. description: The path to store Eclipse Mosquitto Config.
  352. schema:
  353. type: dict
  354. attrs:
  355. - variable: type
  356. label: Type
  357. description: |
  358. ixVolume: Is dataset created automatically by the system.</br>
  359. Host Path: Is a path that already exists on the system.
  360. schema:
  361. type: string
  362. required: true
  363. default: "ix_volume"
  364. enum:
  365. - value: "host_path"
  366. description: Host Path (Path that already exists on the system)
  367. - value: "ix_volume"
  368. description: ixVolume (Dataset created automatically by the system)
  369. - variable: ix_volume_config
  370. label: ixVolume Configuration
  371. description: The configuration for the ixVolume dataset.
  372. schema:
  373. type: dict
  374. show_if: [["type", "=", "ix_volume"]]
  375. $ref:
  376. - "normalize/ix_volume"
  377. attrs:
  378. - variable: acl_enable
  379. label: Enable ACL
  380. description: Enable ACL for the storage.
  381. schema:
  382. type: boolean
  383. default: false
  384. - variable: dataset_name
  385. label: Dataset Name
  386. description: The name of the dataset to use for storage.
  387. schema:
  388. type: string
  389. required: true
  390. hidden: true
  391. default: "config"
  392. - variable: acl_entries
  393. label: ACL Configuration
  394. schema:
  395. type: dict
  396. show_if: [["acl_enable", "=", true]]
  397. attrs: []
  398. - variable: host_path_config
  399. label: Host Path Configuration
  400. schema:
  401. type: dict
  402. show_if: [["type", "=", "host_path"]]
  403. attrs:
  404. - variable: acl_enable
  405. label: Enable ACL
  406. description: Enable ACL for the storage.
  407. schema:
  408. type: boolean
  409. default: false
  410. - variable: acl
  411. label: ACL Configuration
  412. schema:
  413. type: dict
  414. show_if: [["acl_enable", "=", true]]
  415. attrs: []
  416. $ref:
  417. - "normalize/acl"
  418. - variable: path
  419. label: Host Path
  420. description: The host path to use for storage.
  421. schema:
  422. type: hostpath
  423. show_if: [["acl_enable", "=", false]]
  424. required: true
  425. - variable: additional_storage
  426. label: Additional Storage
  427. schema:
  428. type: list
  429. default: []
  430. items:
  431. - variable: storageEntry
  432. label: Storage Entry
  433. schema:
  434. type: dict
  435. attrs:
  436. - variable: type
  437. label: Type
  438. description: |
  439. ixVolume: Is dataset created automatically by the system.</br>
  440. Host Path: Is a path that already exists on the system.</br>
  441. SMB Share: Is a SMB share that is mounted to as a volume.
  442. schema:
  443. type: string
  444. required: true
  445. default: "ix_volume"
  446. enum:
  447. - value: "host_path"
  448. description: Host Path (Path that already exists on the system)
  449. - value: "ix_volume"
  450. description: ixVolume (Dataset created automatically by the system)
  451. - value: "cifs"
  452. description: SMB/CIFS Share (Mounts a volume to a SMB share)
  453. - variable: read_only
  454. label: Read Only
  455. description: Mount the volume as read only.
  456. schema:
  457. type: boolean
  458. default: false
  459. - variable: mount_path
  460. label: Mount Path
  461. description: The path inside the container to mount the storage.
  462. schema:
  463. type: path
  464. required: true
  465. - variable: host_path_config
  466. label: Host Path Configuration
  467. schema:
  468. type: dict
  469. show_if: [["type", "=", "host_path"]]
  470. attrs:
  471. - variable: acl_enable
  472. label: Enable ACL
  473. description: Enable ACL for the storage.
  474. schema:
  475. type: boolean
  476. default: false
  477. - variable: acl
  478. label: ACL Configuration
  479. schema:
  480. type: dict
  481. show_if: [["acl_enable", "=", true]]
  482. attrs: []
  483. $ref:
  484. - "normalize/acl"
  485. - variable: path
  486. label: Host Path
  487. description: The host path to use for storage.
  488. schema:
  489. type: hostpath
  490. show_if: [["acl_enable", "=", false]]
  491. required: true
  492. - variable: ix_volume_config
  493. label: ixVolume Configuration
  494. description: The configuration for the ixVolume dataset.
  495. schema:
  496. type: dict
  497. show_if: [["type", "=", "ix_volume"]]
  498. $ref:
  499. - "normalize/ix_volume"
  500. attrs:
  501. - variable: acl_enable
  502. label: Enable ACL
  503. description: Enable ACL for the storage.
  504. schema:
  505. type: boolean
  506. default: false
  507. - variable: dataset_name
  508. label: Dataset Name
  509. description: The name of the dataset to use for storage.
  510. schema:
  511. type: string
  512. required: true
  513. default: "storage_entry"
  514. - variable: acl_entries
  515. label: ACL Configuration
  516. schema:
  517. type: dict
  518. show_if: [["acl_enable", "=", true]]
  519. attrs: []
  520. $ref:
  521. - "normalize/acl"
  522. - variable: cifs_config
  523. label: SMB Configuration
  524. description: The configuration for the SMB dataset.
  525. schema:
  526. type: dict
  527. show_if: [["type", "=", "cifs"]]
  528. attrs:
  529. - variable: server
  530. label: Server
  531. description: The server to mount the SMB share.
  532. schema:
  533. type: string
  534. required: true
  535. - variable: path
  536. label: Path
  537. description: The path to mount the SMB share.
  538. schema:
  539. type: string
  540. required: true
  541. - variable: username
  542. label: Username
  543. description: The username to use for the SMB share.
  544. schema:
  545. type: string
  546. required: true
  547. - variable: password
  548. label: Password
  549. description: The password to use for the SMB share.
  550. schema:
  551. type: string
  552. required: true
  553. private: true
  554. - variable: domain
  555. label: Domain
  556. description: The domain to use for the SMB share.
  557. schema:
  558. type: string
  559. - variable: labels
  560. label: ""
  561. group: Labels Configuration
  562. schema:
  563. type: list
  564. default: []
  565. items:
  566. - variable: label
  567. label: Label
  568. schema:
  569. type: dict
  570. attrs:
  571. - variable: key
  572. label: Key
  573. schema:
  574. type: string
  575. required: true
  576. - variable: value
  577. label: Value
  578. schema:
  579. type: string
  580. required: true
  581. - variable: containers
  582. label: Containers
  583. description: Containers where the label should be applied
  584. schema:
  585. type: list
  586. items:
  587. - variable: container
  588. label: Container
  589. schema:
  590. type: string
  591. required: true
  592. enum:
  593. - value: mosquitto
  594. description: mosquitto
  595. - variable: resources
  596. label: ""
  597. group: Resources Configuration
  598. schema:
  599. type: dict
  600. attrs:
  601. - variable: limits
  602. label: Limits
  603. schema:
  604. type: dict
  605. attrs:
  606. - variable: cpus
  607. label: CPUs
  608. description: CPUs limit for Eclipse Mosquitto.
  609. schema:
  610. type: int
  611. default: 2
  612. required: true
  613. - variable: memory
  614. label: Memory (in MB)
  615. description: Memory limit for Eclipse Mosquitto.
  616. schema:
  617. type: int
  618. default: 4096
  619. required: true