Auto generate docs and examples

docs/services-all.md

@@ -23,6 +23,7 @@
   services.opensearch.enable = true;
   services.opentelemetry-collector.enable = true;
   services.postgres.enable = true;
+  services.prometheus.enable = true;
   services.rabbitmq.enable = true;
   services.redis.enable = true;
   services.sqld.enable = true;

docs/supported-services/prometheus.md

@@ -0,0 +1,318 @@
+[comment]: # (Do not edit this file as it is autogenerated. Go to docs/individual-docs if you want to make edits.)
+
+
+[comment]: # (Please add your documentation on top of this line)
+
+## services\.prometheus\.enable
+
+
+
+Whether to enable Prometheus monitoring system\.
+
+
+
+*Type:*
+boolean
+
+
+
+*Default:*
+` false `
+
+
+
+*Example:*
+` true `
+
+
+
+## services\.prometheus\.package
+
+
+
+Which package of Prometheus to use
+
+
+
+*Type:*
+package
+
+
+
+*Default:*
+` pkgs.prometheus `
+
+
+
+## services\.prometheus\.advanced\.storage
+
+Storage configuration
+
+
+
+*Type:*
+attribute set
+
+
+
+*Default:*
+` { } `
+
+
+
+## services\.prometheus\.advanced\.tsdb
+
+
+
+TSDB configuration
+
+
+
+*Type:*
+attribute set
+
+
+
+*Default:*
+` { } `
+
+
+
+## services\.prometheus\.alerting
+
+
+
+Alerting configuration
+
+
+
+*Type:*
+null or (attribute set)
+
+
+
+*Default:*
+` null `
+
+
+
+## services\.prometheus\.experimentalFeatures\.enableExemplars
+
+
+
+Enable exemplar storage
+
+
+
+*Type:*
+boolean
+
+
+
+*Default:*
+` false `
+
+
+
+## services\.prometheus\.experimentalFeatures\.enableOTLP
+
+
+
+Enable OTLP receiver
+
+
+
+*Type:*
+boolean
+
+
+
+*Default:*
+` false `
+
+
+
+## services\.prometheus\.experimentalFeatures\.enableTracing
+
+
+
+Enable tracing
+
+
+
+*Type:*
+boolean
+
+
+
+*Default:*
+` false `
+
+
+
+## services\.prometheus\.extraArgs
+
+
+
+Additional arguments to pass to Prometheus
+
+
+
+*Type:*
+string
+
+
+
+*Default:*
+` "" `
+
+
+
+## services\.prometheus\.globalConfig
+
+
+
+Global Prometheus configuration
+
+
+
+*Type:*
+attribute set
+
+
+
+*Default:*
+
+```
+{
+  evaluation_interval = "1m";
+  scrape_interval = "1m";
+  scrape_timeout = "10s";
+}
+```
+
+
+
+## services\.prometheus\.port
+
+
+
+Port for Prometheus web interface
+
+
+
+*Type:*
+16 bit unsigned integer; between 0 and 65535 (both inclusive)
+
+
+
+*Default:*
+` 9090 `
+
+
+
+## services\.prometheus\.remoteRead
+
+
+
+Remote read configurations
+
+
+
+*Type:*
+list of (attribute set)
+
+
+
+*Default:*
+` [ ] `
+
+
+
+## services\.prometheus\.remoteWrite
+
+
+
+Remote write configurations
+
+
+
+*Type:*
+list of (attribute set)
+
+
+
+*Default:*
+` [ ] `
+
+
+
+## services\.prometheus\.ruleFiles
+
+
+
+List of rule files to load
+
+
+
+*Type:*
+list of string
+
+
+
+*Default:*
+` [ ] `
+
+
+
+## services\.prometheus\.scrapeConfigs
+
+
+
+List of scrape configurations
+
+
+
+*Type:*
+list of (attribute set)
+
+
+
+*Default:*
+` [ ] `
+
+
+
+## services\.prometheus\.storage\.path
+
+
+
+Path where Prometheus will store its database
+
+
+
+*Type:*
+string
+
+
+
+*Default:*
+` "/home/runner/work/devenv/devenv/.devenv/state/prometheus" `
+
+
+
+## services\.prometheus\.storage\.retentionTime
+
+
+
+How long to retain data
+
+
+
+*Type:*
+string
+
+
+
+*Default:*
+` "15d" `