questions.yaml 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464
  1. groups:
  2. - name: Forgejo Runner Configuration
  3. description: Configure Forgejo Runner
  4. - name: User and Group Configuration
  5. description: Configure User and Group for Forgejo Runner
  6. - name: Network Configuration
  7. description: Configure Network for Forgejo Runner
  8. - name: Storage Configuration
  9. description: Configure Storage for Forgejo Runner
  10. - name: Labels Configuration
  11. description: Configure Labels for Forgejo Runner
  12. - name: Resources Configuration
  13. description: Configure Resources for Forgejo Runner
  14. questions:
  15. - variable: TZ
  16. group: Forgejo Runner Configuration
  17. label: Timezone
  18. schema:
  19. type: string
  20. default: Etc/UTC
  21. required: true
  22. $ref:
  23. - definitions/timezone
  24. - variable: forgejo_runner
  25. label: ""
  26. group: Forgejo Runner Configuration
  27. schema:
  28. type: dict
  29. attrs:
  30. - variable: instance_url
  31. label: Instance URL
  32. description: The URL of the Forgejo instance to use.
  33. schema:
  34. type: string
  35. default: ""
  36. required: true
  37. - variable: runner_name
  38. label: Runner Name
  39. description: The name of the runner to use.
  40. schema:
  41. type: string
  42. default: ""
  43. required: true
  44. - variable: runner_registration_token
  45. label: Runner Registration Token
  46. description: The registration token for the runner.
  47. schema:
  48. type: string
  49. default: ""
  50. required: true
  51. private: true
  52. - variable: runner_labels
  53. label: Runner Labels
  54. description: The labels for the runner. (https://forgejo.org/docs/latest/admin/actions/#choosing-labels)
  55. schema:
  56. type: list
  57. default: []
  58. items:
  59. - variable: label
  60. label: Label
  61. schema:
  62. type: string
  63. required: true
  64. - variable: additional_envs
  65. label: Additional Environment Variables
  66. schema:
  67. type: list
  68. default: []
  69. items:
  70. - variable: env
  71. label: Environment Variable
  72. schema:
  73. type: dict
  74. attrs:
  75. - variable: name
  76. label: Name
  77. schema:
  78. type: string
  79. required: true
  80. - variable: value
  81. label: Value
  82. schema:
  83. type: string
  84. - variable: run_as
  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 Forgejo Runner 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 Forgejo Runner files will be owned by.
  101. schema:
  102. type: int
  103. min: 568
  104. default: 568
  105. required: true
  106. - variable: network
  107. label: ""
  108. group: Network Configuration
  109. schema:
  110. type: dict
  111. attrs:
  112. - variable: host_network
  113. label: Host Network
  114. description: |
  115. Bind to the host network. It's recommended to keep this disabled.
  116. schema:
  117. type: boolean
  118. show_if: [["dhcp_enabled", "=", false]]
  119. default: false
  120. - variable: additional_ports
  121. label: Additional Ports
  122. schema:
  123. type: list
  124. show_if: [["host_network", "=", false]]
  125. items:
  126. - variable: port
  127. label: Port
  128. schema:
  129. type: dict
  130. attrs:
  131. - variable: bind_mode
  132. label: Port Bind Mode
  133. description: |
  134. The port bind mode.</br>
  135. - Publish: The port will be published on the host for external access.</br>
  136. - Expose: The port will be exposed for inter-container communication.</br>
  137. schema:
  138. type: string
  139. default: "published"
  140. enum:
  141. - value: "published"
  142. description: Publish port on the host for external access
  143. - value: "exposed"
  144. description: Expose port for inter-container communication
  145. - variable: port_number
  146. label: Port Number
  147. schema:
  148. type: int
  149. min: 1
  150. max: 65535
  151. required: true
  152. - variable: container_port
  153. label: Container Port
  154. schema:
  155. type: int
  156. min: 1
  157. max: 65535
  158. required: true
  159. - variable: protocol
  160. label: Protocol
  161. schema:
  162. type: string
  163. required: true
  164. default: "tcp"
  165. enum:
  166. - value: "tcp"
  167. description: TCP
  168. - value: "udp"
  169. description: UDP
  170. - variable: host_ips
  171. label: Host IPs
  172. description: IPs on the host to bind this port
  173. schema:
  174. type: list
  175. show_if: [["bind_mode", "=", "published"]]
  176. default: []
  177. items:
  178. - variable: host_ip
  179. label: Host IP
  180. schema:
  181. type: string
  182. required: true
  183. $ref:
  184. - definitions/node_bind_ip
  185. - variable: storage
  186. label: ""
  187. group: Storage Configuration
  188. schema:
  189. type: dict
  190. attrs:
  191. - variable: data
  192. label: Forgejo Runner Data Storage
  193. description: The path to store Forgejo Runner Data.
  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. default: "ix_volume"
  206. enum:
  207. - value: "host_path"
  208. description: Host Path (Path that already exists on the system)
  209. - value: "ix_volume"
  210. description: ixVolume (Dataset created automatically by the system)
  211. - variable: ix_volume_config
  212. label: ixVolume Configuration
  213. description: The configuration for the ixVolume dataset.
  214. schema:
  215. type: dict
  216. show_if: [["type", "=", "ix_volume"]]
  217. $ref:
  218. - "normalize/ix_volume"
  219. attrs:
  220. - variable: acl_enable
  221. label: Enable ACL
  222. description: Enable ACL for the storage.
  223. schema:
  224. type: boolean
  225. default: false
  226. - variable: dataset_name
  227. label: Dataset Name
  228. description: The name of the dataset to use for storage.
  229. schema:
  230. type: string
  231. required: true
  232. hidden: true
  233. default: "data"
  234. - variable: acl_entries
  235. label: ACL Configuration
  236. schema:
  237. type: dict
  238. show_if: [["acl_enable", "=", true]]
  239. attrs: []
  240. - variable: host_path_config
  241. label: Host Path Configuration
  242. schema:
  243. type: dict
  244. show_if: [["type", "=", "host_path"]]
  245. attrs:
  246. - variable: acl_enable
  247. label: Enable ACL
  248. description: Enable ACL for the storage.
  249. schema:
  250. type: boolean
  251. default: false
  252. - variable: acl
  253. label: ACL Configuration
  254. schema:
  255. type: dict
  256. show_if: [["acl_enable", "=", true]]
  257. attrs: []
  258. $ref:
  259. - "normalize/acl"
  260. - variable: path
  261. label: Host Path
  262. description: The host path to use for storage.
  263. schema:
  264. type: hostpath
  265. show_if: [["acl_enable", "=", false]]
  266. required: true
  267. - variable: additional_storage
  268. label: Additional Storage
  269. schema:
  270. type: list
  271. default: []
  272. items:
  273. - variable: storageEntry
  274. label: Storage Entry
  275. schema:
  276. type: dict
  277. attrs:
  278. - variable: type
  279. label: Type
  280. description: |
  281. ixVolume: Is dataset created automatically by the system.</br>
  282. Host Path: Is a path that already exists on the system.</br>
  283. SMB Share: Is a SMB share that is mounted to as a volume.
  284. schema:
  285. type: string
  286. required: true
  287. default: "ix_volume"
  288. enum:
  289. - value: "host_path"
  290. description: Host Path (Path that already exists on the system)
  291. - value: "ix_volume"
  292. description: ixVolume (Dataset created automatically by the system)
  293. - value: "cifs"
  294. description: SMB/CIFS Share (Mounts a volume to a SMB share)
  295. - variable: read_only
  296. label: Read Only
  297. description: Mount the volume as read only.
  298. schema:
  299. type: boolean
  300. default: false
  301. - variable: mount_path
  302. label: Mount Path
  303. description: The path inside the container to mount the storage.
  304. schema:
  305. type: path
  306. required: true
  307. - variable: host_path_config
  308. label: Host Path Configuration
  309. schema:
  310. type: dict
  311. show_if: [["type", "=", "host_path"]]
  312. attrs:
  313. - variable: acl_enable
  314. label: Enable ACL
  315. description: Enable ACL for the storage.
  316. schema:
  317. type: boolean
  318. default: false
  319. - variable: acl
  320. label: ACL Configuration
  321. schema:
  322. type: dict
  323. show_if: [["acl_enable", "=", true]]
  324. attrs: []
  325. $ref:
  326. - "normalize/acl"
  327. - variable: path
  328. label: Host Path
  329. description: The host path to use for storage.
  330. schema:
  331. type: hostpath
  332. show_if: [["acl_enable", "=", false]]
  333. required: true
  334. - variable: ix_volume_config
  335. label: ixVolume Configuration
  336. description: The configuration for the ixVolume dataset.
  337. schema:
  338. type: dict
  339. show_if: [["type", "=", "ix_volume"]]
  340. $ref:
  341. - "normalize/ix_volume"
  342. attrs:
  343. - variable: acl_enable
  344. label: Enable ACL
  345. description: Enable ACL for the storage.
  346. schema:
  347. type: boolean
  348. default: false
  349. - variable: dataset_name
  350. label: Dataset Name
  351. description: The name of the dataset to use for storage.
  352. schema:
  353. type: string
  354. required: true
  355. default: "storage_entry"
  356. - variable: acl_entries
  357. label: ACL Configuration
  358. schema:
  359. type: dict
  360. show_if: [["acl_enable", "=", true]]
  361. attrs: []
  362. $ref:
  363. - "normalize/acl"
  364. - variable: cifs_config
  365. label: SMB Configuration
  366. description: The configuration for the SMB dataset.
  367. schema:
  368. type: dict
  369. show_if: [["type", "=", "cifs"]]
  370. attrs:
  371. - variable: server
  372. label: Server
  373. description: The server to mount the SMB share.
  374. schema:
  375. type: string
  376. required: true
  377. - variable: path
  378. label: Path
  379. description: The path to mount the SMB share.
  380. schema:
  381. type: string
  382. required: true
  383. - variable: username
  384. label: Username
  385. description: The username to use for the SMB share.
  386. schema:
  387. type: string
  388. required: true
  389. - variable: password
  390. label: Password
  391. description: The password to use for the SMB share.
  392. schema:
  393. type: string
  394. required: true
  395. private: true
  396. - variable: domain
  397. label: Domain
  398. description: The domain to use for the SMB share.
  399. schema:
  400. type: string
  401. - variable: labels
  402. label: ""
  403. group: Labels Configuration
  404. schema:
  405. type: list
  406. default: []
  407. items:
  408. - variable: label
  409. label: Label
  410. schema:
  411. type: dict
  412. attrs:
  413. - variable: key
  414. label: Key
  415. schema:
  416. type: string
  417. required: true
  418. - variable: value
  419. label: Value
  420. schema:
  421. type: string
  422. required: true
  423. - variable: containers
  424. label: Containers
  425. description: Containers where the label should be applied
  426. schema:
  427. type: list
  428. items:
  429. - variable: container
  430. label: Container
  431. schema:
  432. type: string
  433. required: true
  434. enum:
  435. - value: forgejo-runner
  436. description: forgejo-runner
  437. - variable: resources
  438. label: ""
  439. group: Resources Configuration
  440. schema:
  441. type: dict
  442. attrs:
  443. - variable: limits
  444. label: Limits
  445. schema:
  446. type: dict
  447. attrs:
  448. - variable: cpus
  449. label: CPUs
  450. description: CPUs limit for Forgejo Runner.
  451. schema:
  452. type: int
  453. default: 2
  454. required: true
  455. - variable: memory
  456. label: Memory (in MB)
  457. description: Memory limit for Forgejo Runner.
  458. schema:
  459. type: int
  460. default: 4096
  461. required: true