From 87df295817c95c09e0df27fa4da32346b83850b7 Mon Sep 17 00:00:00 2001 From: Dianna Hohensee Date: Wed, 8 May 2024 13:34:56 -0400 Subject: [PATCH] Brief document blurb about RestClient (#107863) --- docs/internal/DistributedArchitectureGuide.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/internal/DistributedArchitectureGuide.md b/docs/internal/DistributedArchitectureGuide.md index b8fb92b1ea15d..7f10a1b3a8cae 100644 --- a/docs/internal/DistributedArchitectureGuide.md +++ b/docs/internal/DistributedArchitectureGuide.md @@ -133,6 +133,14 @@ are only used for internode operations/communications. ### Work Queues +### RestClient + +The `RestClient` is primarily used in testing, to send requests against cluster nodes in the same format as would users. There +are some uses of `RestClient`, via `RestClientBuilder`, in the production code. For example, remote reindex leverages the +`RestClient` internally as the REST client to the remote elasticsearch cluster, and to take advantage of the compatibility of +`RestClient` requests with much older elasticsearch versions. The `RestClient` is also used externally by the `Java API Client` +to communicate with Elasticsearch. + # Cluster Coordination (Sketch of important classes? Might inform more sections to add for details.)