Skip to content

Conversation

leemthompo
Copy link
Contributor

@leemthompo leemthompo self-assigned this Jun 19, 2025
Copy link

github-actions bot commented Jun 19, 2025

🔍 Preview links for changed docs:

🔔 The preview site may take up to 3 minutes to finish building. These links will become live once it completes.

@leemthompo leemthompo changed the title Clarify usage of proxy_address Clarify usage of proxy_address in remote cluster settings Jun 19, 2025
@leemthompo leemthompo marked this pull request as ready for review June 19, 2025 07:08
@leemthompo leemthompo requested a review from a team as a code owner June 19, 2025 07:08
Copy link
Contributor

@yetanothertw yetanothertw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, Liam and Peter!

@leemthompo leemthompo enabled auto-merge (squash) June 19, 2025 08:13
@leemthompo leemthompo merged commit 77dc2fb into main Jun 19, 2025
6 of 7 checks passed
@leemthompo leemthompo deleted the leemthompo-patch-1 branch June 19, 2025 08:14
@eedugon
Copy link
Contributor

eedugon commented Jun 19, 2025

Very sorry for being late to the party @leemthompo and @geekpete , but I'd like to share my thoughts here, as I think further clarification would be more than welcome (I still feel this a bit vague and I have used it a lot in the past).

  • For the first setting (proxy_address) we have:

The address used for all remote connections. A single address value, either an IP address or a fully qualified domain name (FQDN).

The first part feels a bit vague (what is all remote connections?). IMO ideally we should describe with something like:

The address used to reach the remote cluster. A single address value, either an IP address or a fully qualified domain name (FQDN). The port can be provided also. This endpoint typically represents a load balancer or reverse proxy that forwards the traffic to the transport endpoint of the destination {{es}} nodes. For example my-remote-cluster.mydomain.com:9400

  • For the second setting (proxy_socket_connections), we say:

The number of socket connections to open per remote cluster

That per is wrong, because the setting itself is for a specific remote cluster, and not for others. We should say:

The number of socket connections to open towards the remote cluster

Of course it's configured per remote cluster, but that's kind of obvious and not the meaning of the setting. The setting is for this remote cluster that is being configured.

WDYT? The current descriptions create the wrong feeling that they are for multiple remotes, while the settings are for a single remote cluster configuration that will be connected through a single destination address and multiple sockets / connections.

@leemthompo
Copy link
Contributor Author

Sounds good @eedugon I'll let you follow up, apologies, I should have left this open for the rest of the Admin docs team to have a look

@eedugon
Copy link
Contributor

eedugon commented Jun 19, 2025

@leemthompo : Don't worry at all! I just found this by chance... but it's an area that confuses a lot to customers and engineers, and I don't think we have explained it well and clear enough (not these two settings, the entire remote clusters stuff).

So, the more love we can give on these little changes the better :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants