Add remaining docs for corrosion's config file

doc/SUMMARY.md

@@ -42,7 +42,7 @@
 - [Configuration](config/README.md)
     - [db](config/db.md)
     - [gossip](config/gossip.md)
-    - [api]() (to come)
-    - [admin]() (to come)
-    - [telemetry]() (to come)
-    - [consul]() (to come)
+    - [api](config/api.md)
+    - [admin](config/admin.md)
+    - [telemetry](config/telemetry.md)
+    - [consul](config/consul.md)

doc/config/README.md

@@ -5,7 +5,7 @@ Corrosion configuration lives in a TOML file. The default location is `/etc/corr
 Configuration sections:
 - [db](db.md)
 - [gossip](gossip.md)
-- [api]() (to come)
-- [admin]() (to come)
-- [telemetry]() (to come)
-- [consul]() (to come)
+- [api](api.md)
+- [admin](admin.md)
+- [telemetry](telemetry.md)
+- [consul](consul.md)

doc/config/admin.md

@@ -0,0 +1,10 @@
+# The [admin] block
+
+## admin.path
+
+Path for unix socket used to send commands for admin operations.
+
+```toml
+[admin]
+path = "/admin.sock"
+```

doc/config/api.md

@@ -0,0 +1,30 @@
+# The [api] block
+
+## api.addr
+
+Address for the Corrosion HTTP API to listen on.
+
+```toml
+[api]
+addr = "0.0.0.0:9000"
+```
+
+## api.authz.bearer-token
+
+Bearer token that will be used to authenticate HTTP requests.
+The client should set this token in the `Authorization` header.
+
+```toml
+[api]
+authz.bearer-token = "<token>"
+```
+
+## api.pg.addr
+
+Address to listen on for PostgresQL connections.
+This allows you to query the sqlite databases using SQL.
+
+```toml
+[api]
+pg.addr = ""
+```

doc/config/consul.md

@@ -0,0 +1,16 @@
+# The [consul] block
+
+## consul.client.addr
+
+Local address of consul server.
+
+## consul.client.tls
+
+TLS configuration to use when communicating with Consul.
+
+```toml
+[consul.client.tls]
+ca_file = ""
+cert_file = ""
+key_file = ""
+```

doc/config/telemetry.md

@@ -0,0 +1,36 @@
+# The [telemetry] configuration
+
+The telemetry block is optional. This block configures open telemetry and prometheus.
+
+## Optional Fields
+
+### telemetry.prometheus.addr
+
+Address for the prometheus exporter binds to. `GET` requests to this address will return prometheus metrics.
+
+```toml
+[telemetry]
+prometheus.addr = "0.0.0.0:9090"
+```
+
+You can read more about the Prometheus metrics that corrosion exposes [here](../telemetry/prometheus.md).
+
+### telemetry.open-telemetry
+
+This block configures how the open telemetry exporter.
+
+Configure open telemetry exporter using environment variables. The environment variables and their default are listed [here](https://opentelemetry.io/docs/specs/otel/protocol/exporter/).
+
+```toml
+[telemetry]
+open-telemetry = "from_env"
+```
+
+### telemetry.open-telemetry.exporter
+
+Address that open telemetry exporter should send traces to.
+
+```toml
+[telemetry]
+open-telemetry.exporter = { endpoint = "10.0.0.0:9999"}
+```