Skip to content

Commit

Permalink
docs: clarify DNS lookup in clustering documentation
Browse files Browse the repository at this point in the history
`--cluster.join-addresses` supports being given a list of IPs or addresses. The documentation mentions these are resolved via DNS, but it doesn't mention what type of records are supported.

Based on the [code](https://github.com/grafana/alloy/blob/c3c761b5e52fcfd605a2274c71adc76b020dd315/internal/alloycli/cluster_builder.go#L168-L173), the only type of supported DNS record is SRV.
  • Loading branch information
rfratto authored May 22, 2024
1 parent c3c761b commit 3e5e1bc
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/sources/reference/cli/run.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ If `--cluster.advertise-interfaces` isn't explicitly set, {{< param "PRODUCT_NAM
{{< param "PRODUCT_NAME" >}} will fail to start if it can't determine the advertised address.
Since Windows doesn't use the interface names `eth0` or `en0`, Windows users must explicitly pass at least one valid network interface for `--cluster.advertise-interfaces` or a value for `--cluster.advertise-address`.

The comma-separated list of addresses provided in `--cluster.join-addresses` can either be IP addresses with an optional port, or DNS records to lookup.
The comma-separated list of addresses provided in `--cluster.join-addresses` can either be IP addresses with an optional port, or DNS SRV records to lookup.
The ports on the list of addresses default to the port used for the HTTP listener if not explicitly provided.
We recommend that you align the port numbers on as many nodes as possible to simplify the deployment process.

Expand Down

0 comments on commit 3e5e1bc

Please sign in to comment.