Skip to content

Commit 24410d1

Browse files
Merge pull request #2793 from ClickHouse/krithika-ch-patch-4
Update and rename sticky-endpoints.md to replica-aware-routing.md
2 parents 8b218c8 + 1e1b952 commit 24410d1

File tree

2 files changed

+13
-13
lines changed

2 files changed

+13
-13
lines changed
Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
---
2-
title: Sticky Endpoints
3-
slug: /en/manage/sticky-endpoints
4-
description: How to use Sticky Endpoints to increase cache re-use
5-
keywords: [cloud, sticky endpoints, sticky, endpoints, sticky routing, routing]
2+
title: Replica-aware Routing
3+
slug: /en/manage/replica-aware-routing
4+
description: How to use Replica-aware routing to increase cache re-use
5+
keywords: [cloud, sticky endpoints, sticky, endpoints, sticky routing, routing, replica aware routing]
66
---
77

8-
# Sticky Endpoints (Private Preview)
8+
# Replica-aware routing (Private Preview)
99

10-
Sticky endpoints (sticky routing) utilizes [Envoy proxy’s ring hash load balancing](https://www.envoyproxy.io/docs/envoy/latest/intro/arch_overview/upstream/load_balancing/load_balancers#ring-hash). The main purpose of sticky endpoints is to increase the chance of cache reuse. It does not guarantee isolation.
10+
Replica-aware routing (also known as sticky sessions, sticky routing, or session affinity) utilizes [Envoy proxy’s ring hash load balancing](https://www.envoyproxy.io/docs/envoy/latest/intro/arch_overview/upstream/load_balancing/load_balancers#ring-hash). The main purpose of replica-aware routing is to increase the chance of cache reuse. It does not guarantee isolation.
1111

12-
When enabling sticky endpoints for a service, we allow a wildcard subdomain on top of the service hostname. For a service with the host name `abcxyz123.us-west-2.aws.clickhouse.cloud`, you can use any hostname which matches `*.sticky.abcxyz123.us-west-2.aws.clickhouse.cloud` to visit the service:
12+
When enabling replica-aware routing for a service, we allow a wildcard subdomain on top of the service hostname. For a service with the host name `abcxyz123.us-west-2.aws.clickhouse.cloud`, you can use any hostname which matches `*.sticky.abcxyz123.us-west-2.aws.clickhouse.cloud` to visit the service:
1313

1414
|Example hostnames|
1515
|---|
@@ -21,16 +21,16 @@ When Envoy receives a hostname that matches such a pattern, it will compute the
2121

2222
Note the original hostname will still use `LEAST_CONNECTION` load balancing, which is the default routing algorithm.
2323

24-
## Limitations of Sticky Endpoints
24+
## Limitations of Replica-aware routing
2525

26-
### Sticky endpoints do not guarantee isolation
26+
### Replica-aware routing does not guarantee isolation
2727

2828
Any disruption to the service, e.g. server pod restarts (due to any reason like a version upgrade, crash, vertical scaling up, etc.), server scaled out / in, will cause a disruption to the routing hash ring. This will cause connections with the same hostname to land on a different server pod.
2929

30-
### Sticky endpoints do not work out of the box with private link
30+
### Replica-aware routing does not work out of the box with private link
3131

3232
Customers need to manually add a DNS entry to make name resolution work for the new hostname pattern. It is possible that this can cause imbalance in the server load if customers use it incorrectly.
3333

34-
## Configuring Sticky Endpoints
34+
## Configuring Replica-aware Routing
3535

36-
To enable sticky endpoints, please contact [our support team](https://clickhouse.com/support).
36+
To enable Replica-aware routing, please contact [our support team](https://clickhouse.com/support).

sidebars.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -233,7 +233,7 @@ const sidebars = {
233233
],
234234
},
235235
"en/cloud/manage/settings",
236-
"en/cloud/manage/sticky-endpoints",
236+
"en/cloud/manage/replica-aware-routing",
237237
"en/cloud/manage/scaling",
238238
"en/cloud/manage/service-uptime",
239239
"en/cloud/manage/notifications",

0 commit comments

Comments
 (0)