diff --git a/config.md b/config.md index 9e6b308f48..0e7eb8ce4a 100644 --- a/config.md +++ b/config.md @@ -1,7 +1,7 @@ # Honeycomb Refinery Configuration Documentation This is the documentation for the configuration file for Honeycomb's Refinery. -It was automatically generated on 2023-06-24 at 14:59:24 UTC. +It was automatically generated on 2023-06-27 at 22:07:32 UTC. ## The Config file @@ -111,7 +111,7 @@ Incoming traffic is expected to be HTTP, so if SSL is a requirement, put somethi - Type: `hostport` - Default: `0.0.0.0:8080` - Environment variable: `REFINERY_HTTP_LISTEN_ADDRESS` -- Command line switch: `--http-listen-addr` +- Command line switch: `--http-listen-address` ### `PeerListenAddr` @@ -123,7 +123,7 @@ Incoming traffic is expected to be HTTP, so if using SSL use something like ngin - Type: `hostport` - Default: `0.0.0.0:8081` - Environment variable: `REFINERY_PEER_LISTEN_ADDRESS` -- Command line switch: `--peer-listen-addr` +- Command line switch: `--peer-listen-address` ### `HoneycombAPI` @@ -155,10 +155,10 @@ This list only applies to span traffic - other Honeycomb API actions will be pro AcceptOnlyListedKeys is a boolean flag that causes events arriving with API keys not in the `ReceiveKeys` list to be rejected. -If `true`, then only traffic using the keys listed in `APIKeys` is accepted. +If `true`, then only traffic using the keys listed in `ReceiveKeys` is accepted. Events arriving with API keys not in the `ReceiveKeys` list will be rejected with an HTTP `401` error. If `false`, then all traffic is accepted and `ReceiveKeys` is ignored. -Must be specified if `APIKeys` is specified. +Must be specified if `ReceiveKeys` is specified. - Eligible for live reload. - Type: `bool` @@ -895,7 +895,7 @@ Incoming traffic is expected to be unencrypted, so if using SSL, then put someth - Not eligible for live reload. - Type: `hostport` - Environment variable: `REFINERY_GRPC_LISTEN_ADDRESS` -- Command line switch: `--grpc-listen-addr` +- Command line switch: `--grpc-listen-address` ### `MaxConnectionIdle` diff --git a/refinery_config.md b/refinery_config.md index 1f8c40113e..520055a194 100644 --- a/refinery_config.md +++ b/refinery_config.md @@ -86,7 +86,7 @@ Incoming traffic is expected to be HTTP, so if SSL is a requirement, put somethi - Type: `hostport` - Default: `0.0.0.0:8080` - Environment variable: `REFINERY_HTTP_LISTEN_ADDRESS` -- Command line switch: `--http-listen-addr` +- Command line switch: `--http-listen-address` ### `PeerListenAddr` @@ -98,7 +98,7 @@ Incoming traffic is expected to be HTTP, so if using SSL use something like ngin - Type: `hostport` - Default: `0.0.0.0:8081` - Environment variable: `REFINERY_PEER_LISTEN_ADDRESS` -- Command line switch: `--peer-listen-addr` +- Command line switch: `--peer-listen-address` ### `HoneycombAPI` @@ -130,10 +130,10 @@ This list only applies to span traffic - other Honeycomb API actions will be pro `AcceptOnlyListedKeys` is a boolean flag that causes events arriving with API keys not in the `ReceiveKeys` list to be rejected. -If `true`, then only traffic using the keys listed in `APIKeys` is accepted. +If `true`, then only traffic using the keys listed in `ReceiveKeys` is accepted. Events arriving with API keys not in the `ReceiveKeys` list will be rejected with an HTTP `401` error. If `false`, then all traffic is accepted and `ReceiveKeys` is ignored. -Must be specified if `APIKeys` is specified. +Must be specified if `ReceiveKeys` is specified. - Eligible for live reload. - Type: `bool` @@ -879,7 +879,7 @@ Incoming traffic is expected to be unencrypted, so if using SSL, then put someth - Not eligible for live reload. - Type: `hostport` - Environment variable: `REFINERY_GRPC_LISTEN_ADDRESS` -- Command line switch: `--grpc-listen-addr` +- Command line switch: `--grpc-listen-address` ### `MaxConnectionIdle` diff --git a/tools/convert/templates/configV2.tmpl b/tools/convert/templates/configV2.tmpl index 166b8a3278..f07021e744 100644 --- a/tools/convert/templates/configV2.tmpl +++ b/tools/convert/templates/configV2.tmpl @@ -2,7 +2,7 @@ ## Honeycomb Refinery Configuration ## ###################################### # -# created {{ now }} from {{ .Input }} using a template generated on 2023-06-22 at 23:17:29 UTC +# created {{ now }} from {{ .Input }} using a template generated on 2023-06-27 at 22:07:30 UTC # This file contains the configuration for the Honeycomb Refinery. # More stuff will go here later. @@ -129,11 +129,11 @@ AccessKeys: ## AcceptOnlyListedKeys is a boolean flag that causes events arriving ## with API keys not in the `ReceiveKeys` list to be rejected. ## - ## If `true`, then only traffic using the keys listed in `APIKeys` is + ## If `true`, then only traffic using the keys listed in `ReceiveKeys` is ## accepted. Events arriving with API keys not in the `ReceiveKeys` list ## will be rejected with an HTTP `401` error. ## If `false`, then all traffic is accepted and `ReceiveKeys` is ignored. - ## Must be specified if `APIKeys` is specified. + ## Must be specified if `ReceiveKeys` is specified. ## ## Eligible for live reload. {{ conditional .Data "AcceptOnlyListedKeys" "nostar APIKeys" }}