Skip to content

reverse_tunnel: add skip_rebalancing config #44835

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
aakugan wants to merge 2 commits into
base: main
Choose a base branch
from
Open

reverse_tunnel: add skip_rebalancing config #44835

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
065030f
reverse_tunnel: add skip_rebalancing config
aakugan May 4, 2026
43c0441
Merge branch 'main' into rem-lck
aakugan May 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion api/envoy/extensions/filters/network/reverse_tunnel/v3/reverse_tunnel.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ message Validation {
// Configuration for the reverse tunnel network filter.
// This filter handles reverse tunnel connection acceptance and rejection by processing
// HTTP requests where required identification values are provided via HTTP headers.
// [#next-free-field: 8]
// [#next-free-field: 9]
message ReverseTunnel {
// Ping interval for health checks on established reverse tunnel connections.
// If not specified, defaults to ``2 seconds``.
Expand Down Expand Up @@ -140,4 +140,9 @@ message ReverseTunnel {
// flag to the same value.
// Defaults to ``false``.
bool use_http_upgrade = 7;

// When true, skip worker-thread rebalancing for accepted reverse tunnel connections.
// This avoids the cross-worker lock in pickLeastLoadedSocketManager.
// Default: false (rebalancing enabled).
bool skip_rebalancing = 8;
Copy link
Copy Markdown
Member

@tyxia tyxia May 22, 2026

Choose a reason for hiding this comment

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

Will this skip_rebalancing ever be default true? Does not seem to be, but just check. If it will be default to true we should use BoolValue

}
8 changes: 4 additions & 4 deletions source/extensions/filters/network/reverse_tunnel/reverse_tunnel_filter.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,8 +142,7 @@ ReverseTunnelFilterConfig::ReverseTunnelFilterConfig(
? std::chrono::milliseconds(
DurationUtil::durationToMilliseconds(proto_config.ping_interval()))
: std::chrono::milliseconds(2000)),
auto_close_connections_(
proto_config.auto_close_connections() ? proto_config.auto_close_connections() : false),
auto_close_connections_(proto_config.auto_close_connections()),
request_path_(
proto_config.request_path().empty()
? std::string(::Envoy::Extensions::Bootstrap::ReverseConnection::
Expand All @@ -167,7 +166,8 @@ ReverseTunnelFilterConfig::ReverseTunnelFilterConfig(
? proto_config.validation().dynamic_metadata_namespace()
: "envoy.filters.network.reverse_tunnel"),
required_cluster_name_(proto_config.required_cluster_name()),
use_http_upgrade_(proto_config.use_http_upgrade()) {}
use_http_upgrade_(proto_config.use_http_upgrade()),
skip_rebalancing_(proto_config.skip_rebalancing()) {}

bool ReverseTunnelFilterConfig::validateIdentifiers(
absl::string_view node_id, absl::string_view cluster_id, absl::string_view tenant_id,
Expand Down Expand Up @@ -587,7 +587,7 @@ void ReverseTunnelFilter::processAcceptedConnection(absl::string_view node_id,
ENVOY_CONN_LOG(trace, "reverse_tunnel: registering wrapped socket for reuse", connection);
socket_manager->addConnectionSocket(std::string(node_id), std::string(cluster_id),
std::move(wrapped_socket), ping_seconds,
false /* rebalanced */, tenant_id);
/* rebalanced= */ config_->skipRebalancing(), tenant_id);
ENVOY_CONN_LOG(debug, "reverse_tunnel: successfully registered wrapped socket for reuse",
connection);

Expand Down
5 changes: 5 additions & 0 deletions source/extensions/filters/network/reverse_tunnel/reverse_tunnel_filter.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,9 @@ class ReverseTunnelFilterConfig : public Logger::Loggable<Logger::Id::filter> {
// Returns whether the handshake is negotiated as an HTTP/1.1 Upgrade exchange.
bool useHttpUpgrade() const { return use_http_upgrade_; }

// Returns whether worker-thread rebalancing should be skipped for accepted connections.
bool skipRebalancing() const { return skip_rebalancing_; }

private:
ReverseTunnelFilterConfig(
const envoy::extensions::filters::network::reverse_tunnel::v3::ReverseTunnel& proto_config,
Expand All @@ -89,6 +92,8 @@ class ReverseTunnelFilterConfig : public Logger::Loggable<Logger::Id::filter> {

// When true, expect `Connection: Upgrade` + `Upgrade: reverse-tunnel` and respond `101`.
const bool use_http_upgrade_{false};

const bool skip_rebalancing_{false};
};

using ReverseTunnelFilterConfigSharedPtr = std::shared_ptr<ReverseTunnelFilterConfig>;
Expand Down
19 changes: 19 additions & 0 deletions test/extensions/filters/network/reverse_tunnel/config_test.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -358,6 +358,25 @@ request_method: GET
EXPECT_THAT(result.status().message(), testing::HasSubstr("Failed to parse tenant_id_format"));
}

// Tests that the ReverseTunnelFilterConfig is formed properly and the filter construction works.
TEST(ReverseTunnelFilterConfigFactoryTest, ConfigurationSkipRebalancingEnabled) {
envoy::extensions::filters::network::reverse_tunnel::v3::ReverseTunnel proto_config;
proto_config.set_skip_rebalancing(true);
proto_config.set_request_path("/request");
proto_config.set_request_method(envoy::config::core::v3::POST);

ReverseTunnelFilterConfigFactory factory;
NiceMock<Server::Configuration::MockFactoryContext> context;
auto result = factory.createFilterFactoryFromProto(proto_config, context);
ASSERT_TRUE(result.ok());
Network::FilterFactoryCb cb = result.value();
EXPECT_TRUE(cb != nullptr);

Network::MockFilterManager filter_manager;
EXPECT_CALL(filter_manager, addReadFilter(_));
cb(filter_manager);
}

} // namespace
} // namespace ReverseTunnel
} // namespace NetworkFilters
Expand Down
10 changes: 10 additions & 0 deletions test/extensions/filters/network/reverse_tunnel/filter_unit_test.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -480,6 +480,7 @@ TEST_F(ReverseTunnelFilterUnitTest, ConfigurationDefaults) {
EXPECT_FALSE(config->autoCloseConnections());
EXPECT_EQ("/reverse_connections/request", config->requestPath());
EXPECT_EQ("GET", config->requestMethod());
EXPECT_FALSE(config->skipRebalancing());
}

// Test RequestDecoder methods not fully covered.
Expand Down Expand Up @@ -2183,6 +2184,15 @@ TEST_F(ReverseTunnelFilterWithUpstreamTest, UpgradeMode_MissingUpgradeRejected)
EXPECT_EQ(1, parse_error->value());
}

TEST_F(ReverseTunnelFilterUnitTest, FilterConfigLoadsSkipRebalancing) {
envoy::extensions::filters::network::reverse_tunnel::v3::ReverseTunnel cfg;
cfg.set_skip_rebalancing(true);

auto config_or_error = ReverseTunnelFilterConfig::create(cfg, factory_context_);
ASSERT_TRUE(config_or_error.ok());
EXPECT_TRUE(config_or_error.value()->skipRebalancing());
}

} // namespace
} // namespace ReverseTunnel
} // namespace NetworkFilters
Expand Down
Loading