questions.yaml 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633
  1. groups:
  2. - name: Home Assistant Configuration
  3. description: Configure Home Assistant
  4. - name: User and Group Configuration
  5. description: Configure User and Group for Home Assistant
  6. - name: Advanced Pod Configuration
  7. description: Configure Advanced Pod Options for Home Assistant
  8. - name: Network Configuration
  9. description: Configure Network for Home Assistant
  10. - name: Storage Configuration
  11. description: Configure Storage for Home Assistant
  12. - name: Resources Configuration
  13. description: Configure Resources for Home Assistant
  14. portals:
  15. web_portal:
  16. protocols:
  17. - "$kubernetes-resource_configmap_portal_protocol"
  18. host:
  19. - "$kubernetes-resource_configmap_portal_host"
  20. ports:
  21. - "$kubernetes-resource_configmap_portal_port"
  22. path: "$kubernetes-resource_configmap_portal_path"
  23. questions:
  24. - variable: TZ
  25. group: Home Assistant Configuration
  26. label: Timezone
  27. schema:
  28. type: string
  29. default: Etc/UTC
  30. required: true
  31. $ref:
  32. - definitions/timezone
  33. - variable: podOptions
  34. label: ""
  35. group: Advanced Pod Configuration
  36. schema:
  37. type: dict
  38. attrs:
  39. - variable: dnsConfig
  40. label: Advanced DNS Configuration
  41. schema:
  42. type: dict
  43. attrs:
  44. - variable: options
  45. label: DNS Options
  46. schema:
  47. type: list
  48. items:
  49. - variable: optionsEntry
  50. label: DNS Option Entry
  51. schema:
  52. type: dict
  53. attrs:
  54. - variable: name
  55. label: Option Name
  56. schema:
  57. type: string
  58. required: true
  59. - variable: value
  60. label: Option Value
  61. schema:
  62. type: string
  63. required: true
  64. - variable: haNetwork
  65. label: ""
  66. group: Network Configuration
  67. schema:
  68. type: dict
  69. attrs:
  70. - variable: webPort
  71. label: Web Port
  72. description: The port for the Home Assistant Web UI.
  73. schema:
  74. type: int
  75. default: 20810
  76. min: 9000
  77. max: 65535
  78. required: true
  79. - variable: hostNetwork
  80. label: Host Network
  81. schema:
  82. type: boolean
  83. default: true
  84. - variable: haID
  85. label: ""
  86. group: User and Group Configuration
  87. schema:
  88. type: dict
  89. attrs:
  90. - variable: user
  91. label: User ID
  92. description: The user id that Home Assistant files will be owned by.
  93. schema:
  94. type: int
  95. min: 568
  96. default: 568
  97. required: true
  98. - variable: group
  99. label: Group ID
  100. description: The group id that Home Assistant files will be owned by.
  101. schema:
  102. type: int
  103. min: 568
  104. default: 568
  105. required: true
  106. - variable: haStorage
  107. label: ""
  108. group: Storage Configuration
  109. schema:
  110. type: dict
  111. attrs:
  112. - variable: config
  113. label: Home Assistant Configuration Storage
  114. description: The path to store Home Assistant Configuration.
  115. schema:
  116. type: dict
  117. attrs:
  118. - variable: type
  119. label: Type
  120. description: |
  121. ixVolume: Is dataset created automatically by the system.</br>
  122. Host Path: Is a path that already exists on the system.
  123. schema:
  124. type: string
  125. required: true
  126. immutable: true
  127. default: ixVolume
  128. enum:
  129. - value: hostPath
  130. description: Host Path (Path that already exists on the system)
  131. - value: ixVolume
  132. description: ixVolume (Dataset created automatically by the system)
  133. - variable: ixVolumeConfig
  134. label: ixVolume Configuration
  135. description: The configuration for the ixVolume dataset.
  136. schema:
  137. type: dict
  138. show_if: [["type", "=", "ixVolume"]]
  139. $ref:
  140. - "normalize/ixVolume"
  141. attrs:
  142. - variable: aclEnable
  143. label: Enable ACL
  144. description: Enable ACL for the dataset.
  145. schema:
  146. type: boolean
  147. default: false
  148. - variable: datasetName
  149. label: Dataset Name
  150. description: The name of the dataset to use for storage.
  151. schema:
  152. type: string
  153. required: true
  154. immutable: true
  155. hidden: true
  156. default: "config"
  157. - variable: aclEntries
  158. label: ACL Configuration
  159. schema:
  160. type: dict
  161. show_if: [["aclEnable", "=", true]]
  162. attrs: []
  163. - variable: hostPathConfig
  164. label: Host Path Configuration
  165. schema:
  166. type: dict
  167. show_if: [["type", "=", "hostPath"]]
  168. attrs:
  169. - variable: aclEnable
  170. label: Enable ACL
  171. description: Enable ACL for the dataset.
  172. schema:
  173. type: boolean
  174. default: false
  175. - variable: acl
  176. label: ACL Configuration
  177. schema:
  178. type: dict
  179. show_if: [["aclEnable", "=", true]]
  180. attrs: []
  181. $ref:
  182. - "normalize/acl"
  183. - variable: hostPath
  184. label: Host Path
  185. description: The host path to use for storage.
  186. schema:
  187. type: hostpath
  188. show_if: [["aclEnable", "=", false]]
  189. required: true
  190. - variable: media
  191. label: Home Assistant Media Storage
  192. description: The path to store Home Assistant Media.
  193. schema:
  194. type: dict
  195. attrs:
  196. - variable: type
  197. label: Type
  198. description: |
  199. ixVolume: Is dataset created automatically by the system.</br>
  200. Host Path: Is a path that already exists on the system.
  201. schema:
  202. type: string
  203. required: true
  204. immutable: true
  205. default: ixVolume
  206. enum:
  207. - value: hostPath
  208. description: Host Path (Path that already exists on the system)
  209. - value: ixVolume
  210. description: ixVolume (Dataset created automatically by the system)
  211. - variable: ixVolumeConfig
  212. label: ixVolume Configuration
  213. description: The configuration for the ixVolume dataset.
  214. schema:
  215. type: dict
  216. show_if: [["type", "=", "ixVolume"]]
  217. $ref:
  218. - "normalize/ixVolume"
  219. attrs:
  220. - variable: aclEnable
  221. label: Enable ACL
  222. description: Enable ACL for the dataset.
  223. schema:
  224. type: boolean
  225. default: false
  226. - variable: datasetName
  227. label: Dataset Name
  228. description: The name of the dataset to use for storage.
  229. schema:
  230. type: string
  231. required: true
  232. immutable: true
  233. hidden: true
  234. default: "media"
  235. - variable: aclEntries
  236. label: ACL Configuration
  237. schema:
  238. type: dict
  239. show_if: [["aclEnable", "=", true]]
  240. attrs: []
  241. - variable: hostPathConfig
  242. label: Host Path Configuration
  243. schema:
  244. type: dict
  245. show_if: [["type", "=", "hostPath"]]
  246. attrs:
  247. - variable: aclEnable
  248. label: Enable ACL
  249. description: Enable ACL for the dataset.
  250. schema:
  251. type: boolean
  252. default: false
  253. - variable: acl
  254. label: ACL Configuration
  255. schema:
  256. type: dict
  257. show_if: [["aclEnable", "=", true]]
  258. attrs: []
  259. $ref:
  260. - "normalize/acl"
  261. - variable: hostPath
  262. label: Host Path
  263. description: The host path to use for storage.
  264. schema:
  265. type: hostpath
  266. show_if: [["aclEnable", "=", false]]
  267. required: true
  268. - variable: pgData
  269. label: Home Assistant Postgres Data Storage
  270. description: The path to store Home Assistant Postgres Data.
  271. schema:
  272. type: dict
  273. attrs:
  274. - variable: type
  275. label: Type
  276. description: |
  277. ixVolume: Is dataset created automatically by the system.</br>
  278. Host Path: Is a path that already exists on the system.
  279. schema:
  280. type: string
  281. required: true
  282. immutable: true
  283. default: ixVolume
  284. enum:
  285. - value: hostPath
  286. description: Host Path (Path that already exists on the system)
  287. - value: ixVolume
  288. description: ixVolume (Dataset created automatically by the system)
  289. - variable: ixVolumeConfig
  290. label: ixVolume Configuration
  291. description: The configuration for the ixVolume dataset.
  292. schema:
  293. type: dict
  294. # Nothing to show for the user
  295. hidden: true
  296. show_if: [["type", "=", "ixVolume"]]
  297. $ref:
  298. - "normalize/ixVolume"
  299. attrs:
  300. - variable: aclEnable
  301. label: Enable ACL
  302. description: Enable ACL for the dataset.
  303. schema:
  304. type: boolean
  305. # Postgres does a CHMOD at startup
  306. # Which fails with ACL
  307. hidden: true
  308. default: false
  309. - variable: datasetName
  310. label: Dataset Name
  311. description: The name of the dataset to use for storage.
  312. schema:
  313. type: string
  314. required: true
  315. immutable: true
  316. hidden: true
  317. default: "pgData"
  318. - variable: aclEntries
  319. label: ACL Configuration
  320. schema:
  321. type: dict
  322. show_if: [["aclEnable", "=", true]]
  323. attrs: []
  324. - variable: hostPathConfig
  325. label: Host Path Configuration
  326. schema:
  327. type: dict
  328. show_if: [["type", "=", "hostPath"]]
  329. attrs:
  330. - variable: aclEnable
  331. label: Enable ACL
  332. description: Enable ACL for the dataset.
  333. schema:
  334. type: boolean
  335. # Postgres does a CHMOD at startup
  336. # Which fails with ACL
  337. hidden: true
  338. default: false
  339. - variable: acl
  340. label: ACL Configuration
  341. schema:
  342. type: dict
  343. show_if: [["aclEnable", "=", true]]
  344. attrs: []
  345. $ref:
  346. - "normalize/acl"
  347. - variable: hostPath
  348. label: Host Path
  349. description: The host path to use for storage.
  350. schema:
  351. type: hostpath
  352. show_if: [["aclEnable", "=", false]]
  353. required: true
  354. - variable: pgBackup
  355. label: Home Assistant Postgres Backup Storage
  356. description: The path to store Home Assistant Postgres Backup.
  357. schema:
  358. type: dict
  359. attrs:
  360. - variable: type
  361. label: Type
  362. description: |
  363. ixVolume: Is dataset created automatically by the system.</br>
  364. Host Path: Is a path that already exists on the system.
  365. schema:
  366. type: string
  367. required: true
  368. immutable: true
  369. default: ixVolume
  370. enum:
  371. - value: hostPath
  372. description: Host Path (Path that already exists on the system)
  373. - value: ixVolume
  374. description: ixVolume (Dataset created automatically by the system)
  375. - variable: ixVolumeConfig
  376. label: ixVolume Configuration
  377. description: The configuration for the ixVolume dataset.
  378. schema:
  379. type: dict
  380. # Nothing to show for the user
  381. hidden: true
  382. show_if: [["type", "=", "ixVolume"]]
  383. $ref:
  384. - "normalize/ixVolume"
  385. attrs:
  386. - variable: aclEnable
  387. label: Enable ACL
  388. description: Enable ACL for the dataset.
  389. schema:
  390. type: boolean
  391. # Postgres does a CHMOD at startup
  392. # Which fails with ACL
  393. hidden: true
  394. default: false
  395. - variable: datasetName
  396. label: Dataset Name
  397. description: The name of the dataset to use for storage.
  398. schema:
  399. type: string
  400. required: true
  401. immutable: true
  402. hidden: true
  403. default: "pgBackup"
  404. - variable: aclEntries
  405. label: ACL Configuration
  406. schema:
  407. type: dict
  408. show_if: [["aclEnable", "=", true]]
  409. attrs: []
  410. - variable: hostPathConfig
  411. label: Host Path Configuration
  412. schema:
  413. type: dict
  414. show_if: [["type", "=", "hostPath"]]
  415. attrs:
  416. - variable: aclEnable
  417. label: Enable ACL
  418. description: Enable ACL for the dataset.
  419. schema:
  420. type: boolean
  421. # Postgres does a CHMOD at startup
  422. # Which fails with ACL
  423. hidden: true
  424. default: false
  425. - variable: acl
  426. label: ACL Configuration
  427. schema:
  428. type: dict
  429. show_if: [["aclEnable", "=", true]]
  430. attrs: []
  431. $ref:
  432. - "normalize/acl"
  433. - variable: hostPath
  434. label: Host Path
  435. description: The host path to use for storage.
  436. schema:
  437. type: hostpath
  438. show_if: [["aclEnable", "=", false]]
  439. required: true
  440. - variable: additionalStorages
  441. label: Additional Storage
  442. description: Additional storage for Home Assistant.
  443. schema:
  444. type: list
  445. default: []
  446. items:
  447. - variable: storageEntry
  448. label: Storage Entry
  449. schema:
  450. type: dict
  451. attrs:
  452. - variable: type
  453. label: Type
  454. description: |
  455. ixVolume: Is dataset created automatically by the system.</br>
  456. Host Path: Is a path that already exists on the system.</br>
  457. SMB Share: Is a SMB share that is mounted to a persistent volume claim.
  458. schema:
  459. type: string
  460. required: true
  461. default: "ixVolume"
  462. immutable: true
  463. enum:
  464. - value: "hostPath"
  465. description: Host Path (Path that already exists on the system)
  466. - value: "ixVolume"
  467. description: ixVolume (Dataset created automatically by the system)
  468. - value: "smb-pv-pvc"
  469. description: SMB Share (Mounts a persistent volume claim to a SMB share)
  470. - variable: readOnly
  471. label: Read Only
  472. description: Mount the volume as read only.
  473. schema:
  474. type: boolean
  475. default: false
  476. - variable: mountPath
  477. label: Mount Path
  478. description: The path inside the container to mount the storage.
  479. schema:
  480. type: path
  481. required: true
  482. - variable: hostPathConfig
  483. label: Host Path Configuration
  484. schema:
  485. type: dict
  486. show_if: [["type", "=", "hostPath"]]
  487. attrs:
  488. - variable: aclEnable
  489. label: Enable ACL
  490. description: Enable ACL for the dataset.
  491. schema:
  492. type: boolean
  493. default: false
  494. - variable: acl
  495. label: ACL Configuration
  496. schema:
  497. type: dict
  498. show_if: [["aclEnable", "=", true]]
  499. attrs: []
  500. $ref:
  501. - "normalize/acl"
  502. - variable: hostPath
  503. label: Host Path
  504. description: The host path to use for storage.
  505. schema:
  506. type: hostpath
  507. show_if: [["aclEnable", "=", false]]
  508. required: true
  509. - variable: ixVolumeConfig
  510. label: ixVolume Configuration
  511. description: The configuration for the ixVolume dataset.
  512. schema:
  513. type: dict
  514. show_if: [["type", "=", "ixVolume"]]
  515. $ref:
  516. - "normalize/ixVolume"
  517. attrs:
  518. - variable: aclEnable
  519. label: Enable ACL
  520. description: Enable ACL for the dataset.
  521. schema:
  522. type: boolean
  523. default: false
  524. - variable: datasetName
  525. label: Dataset Name
  526. description: The name of the dataset to use for storage.
  527. schema:
  528. type: string
  529. required: true
  530. immutable: true
  531. default: "storage_entry"
  532. - variable: aclEntries
  533. label: ACL Configuration
  534. schema:
  535. type: dict
  536. show_if: [["aclEnable", "=", true]]
  537. attrs: []
  538. - variable: smbConfig
  539. label: SMB Share Configuration
  540. description: The configuration for the SMB Share.
  541. schema:
  542. type: dict
  543. show_if: [["type", "=", "smb-pv-pvc"]]
  544. attrs:
  545. - variable: server
  546. label: Server
  547. description: The server for the SMB share.
  548. schema:
  549. type: string
  550. required: true
  551. - variable: share
  552. label: Share
  553. description: The share name for the SMB share.
  554. schema:
  555. type: string
  556. required: true
  557. - variable: domain
  558. label: Domain (Optional)
  559. description: The domain for the SMB share.
  560. schema:
  561. type: string
  562. - variable: username
  563. label: Username
  564. description: The username for the SMB share.
  565. schema:
  566. type: string
  567. required: true
  568. - variable: password
  569. label: Password
  570. description: The password for the SMB share.
  571. schema:
  572. type: string
  573. required: true
  574. private: true
  575. - variable: size
  576. label: Size (in Gi)
  577. description: The size of the volume quota.
  578. schema:
  579. type: int
  580. required: true
  581. min: 1
  582. default: 1
  583. - variable: resources
  584. group: Resources Configuration
  585. label: ""
  586. schema:
  587. type: dict
  588. attrs:
  589. - variable: limits
  590. label: Limits
  591. schema:
  592. type: dict
  593. attrs:
  594. - variable: cpu
  595. label: CPU
  596. description: CPU limit for WG-Easy.
  597. schema:
  598. type: string
  599. max_length: 6
  600. valid_chars: '^(0\.[1-9]|[1-9][0-9]*)(\.[0-9]|m?)$'
  601. valid_chars_error: |
  602. Valid CPU limit formats are</br>
  603. - Plain Integer - eg. 1</br>
  604. - Float - eg. 0.5</br>
  605. - Milicpu - eg. 500m
  606. default: "4000m"
  607. required: true
  608. - variable: memory
  609. label: Memory
  610. description: Memory limit for WG-Easy.
  611. schema:
  612. type: string
  613. max_length: 12
  614. valid_chars: '^[1-9][0-9]*([EPTGMK]i?|e[0-9]+)?$'
  615. valid_chars_error: |
  616. Valid Memory limit formats are</br>
  617. - Suffixed with E/P/T/G/M/K - eg. 1G</br>
  618. - Suffixed with Ei/Pi/Ti/Gi/Mi/Ki - eg. 1Gi</br>
  619. - Plain Integer in bytes - eg. 1024</br>
  620. - Exponent - eg. 134e6
  621. default: "8Gi"
  622. required: true