template.yaml 5.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213
  1. ---
  2. kind: helm
  3. metadata:
  4. icon:
  5. provider: selfh
  6. id: netbox
  7. name: NetBox
  8. description: |
  9. Helm values template for NetBox, an open-source network infrastructure management (IPAM/DCIM)
  10. solution and network automation source of truth.
  11. ## Chart Information
  12. * **Chart Repository:** https://charts.bootsource.github.io/charts
  13. * **Chart Name:** netbox
  14. * **Chart Version:** Compatible with NetBox 4.2.3
  15. ## References
  16. * **Project:** https://netbox.dev/
  17. * **Documentation:** https://docs.netbox.dev/
  18. * **GitHub:** https://github.com/netbox-community/netbox
  19. version: 4.2.3
  20. author: Christian Lempa
  21. date: '2025-01-13'
  22. draft: true
  23. schema: "1.2"
  24. spec:
  25. general:
  26. vars:
  27. release_name:
  28. default: netbox
  29. namespace:
  30. default: netbox
  31. database:
  32. title: Database Configuration
  33. toggle: database_enabled
  34. vars:
  35. database_enabled:
  36. type: bool
  37. description: Enable database
  38. default: true
  39. database_type:
  40. type: enum
  41. description: Database type
  42. options: [postgres, mysql]
  43. default: postgres
  44. database_host:
  45. type: hostname
  46. description: Database host
  47. default: netbox-postgresql
  48. database_port:
  49. type: int
  50. description: Database port
  51. default: 5432
  52. database_name:
  53. type: str
  54. description: Database name
  55. default: netbox
  56. database_user:
  57. type: str
  58. description: Database user
  59. default: netbox
  60. database_password:
  61. type: str
  62. description: Database password
  63. sensitive: true
  64. autogenerated: true
  65. networking:
  66. title: Networking Configuration
  67. vars:
  68. network_mode:
  69. type: str
  70. description: Network mode for service
  71. default: ClusterIP
  72. redis:
  73. title: Redis Configuration
  74. description: Configure Redis for caching and task queuing
  75. required: true
  76. vars:
  77. redis_enabled:
  78. description: Enable Redis deployment
  79. type: bool
  80. default: true
  81. redis_host:
  82. description: Redis host for tasks
  83. type: hostname
  84. default: netbox-redis-master
  85. redis_cache_host:
  86. description: Redis host for caching
  87. type: hostname
  88. default: netbox-redis-master
  89. redis_password:
  90. description: Redis password
  91. type: str
  92. sensitive: true
  93. autogenerated: true
  94. email:
  95. title: Email Configuration
  96. toggle: email_enabled
  97. vars:
  98. email_enabled:
  99. type: bool
  100. description: Enable email notifications
  101. default: false
  102. email_host:
  103. type: hostname
  104. description: SMTP server hostname
  105. default: smtp.example.com
  106. email_port:
  107. type: int
  108. description: SMTP server port
  109. default: 587
  110. email_username:
  111. type: str
  112. description: SMTP username
  113. default: ""
  114. email_from:
  115. type: email
  116. description: From email address
  117. default: netbox@example.com
  118. email_use_tls:
  119. type: bool
  120. description: Use TLS/STARTTLS for SMTP connection
  121. default: true
  122. email_use_ssl:
  123. type: bool
  124. description: Use SSL for SMTP connection
  125. default: false
  126. traefik:
  127. title: Traefik Configuration
  128. toggle: traefik_enabled
  129. vars:
  130. traefik_enabled:
  131. type: bool
  132. description: Enable Traefik ingress
  133. default: false
  134. traefik_host:
  135. type: hostname
  136. description: Traefik hostname
  137. default: netbox.home.arpa
  138. traefik_tls_enabled:
  139. type: bool
  140. description: Enable TLS for Traefik ingress
  141. default: false
  142. traefik_tls_secret:
  143. type: str
  144. description: TLS secret name for Traefik ingress
  145. default: netbox-tls
  146. traefik_tls_certmanager:
  147. type: bool
  148. description: Use cert-manager for TLS certificate
  149. default: false
  150. certmanager_issuer:
  151. type: str
  152. description: Cert-manager issuer name
  153. needs: traefik_tls_certmanager=true
  154. default: letsencrypt-prod
  155. volumes:
  156. title: Volume Configuration
  157. vars:
  158. volumes_mode:
  159. type: enum
  160. description: Volume storage mode
  161. options: [pvc, hostPath]
  162. default: pvc
  163. volumes_pvc_name:
  164. type: str
  165. description: PVC name for volumes
  166. default: netbox-data
  167. netbox:
  168. title: NetBox Configuration
  169. description: Configure NetBox application settings
  170. required: true
  171. vars:
  172. netbox_secret_key:
  173. description: Secret Key
  174. extra: Used for cryptographic signing and session management
  175. type: str
  176. sensitive: true
  177. autogenerated: true
  178. netbox_superuser_name:
  179. description: Initial superuser username
  180. type: str
  181. default: admin
  182. netbox_superuser_email:
  183. description: Initial superuser email
  184. type: email
  185. default: admin@example.com
  186. netbox_superuser_password:
  187. description: Initial superuser password
  188. type: str
  189. sensitive: true
  190. autogenerated: true
  191. netbox_superuser_api_token:
  192. description: Initial superuser API token
  193. type: str
  194. sensitive: true
  195. autogenerated: true
  196. netbox_allowed_hosts:
  197. description: Allowed hosts (comma-separated)
  198. extra: Add your domain names or IP addresses
  199. type: str
  200. default: "*"
  201. netbox_metrics_enabled:
  202. description: Enable Prometheus metrics endpoint
  203. type: bool
  204. default: false
  205. netbox_cors_enabled:
  206. description: Enable CORS (Cross-Origin Resource Sharing)
  207. type: bool
  208. default: false
  209. netbox_cors_origins:
  210. description: Allowed CORS origins
  211. needs: netbox_cors_enabled=true
  212. type: str
  213. default: "https://example.com"