questions.yaml 19 KB

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