questions.yaml 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493
  1. groups:
  2. - name: Warracker Configuration
  3. description: Configure Warracker
  4. - name: Network Configuration
  5. description: Configure Network for Warracker
  6. - name: Storage Configuration
  7. description: Configure Storage for Warracker
  8. - name: Labels Configuration
  9. description: Configure Labels for Warracker
  10. - name: Resources Configuration
  11. description: Configure Resources for Warracker
  12. questions:
  13. - variable: TZ
  14. group: Warracker Configuration
  15. label: Timezone
  16. schema:
  17. type: string
  18. default: Etc/UTC
  19. required: true
  20. $ref:
  21. - definitions/timezone
  22. - variable: warracker
  23. label: ""
  24. group: Warracker Configuration
  25. schema:
  26. type: dict
  27. attrs:
  28. - variable: postgres_image_selector
  29. label: Postgres Image (CAUTION)
  30. description: |
  31. If you are changing this after the postgres directory has been initialized,</br>
  32. STOP! and make sure you have a backup of your data.</br>
  33. Changing this will trigger an one way database upgrade.</br>
  34. You can only select newer versions of postgres.</br>
  35. Selecting an older version will refuse to start.</br>
  36. If something goes wrong, you will have to restore from backup.
  37. schema:
  38. type: string
  39. default: postgres_17_image
  40. required: true
  41. enum:
  42. - value: postgres_17_image
  43. description: Postgres 17
  44. - variable: db_password
  45. label: Database Password
  46. description: The password for Warracker.
  47. schema:
  48. type: string
  49. default: ""
  50. required: true
  51. private: true
  52. - variable: additional_envs
  53. label: Additional Environment Variables
  54. schema:
  55. type: list
  56. default: []
  57. items:
  58. - variable: env
  59. label: Environment Variable
  60. schema:
  61. type: dict
  62. attrs:
  63. - variable: name
  64. label: Name
  65. schema:
  66. type: string
  67. required: true
  68. - variable: value
  69. label: Value
  70. schema:
  71. type: string
  72. - variable: network
  73. label: ""
  74. group: Network Configuration
  75. schema:
  76. type: dict
  77. attrs:
  78. - variable: web_port
  79. label: WebUI Port
  80. schema:
  81. type: dict
  82. attrs:
  83. - variable: bind_mode
  84. label: Port Bind Mode
  85. description: |
  86. The port bind mode.</br>
  87. - Publish: The port will be published on the host for external access.</br>
  88. - Expose: The port will be exposed for inter-container communication.</br>
  89. - None: The port will not be exposed or published.</br>
  90. Note: If the Dockerfile defines an EXPOSE directive,
  91. the port will still be exposed for inter-container communication regardless of this setting.
  92. schema:
  93. type: string
  94. default: "published"
  95. enum:
  96. - value: "published"
  97. description: Publish port on the host for external access
  98. - value: "exposed"
  99. description: Expose port for inter-container communication
  100. - value: ""
  101. description: None
  102. - variable: port_number
  103. label: Port Number
  104. schema:
  105. type: int
  106. default: 30148
  107. min: 1
  108. max: 65535
  109. required: true
  110. - variable: host_ips
  111. label: Host IPs
  112. description: IPs on the host to bind this port
  113. schema:
  114. type: list
  115. show_if: [["bind_mode", "=", "published"]]
  116. default: []
  117. items:
  118. - variable: host_ip
  119. label: Host IP
  120. schema:
  121. type: string
  122. required: true
  123. $ref:
  124. - definitions/node_bind_ip
  125. - variable: storage
  126. label: ""
  127. group: Storage Configuration
  128. schema:
  129. type: dict
  130. attrs:
  131. - variable: uploads
  132. label: Warracker Uploads Storage
  133. description: The path to store Warracker Uploads.
  134. schema:
  135. type: dict
  136. attrs:
  137. - variable: type
  138. label: Type
  139. description: |
  140. ixVolume: Is dataset created automatically by the system.</br>
  141. Host Path: Is a path that already exists on the system.
  142. schema:
  143. type: string
  144. required: true
  145. default: "ix_volume"
  146. enum:
  147. - value: "host_path"
  148. description: Host Path (Path that already exists on the system)
  149. - value: "ix_volume"
  150. description: ixVolume (Dataset created automatically by the system)
  151. - variable: ix_volume_config
  152. label: ixVolume Configuration
  153. description: The configuration for the ixVolume dataset.
  154. schema:
  155. type: dict
  156. show_if: [["type", "=", "ix_volume"]]
  157. $ref:
  158. - "normalize/ix_volume"
  159. attrs:
  160. - variable: acl_enable
  161. label: Enable ACL
  162. description: Enable ACL for the storage.
  163. schema:
  164. type: boolean
  165. default: false
  166. - variable: dataset_name
  167. label: Dataset Name
  168. description: The name of the dataset to use for storage.
  169. schema:
  170. type: string
  171. required: true
  172. hidden: true
  173. default: "uploads"
  174. - variable: acl_entries
  175. label: ACL Configuration
  176. schema:
  177. type: dict
  178. show_if: [["acl_enable", "=", true]]
  179. attrs: []
  180. - variable: host_path_config
  181. label: Host Path Configuration
  182. schema:
  183. type: dict
  184. show_if: [["type", "=", "host_path"]]
  185. attrs:
  186. - variable: acl_enable
  187. label: Enable ACL
  188. description: Enable ACL for the storage.
  189. schema:
  190. type: boolean
  191. default: false
  192. - variable: acl
  193. label: ACL Configuration
  194. schema:
  195. type: dict
  196. show_if: [["acl_enable", "=", true]]
  197. attrs: []
  198. $ref:
  199. - "normalize/acl"
  200. - variable: path
  201. label: Host Path
  202. description: The host path to use for storage.
  203. schema:
  204. type: hostpath
  205. show_if: [["acl_enable", "=", false]]
  206. required: true
  207. - variable: postgres_data
  208. label: Postgres Data Storage
  209. description: The path to store Postgres Data.
  210. schema:
  211. type: dict
  212. attrs:
  213. - variable: type
  214. label: Type
  215. description: |
  216. ixVolume: Is dataset created automatically by the system.</br>
  217. Host Path: Is a path that already exists on the system.
  218. schema:
  219. type: string
  220. required: true
  221. default: "ix_volume"
  222. enum:
  223. - value: "host_path"
  224. description: Host Path (Path that already exists on the system)
  225. - value: "ix_volume"
  226. description: ixVolume (Dataset created automatically by the system)
  227. - variable: ix_volume_config
  228. label: ixVolume Configuration
  229. description: The configuration for the ixVolume dataset.
  230. schema:
  231. type: dict
  232. show_if: [["type", "=", "ix_volume"]]
  233. $ref:
  234. - "normalize/ix_volume"
  235. attrs:
  236. - variable: acl_enable
  237. label: Enable ACL
  238. description: Enable ACL for the storage.
  239. schema:
  240. type: boolean
  241. default: false
  242. - variable: dataset_name
  243. label: Dataset Name
  244. description: The name of the dataset to use for storage.
  245. schema:
  246. type: string
  247. required: true
  248. hidden: true
  249. default: "pg_data"
  250. - variable: acl_entries
  251. label: ACL Configuration
  252. schema:
  253. type: dict
  254. show_if: [["acl_enable", "=", true]]
  255. attrs: []
  256. - variable: host_path_config
  257. label: Host Path Configuration
  258. schema:
  259. type: dict
  260. show_if: [["type", "=", "host_path"]]
  261. attrs:
  262. - variable: acl_enable
  263. label: Enable ACL
  264. description: Enable ACL for the storage.
  265. schema:
  266. type: boolean
  267. default: false
  268. - variable: acl
  269. label: ACL Configuration
  270. schema:
  271. type: dict
  272. show_if: [["acl_enable", "=", true]]
  273. attrs: []
  274. $ref:
  275. - "normalize/acl"
  276. - variable: path
  277. label: Host Path
  278. description: The host path to use for storage.
  279. schema:
  280. type: hostpath
  281. show_if: [["acl_enable", "=", false]]
  282. required: true
  283. - variable: auto_permissions
  284. label: Automatic Permissions
  285. description: |
  286. Automatically set permissions for the host path.
  287. Enabling this, will check the top level directory,</br>
  288. If it finds incorrect permissions, it will `chown` the
  289. host path to the user and group required for the
  290. postgres container.
  291. schema:
  292. type: boolean
  293. default: false
  294. show_if: [["acl_enable", "=", false]]
  295. - variable: additional_storage
  296. label: Additional Storage
  297. schema:
  298. type: list
  299. default: []
  300. items:
  301. - variable: storageEntry
  302. label: Storage Entry
  303. schema:
  304. type: dict
  305. attrs:
  306. - variable: type
  307. label: Type
  308. description: |
  309. ixVolume: Is dataset created automatically by the system.</br>
  310. Host Path: Is a path that already exists on the system.</br>
  311. SMB Share: Is a SMB share that is mounted to as a volume.
  312. schema:
  313. type: string
  314. required: true
  315. default: "ix_volume"
  316. enum:
  317. - value: "host_path"
  318. description: Host Path (Path that already exists on the system)
  319. - value: "ix_volume"
  320. description: ixVolume (Dataset created automatically by the system)
  321. - value: "cifs"
  322. description: SMB/CIFS Share (Mounts a volume to a SMB share)
  323. - variable: read_only
  324. label: Read Only
  325. description: Mount the volume as read only.
  326. schema:
  327. type: boolean
  328. default: false
  329. - variable: mount_path
  330. label: Mount Path
  331. description: The path inside the container to mount the storage.
  332. schema:
  333. type: path
  334. required: true
  335. - variable: host_path_config
  336. label: Host Path Configuration
  337. schema:
  338. type: dict
  339. show_if: [["type", "=", "host_path"]]
  340. attrs:
  341. - variable: acl_enable
  342. label: Enable ACL
  343. description: Enable ACL for the storage.
  344. schema:
  345. type: boolean
  346. default: false
  347. - variable: acl
  348. label: ACL Configuration
  349. schema:
  350. type: dict
  351. show_if: [["acl_enable", "=", true]]
  352. attrs: []
  353. $ref:
  354. - "normalize/acl"
  355. - variable: path
  356. label: Host Path
  357. description: The host path to use for storage.
  358. schema:
  359. type: hostpath
  360. show_if: [["acl_enable", "=", false]]
  361. required: true
  362. - variable: ix_volume_config
  363. label: ixVolume Configuration
  364. description: The configuration for the ixVolume dataset.
  365. schema:
  366. type: dict
  367. show_if: [["type", "=", "ix_volume"]]
  368. $ref:
  369. - "normalize/ix_volume"
  370. attrs:
  371. - variable: acl_enable
  372. label: Enable ACL
  373. description: Enable ACL for the storage.
  374. schema:
  375. type: boolean
  376. default: false
  377. - variable: dataset_name
  378. label: Dataset Name
  379. description: The name of the dataset to use for storage.
  380. schema:
  381. type: string
  382. required: true
  383. default: "storage_entry"
  384. - variable: acl_entries
  385. label: ACL Configuration
  386. schema:
  387. type: dict
  388. show_if: [["acl_enable", "=", true]]
  389. attrs: []
  390. $ref:
  391. - "normalize/acl"
  392. - variable: cifs_config
  393. label: SMB Configuration
  394. description: The configuration for the SMB dataset.
  395. schema:
  396. type: dict
  397. show_if: [["type", "=", "cifs"]]
  398. attrs:
  399. - variable: server
  400. label: Server
  401. description: The server to mount the SMB share.
  402. schema:
  403. type: string
  404. required: true
  405. - variable: path
  406. label: Path
  407. description: The path to mount the SMB share.
  408. schema:
  409. type: string
  410. required: true
  411. - variable: username
  412. label: Username
  413. description: The username to use for the SMB share.
  414. schema:
  415. type: string
  416. required: true
  417. - variable: password
  418. label: Password
  419. description: The password to use for the SMB share.
  420. schema:
  421. type: string
  422. required: true
  423. private: true
  424. - variable: domain
  425. label: Domain
  426. description: The domain to use for the SMB share.
  427. schema:
  428. type: string
  429. - variable: labels
  430. label: ""
  431. group: Labels Configuration
  432. schema:
  433. type: list
  434. default: []
  435. items:
  436. - variable: label
  437. label: Label
  438. schema:
  439. type: dict
  440. attrs:
  441. - variable: key
  442. label: Key
  443. schema:
  444. type: string
  445. required: true
  446. - variable: value
  447. label: Value
  448. schema:
  449. type: string
  450. required: true
  451. - variable: containers
  452. label: Containers
  453. description: Containers where the label should be applied
  454. schema:
  455. type: list
  456. items:
  457. - variable: container
  458. label: Container
  459. schema:
  460. type: string
  461. required: true
  462. enum:
  463. - value: warracker
  464. description: warracker
  465. - value: postgres
  466. description: postgres
  467. - variable: resources
  468. label: ""
  469. group: Resources Configuration
  470. schema:
  471. type: dict
  472. attrs:
  473. - variable: limits
  474. label: Limits
  475. schema:
  476. type: dict
  477. attrs:
  478. - variable: cpus
  479. label: CPUs
  480. description: CPUs limit for Warracker.
  481. schema:
  482. type: int
  483. default: 2
  484. required: true
  485. - variable: memory
  486. label: Memory (in MB)
  487. description: Memory limit for Warracker.
  488. schema:
  489. type: int
  490. default: 4096
  491. required: true