questions.yaml 23 KB

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