questions.yaml 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400
  1. groups:
  2. - name: pgAdmin Configuration
  3. description: Configure pgAdmin
  4. - name: Network Configuration
  5. description: Configure Network for pgAdmin
  6. - name: Storage Configuration
  7. description: Configure Storage for pgAdmin
  8. - name: Labels Configuration
  9. description: Configure Labels for pgAdmin
  10. - name: Resources Configuration
  11. description: Configure Resources for pgAdmin
  12. questions:
  13. - variable: pgadmin
  14. label: ""
  15. group: pgAdmin Configuration
  16. schema:
  17. type: dict
  18. attrs:
  19. - variable: admin_email
  20. label: Admin Email
  21. description: The email address for the pgAdmin admin user.
  22. schema:
  23. type: string
  24. required: true
  25. default: ""
  26. - variable: admin_password
  27. label: Admin Password
  28. description: The password for the pgAdmin admin user.
  29. schema:
  30. type: string
  31. required: true
  32. private: true
  33. default: ""
  34. - variable: additional_envs
  35. label: Additional Environment Variables
  36. schema:
  37. type: list
  38. default: []
  39. items:
  40. - variable: env
  41. label: Environment Variable
  42. schema:
  43. type: dict
  44. attrs:
  45. - variable: name
  46. label: Name
  47. schema:
  48. type: string
  49. required: true
  50. - variable: value
  51. label: Value
  52. schema:
  53. type: string
  54. - variable: network
  55. label: ""
  56. group: Network Configuration
  57. schema:
  58. type: dict
  59. attrs:
  60. - variable: web_port
  61. label: WebUI Port
  62. schema:
  63. type: dict
  64. attrs:
  65. - variable: bind_mode
  66. label: Port Bind Mode
  67. description: |
  68. The port bind mode.</br>
  69. - Publish: The port will be published on the host for external access.</br>
  70. - Expose: The port will be exposed for inter-container communication.</br>
  71. - None: The port will not be exposed or published.</br>
  72. Note: If the Dockerfile defines an EXPOSE directive,
  73. the port will still be exposed for inter-container communication regardless of this setting.
  74. schema:
  75. type: string
  76. default: "published"
  77. enum:
  78. - value: "published"
  79. description: Publish port on the host for external access
  80. - value: "exposed"
  81. description: Expose port for inter-container communication
  82. - value: ""
  83. description: None
  84. - variable: port_number
  85. label: Port Number
  86. schema:
  87. type: int
  88. default: 30056
  89. min: 1
  90. max: 65535
  91. required: true
  92. - variable: host_ips
  93. label: Host IPs
  94. description: IPs on the host to bind this port
  95. schema:
  96. type: list
  97. show_if: [["bind_mode", "=", "published"]]
  98. default: []
  99. items:
  100. - variable: host_ip
  101. label: Host IP
  102. schema:
  103. type: string
  104. required: true
  105. $ref:
  106. - definitions/node_bind_ip
  107. - variable: host_network
  108. label: Host Network
  109. description: |
  110. Bind to the host network. It's recommended to keep this disabled.
  111. schema:
  112. type: boolean
  113. default: false
  114. - variable: certificate_id
  115. label: Certificate
  116. description: The certificate to use for Portainer.
  117. schema:
  118. type: int
  119. "null": true
  120. $ref:
  121. - "definitions/certificate"
  122. - variable: storage
  123. label: ""
  124. group: Storage Configuration
  125. schema:
  126. type: dict
  127. attrs:
  128. - variable: config
  129. label: pgAdmin Config Storage
  130. description: The path to store pgAdmin Config.
  131. schema:
  132. type: dict
  133. attrs:
  134. - variable: type
  135. label: Type
  136. description: |
  137. ixVolume: Is dataset created automatically by the system.</br>
  138. Host Path: Is a path that already exists on the system.
  139. schema:
  140. type: string
  141. required: true
  142. default: "ix_volume"
  143. enum:
  144. - value: "host_path"
  145. description: Host Path (Path that already exists on the system)
  146. - value: "ix_volume"
  147. description: ixVolume (Dataset created automatically by the system)
  148. - variable: ix_volume_config
  149. label: ixVolume Configuration
  150. description: The configuration for the ixVolume dataset.
  151. schema:
  152. type: dict
  153. show_if: [["type", "=", "ix_volume"]]
  154. $ref:
  155. - "normalize/ix_volume"
  156. attrs:
  157. - variable: acl_enable
  158. label: Enable ACL
  159. description: Enable ACL for the storage.
  160. schema:
  161. type: boolean
  162. default: false
  163. - variable: dataset_name
  164. label: Dataset Name
  165. description: The name of the dataset to use for storage.
  166. schema:
  167. type: string
  168. required: true
  169. hidden: true
  170. default: "config"
  171. - variable: acl_entries
  172. label: ACL Configuration
  173. schema:
  174. type: dict
  175. show_if: [["acl_enable", "=", true]]
  176. attrs: []
  177. - variable: host_path_config
  178. label: Host Path Configuration
  179. schema:
  180. type: dict
  181. show_if: [["type", "=", "host_path"]]
  182. attrs:
  183. - variable: acl_enable
  184. label: Enable ACL
  185. description: Enable ACL for the storage.
  186. schema:
  187. type: boolean
  188. default: false
  189. - variable: acl
  190. label: ACL Configuration
  191. schema:
  192. type: dict
  193. show_if: [["acl_enable", "=", true]]
  194. attrs: []
  195. $ref:
  196. - "normalize/acl"
  197. - variable: path
  198. label: Host Path
  199. description: The host path to use for storage.
  200. schema:
  201. type: hostpath
  202. show_if: [["acl_enable", "=", false]]
  203. required: true
  204. - variable: additional_storage
  205. label: Additional Storage
  206. schema:
  207. type: list
  208. default: []
  209. items:
  210. - variable: storageEntry
  211. label: Storage Entry
  212. schema:
  213. type: dict
  214. attrs:
  215. - variable: type
  216. label: Type
  217. description: |
  218. ixVolume: Is dataset created automatically by the system.</br>
  219. Host Path: Is a path that already exists on the system.</br>
  220. SMB Share: Is a SMB share that is mounted to as a volume.
  221. schema:
  222. type: string
  223. required: true
  224. default: "ix_volume"
  225. enum:
  226. - value: "host_path"
  227. description: Host Path (Path that already exists on the system)
  228. - value: "ix_volume"
  229. description: ixVolume (Dataset created automatically by the system)
  230. - value: "cifs"
  231. description: SMB/CIFS Share (Mounts a volume to a SMB share)
  232. - variable: read_only
  233. label: Read Only
  234. description: Mount the volume as read only.
  235. schema:
  236. type: boolean
  237. default: false
  238. - variable: mount_path
  239. label: Mount Path
  240. description: The path inside the container to mount the storage.
  241. schema:
  242. type: path
  243. required: true
  244. - variable: host_path_config
  245. label: Host Path Configuration
  246. schema:
  247. type: dict
  248. show_if: [["type", "=", "host_path"]]
  249. attrs:
  250. - variable: acl_enable
  251. label: Enable ACL
  252. description: Enable ACL for the storage.
  253. schema:
  254. type: boolean
  255. default: false
  256. - variable: acl
  257. label: ACL Configuration
  258. schema:
  259. type: dict
  260. show_if: [["acl_enable", "=", true]]
  261. attrs: []
  262. $ref:
  263. - "normalize/acl"
  264. - variable: path
  265. label: Host Path
  266. description: The host path to use for storage.
  267. schema:
  268. type: hostpath
  269. show_if: [["acl_enable", "=", false]]
  270. required: true
  271. - variable: ix_volume_config
  272. label: ixVolume Configuration
  273. description: The configuration for the ixVolume dataset.
  274. schema:
  275. type: dict
  276. show_if: [["type", "=", "ix_volume"]]
  277. $ref:
  278. - "normalize/ix_volume"
  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: dataset_name
  287. label: Dataset Name
  288. description: The name of the dataset to use for storage.
  289. schema:
  290. type: string
  291. required: true
  292. default: "storage_entry"
  293. - variable: acl_entries
  294. label: ACL Configuration
  295. schema:
  296. type: dict
  297. show_if: [["acl_enable", "=", true]]
  298. attrs: []
  299. $ref:
  300. - "normalize/acl"
  301. - variable: cifs_config
  302. label: SMB Configuration
  303. description: The configuration for the SMB dataset.
  304. schema:
  305. type: dict
  306. show_if: [["type", "=", "cifs"]]
  307. attrs:
  308. - variable: server
  309. label: Server
  310. description: The server to mount the SMB share.
  311. schema:
  312. type: string
  313. required: true
  314. - variable: path
  315. label: Path
  316. description: The path to mount the SMB share.
  317. schema:
  318. type: string
  319. required: true
  320. - variable: username
  321. label: Username
  322. description: The username to use for the SMB share.
  323. schema:
  324. type: string
  325. required: true
  326. - variable: password
  327. label: Password
  328. description: The password to use for the SMB share.
  329. schema:
  330. type: string
  331. required: true
  332. private: true
  333. - variable: domain
  334. label: Domain
  335. description: The domain to use for the SMB share.
  336. schema:
  337. type: string
  338. - variable: labels
  339. label: ""
  340. group: Labels Configuration
  341. schema:
  342. type: list
  343. default: []
  344. items:
  345. - variable: label
  346. label: Label
  347. schema:
  348. type: dict
  349. attrs:
  350. - variable: key
  351. label: Key
  352. schema:
  353. type: string
  354. required: true
  355. - variable: value
  356. label: Value
  357. schema:
  358. type: string
  359. required: true
  360. - variable: containers
  361. label: Containers
  362. description: Containers where the label should be applied
  363. schema:
  364. type: list
  365. items:
  366. - variable: container
  367. label: Container
  368. schema:
  369. type: string
  370. required: true
  371. enum:
  372. - value: pgadmin
  373. description: pgadmin
  374. - variable: resources
  375. label: ""
  376. group: Resources Configuration
  377. schema:
  378. type: dict
  379. attrs:
  380. - variable: limits
  381. label: Limits
  382. schema:
  383. type: dict
  384. attrs:
  385. - variable: cpus
  386. label: CPUs
  387. description: CPUs limit for pgAdmin.
  388. schema:
  389. type: int
  390. default: 2
  391. required: true
  392. - variable: memory
  393. label: Memory (in MB)
  394. description: Memory limit for pgAdmin.
  395. schema:
  396. type: int
  397. default: 4096
  398. required: true