From 3e5e1bcc6055c09390996793577d53f296868906 Mon Sep 17 00:00:00 2001 From: Robert Fratto Date: Wed, 22 May 2024 15:24:22 -0400 Subject: [PATCH] docs: clarify DNS lookup in clustering documentation `--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. --- docs/sources/reference/cli/run.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sources/reference/cli/run.md b/docs/sources/reference/cli/run.md index 9b004768d9..57b5df86a8 100644 --- a/docs/sources/reference/cli/run.md +++ b/docs/sources/reference/cli/run.md @@ -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.