SOC file for influx

salt/influxdb/soc_influxdb.yaml

@@ -87,252 +87,252 @@ influxdb:
         global: True
         helpLink: influxdb.html
       max-concurrent-queries: 
-        description: Enable InfluxDB meta server logging.
+        description: The maximum number of concurrent queries allowed to be executing at one time.
         global: True
         helpLink: influxdb.html
       query-timeout: 
-        description: Enable InfluxDB meta server logging.
+        description: The maximum time a query will is allowed to execute before being killed by the system.
         global: True
         helpLink: influxdb.html
       log-queries-after: 
-        description: Enable InfluxDB meta server logging.
+        description: The time threshold when a query will be logged as a slow query.
         global: True
         helpLink: influxdb.html
       max-select-point: 
-        description: Enable InfluxDB meta server logging.
+        description: The maximum number of points a SELECT can process.
         global: True
         advanced: True
         helpLink: influxdb.html
       max-select-series: 
-        description: Enable InfluxDB meta server logging.
+        description: The maximum number of series a SELECT can run.
         global: True
         advanced: True
         helpLink: influxdb.html
       max-select-buckets: 
-        description: Enable InfluxDB meta server logging.
+        description: The maxium number of group by time bucket a SELECT can create.
         global: True
         advanced: True
         helpLink: influxdb.html
     retention:
       enabled:
-        description: Enable InfluxDB meta server logging.
+        description: Determines whether retention policy enforcement enabled.
         global: True
         advanced: True
         helpLink: influxdb.html
       check-interval:
-        description: Enable InfluxDB meta server logging.
+        description: The interval of time when retention policy enforcement checks run.
         global: True
         helpLink: influxdb.html
     shard-precreation:
       enabled:
-        description: Enable InfluxDB meta server logging.
+        description: Determines whether shard pre-creation service is enabled.
         global: True
         advanced: True
         helpLink: influxdb.html
       check-interval:
-        description: Enable InfluxDB meta server logging.
+        description: The interval of time when the check to pre-create new shards runs.
         global: True
         helpLink: influxdb.html
       advance-period:
-        description: Enable InfluxDB meta server logging.
+        description: The default period ahead of the endtime of a shard group that its successor group is created.
         global: True
         advanced: True
         helpLink: influxdb.html
     monitor:
       store-enabled: 
-        description: Enable InfluxDB meta server logging.
+        description: Whether to record statistics internally.
         global: True
         helpLink: influxdb.html
       store-database: 
-        description: Enable InfluxDB meta server logging.
+        description: The destination database for recorded statistics.
         global: True
         advanced: True
         helpLink: influxdb.html
       store-interval: 
-        description: Enable InfluxDB meta server logging.
+        description: The interval at which to record statistics.
         global: True
         helpLink: influxdb.html
     http:
       enabled: 
-        description: Enable InfluxDB meta server logging.
+        description: Determines whether HTTP endpoint is enabled.
         global: True
         advanced: True
         helpLink: influxdb.html
       flux-enabled: 
-        description: Enable InfluxDB meta server logging.
+        description: Determines whether the Flux query endpoint is enabled.
         global: True
         advanced: True
         helpLink: influxdb.html
       bind-address: 
-        description: Enable InfluxDB meta server logging.
+        description: The bind address used by the HTTP service.
         global: True
         advanced: True
         helpLink: influxdb.html
       auth-enabled: 
-        description: Enable InfluxDB meta server logging.
+        description: Determines whether user authentication is enabled over HTTP/HTTPS.
         global: True
         advanced: True
         helpLink: influxdb.html
       realm: 
-        description: Enable InfluxDB meta server logging.
+        description: The default realm sent back when issuing a basic auth challenge.
         global: True
         advanced: True
         helpLink: influxdb.html
       log-enabled: 
-        description: Enable InfluxDB meta server logging.
+        description: Determines whether HTTP request logging is enabled.
         global: True
         helpLink: influxdb.html
       suppress-write-log: 
-        description: Enable InfluxDB meta server logging.
+        description: Determines whether the HTTP write request logs should be suppressed when the log is enabled.
         global: True
         helpLink: influxdb.html
       access-log-path: 
-        description: Enable InfluxDB meta server logging.
+        description: Path for http access logs.
         global: True
         advanced: True
         helpLink: influxdb.html
       access-log-status-filters: 
-        description: Enable InfluxDB meta server logging.
+        description: Filters which requests should be logged.
         global: True
         advanced: True
         helpLink: influxdb.html
       write-tracing: 
-        description: Enable InfluxDB meta server logging.
+        description: Determines whether detailed write logging is enabled.
         global: True
         advanced: True
         helpLink: influxdb.html
       pprof-enabled: 
-        description: Enable InfluxDB meta server logging.
+        description: Determines whether the pprof endpoint is enabled.
         global: True
         advanced: True
         helpLink: influxdb.html
       debug-pprof-enabled:
-        description: Enable InfluxDB meta server logging.
+        description: Determines whether the pprof endpoint is enabled in debug mode.
         global: True
         advanced: True
         helpLink: influxdb.html
       https-enabled: 
-        description: Enable InfluxDB meta server logging.
+        description: Determines whether HTTPS is enabled.
         global: True
         helpLink: influxdb.html
       https-certificate: 
-        description: Enable InfluxDB meta server logging.
+        description: The SSL certificate to use when HTTPS is enabled.
         global: True
         advanced: True
         helpLink: influxdb.html
       https-private-key: 
-        description: Enable InfluxDB meta server logging.
+        description: Use a separate private key location.
         global: True
         advanced: True
         helpLink: influxdb.html
       shared-secret: 
-        description: Enable InfluxDB meta server logging.
+        description: The JWT auth shared secret to validate requests using JSON web tokens.
         global: True
         advanced: True
         helpLink: influxdb.html
       max-row-limit: 
-        description: Enable InfluxDB meta server logging.
+        description: The default chunk size for result sets that should be chunked.
         global: True
         helpLink: influxdb.html
       max-connection-limit: 
-        description: Enable InfluxDB meta server logging.
+        description: The maximum number of HTTP connections that may be open at once.
         global: True
         helpLink: influxdb.html
       unix-socket-enabled: 
-        description: Enable InfluxDB meta server logging.
+        description: Enable http service over unix domain socket.
         global: True
         advanced: True
         helpLink: influxdb.html
       bind-socket: 
-        description: Enable InfluxDB meta server logging.
+        description: The path of the unix domain socket.
         global: True
         advanced: True
         helpLink: influxdb.html
       max-body-size: 
-        description: Enable InfluxDB meta server logging.
+        description: The maximum size of a client request body, in bytes. 
         global: True
         helpLink: influxdb.html
       max-concurrent-write-limit:
-        description: Enable InfluxDB meta server logging.
+        description: The maximum number of writes processed concurrently.
         global: True
         helpLink: influxdb.html
       max-enqueued-write-limit: 
-        description: Enable InfluxDB meta server logging.
+        description: The maximum number of writes queued for processing.
         global: True
         helpLink: influxdb.html
       enqueued-write-timeout: 
-        description: Enable InfluxDB meta server logging.
+        description: The maximum duration for a write to wait in the queue to be processed.
         global: True
         helpLink: influxdb.html
     logging:
       format: 
-        description: Enable InfluxDB meta server logging.
+        description: Determines which log encoder to use for logs.
         global: True
         helpLink: influxdb.html
       level: 
-        description: Enable InfluxDB meta server logging.
+        description: Determines which level of logs will be emitted.
         global: True
         helpLink: influxdb.html
       suppress-logo: 
-        description: Enable InfluxDB meta server logging.
+        description: Suppresses the logo output that is printed when the program is started.
         global: True
         helpLink: influxdb.html
     subscriber:
       enabled: 
-        description: Enable InfluxDB meta server logging.
+        description: Determines whether the subscriber service is enabled.
         global: True
         advanced: True
         helpLink: influxdb.html
       http-timeout: 
-        description: Enable InfluxDB meta server logging.
+        description: The default timeout for HTTP writes to subscribers.
         global: True
         helpLink: influxdb.html
       insecure-skip-verify: 
-        description: Enable InfluxDB meta server logging.
+        description: Allows insecure HTTPS connections to subscribers.
         global: True
         advanced: True
         helpLink: influxdb.html
       ca-certs: 
-        description: Enable InfluxDB meta server logging.
+        description: The path to the PEM encoded CA certs file.
         global: True
         advanced: True
         helpLink: influxdb.html
       write-concurrency: 
-        description: Enable InfluxDB meta server logging.
+        description: he number of writer goroutines processing the write channel.
         global: True
         helpLink: influxdb.html
       write-buffer-size: 
-        description: Enable InfluxDB meta server logging.
+        description: The number of in-flight writes buffered in the write channel.
         global: True
         helpLink: influxdb.html
     continuous_queries:
       enabled: 
-        description: Enable InfluxDB meta server logging.
+        description: Determines whether the continuous query service is enabled.
         global: True
         helpLink: influxdb.html
       log-enabled: 
-        description: Enable InfluxDB meta server logging.
+        description: Controls whether queries are logged when executed by the CQ service.
         global: True
         helpLink: influxdb.html
       query-stats-enabled: 
-        description: Enable InfluxDB meta server logging.
+        description: Controls whether queries are logged to the self-monitoring data store.
         global: True
         helpLink: influxdb.html
       run-interval: 
-        description: Enable InfluxDB meta server logging.
+        description: Interval for how often continuous queries will be checked if they need to run.
         global: True
         helpLink: influxdb.html
     tls:
       ciphers:
-        description: Enable InfluxDB meta server logging.
+        description: Determines the available set of cipher suites.
         global: True
         helpLink: influxdb.html
       min-version:
-        description: Enable InfluxDB meta server logging.
+        description: Minimum version of the tls protocol that will be negotiated.
         global: True
         helpLink: influxdb.html
       max-version:
-        description: Enable InfluxDB meta server logging.
+        description: Maximum version of the tls protocol that will be negotiated.
         global: True
         helpLink: influxdb.html
   retention_policies: