questions.yaml 25 KB

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