You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@iggy.apache.org by gk...@apache.org on 2026/08/26 13:24:47 UTC
(iggy) branch multi_endpoint_failover updated: update stale docs
This is an automated email from the ASF dual-hosted git repository.
numinnex pushed a commit to branch multi_endpoint_failover
in repository https://gitbox.apache.org/repos/asf/iggy.git
The following commit(s) were added to refs/heads/multi_endpoint_failover by this push:
new 08f5c6184 update stale docs
08f5c6184 is described below
commit 08f5c618471792af1f0d340533136d9cec638eb7
Author: Grzegorz Koszyk <g....@gmail.com>
AuthorDate: Wed Aug 26 15:24:40 2026 +0200
update stale docs
---
.../src/types/configuration/tcp_config/tcp_client_config.rs | 12 +++++++-----
.../configuration/tcp_config/tcp_client_config_builder.rs | 4 ++--
core/sdk/src/clients/client_builder.rs | 4 ++--
foreign/python/apache_iggy.pyi | 8 ++++----
foreign/python/src/config.rs | 8 ++++----
5 files changed, 19 insertions(+), 17 deletions(-)
diff --git a/core/common/src/types/configuration/tcp_config/tcp_client_config.rs b/core/common/src/types/configuration/tcp_config/tcp_client_config.rs
index 288337af6..f252987e0 100644
--- a/core/common/src/types/configuration/tcp_config/tcp_client_config.rs
+++ b/core/common/src/types/configuration/tcp_config/tcp_client_config.rs
@@ -26,11 +26,13 @@ use std::str::FromStr;
pub struct TcpClientConfig {
/// The address of the Iggy server.
pub server_address: String,
- /// Addresses of other nodes of the same cluster, dialed in order when
- /// `server_address` cannot be reached. The roster the server reports is
- /// remembered while the client is connected and dialed first, so these
- /// seeds only have to be enough to reach the cluster once -- at the very
- /// first connect, when nothing has been learned yet.
+ /// Addresses of other nodes of the same cluster, dialed when
+ /// `server_address` cannot be reached.
+ ///
+ /// Needed only until the client learns the cluster roster, which it reads on
+ /// its first leader check and dials ahead of these. A client that has never
+ /// connected -- a fresh process included -- has no roster yet, so these are
+ /// the only other addresses it can try.
pub failover_addresses: Vec<String>,
/// Whether to use TLS when connecting to the server.
pub tls_enabled: bool,
diff --git a/core/common/src/types/configuration/tcp_config/tcp_client_config_builder.rs b/core/common/src/types/configuration/tcp_config/tcp_client_config_builder.rs
index 08e50a9b6..6f078a408 100644
--- a/core/common/src/types/configuration/tcp_config/tcp_client_config_builder.rs
+++ b/core/common/src/types/configuration/tcp_config/tcp_client_config_builder.rs
@@ -45,8 +45,8 @@ impl TcpClientConfigBuilder {
self
}
- /// Sets the addresses of other nodes of the same cluster, dialed in order
- /// when `server_address` cannot be reached.
+ /// Sets the bootstrap addresses of other nodes of the same cluster, dialed
+ /// when `server_address` cannot be reached and no roster has been learned.
pub fn with_failover_addresses(mut self, failover_addresses: Vec<String>) -> Self {
self.config.failover_addresses = failover_addresses;
self
diff --git a/core/sdk/src/clients/client_builder.rs b/core/sdk/src/clients/client_builder.rs
index 5cfa317b4..8a9f8dc5f 100644
--- a/core/sdk/src/clients/client_builder.rs
+++ b/core/sdk/src/clients/client_builder.rs
@@ -160,8 +160,8 @@ impl TcpClientBuilder {
self
}
- /// Sets the addresses of other nodes of the same cluster, dialed in order
- /// when the server address cannot be reached.
+ /// Sets the bootstrap addresses of other nodes of the same cluster, dialed
+ /// when the server address cannot be reached and no roster has been learned.
pub fn with_failover_addresses(mut self, failover_addresses: Vec<String>) -> Self {
self.config = self.config.with_failover_addresses(failover_addresses);
self
diff --git a/foreign/python/apache_iggy.pyi b/foreign/python/apache_iggy.pyi
index cf3d847ce..737b1b3dd 100644
--- a/foreign/python/apache_iggy.pyi
+++ b/foreign/python/apache_iggy.pyi
@@ -1970,10 +1970,10 @@ class TcpConfig:
Args:
server_address: `host:port` of the Iggy server. Defaults to `127.0.0.1:8090`.
failover_addresses: `host:port` of other nodes of the same cluster, dialed
- in order when `server_address` cannot be reached. The roster the server
- reports is remembered while the client is connected and dialed first,
- so these seeds only have to be enough to reach the cluster once.
- Defaults to none.
+ when `server_address` cannot be reached. Needed only until the client
+ learns the cluster roster, which it reads on its first leader check
+ and dials ahead of these; a client that has never connected, a fresh
+ process included, has no roster yet. Defaults to none.
auto_login: Credentials replayed on every connect. Defaults to `AutoLogin.disabled()`.
reconnection: Reconnection policy. Defaults to `TcpReconnectionConfig()`.
heartbeat_interval: Interval of heartbeats sent by the client. Defaults to 5 seconds.
diff --git a/foreign/python/src/config.rs b/foreign/python/src/config.rs
index a132f2878..d687b3cd9 100644
--- a/foreign/python/src/config.rs
+++ b/foreign/python/src/config.rs
@@ -245,10 +245,10 @@ impl TcpConfig {
/// Args:
/// server_address: `host:port` of the Iggy server. Defaults to `127.0.0.1:8090`.
/// failover_addresses: `host:port` of other nodes of the same cluster, dialed
- /// in order when `server_address` cannot be reached. The roster the server
- /// reports is remembered while the client is connected and dialed first,
- /// so these seeds only have to be enough to reach the cluster once.
- /// Defaults to none.
+ /// when `server_address` cannot be reached. Needed only until the client
+ /// learns the cluster roster, which it reads on its first leader check
+ /// and dials ahead of these; a client that has never connected, a fresh
+ /// process included, has no roster yet. Defaults to none.
/// auto_login: Credentials replayed on every connect. Defaults to `AutoLogin.disabled()`.
/// reconnection: Reconnection policy. Defaults to `TcpReconnectionConfig()`.
/// heartbeat_interval: Interval of heartbeats sent by the client. Defaults to 5 seconds.