Skip to content

Commit bf5b63e

Browse files
committed
[D&M] Deployments maintenance and request routing.
1 parent 3dd4b47 commit bf5b63e

File tree

4 files changed

+25
-40
lines changed

4 files changed

+25
-40
lines changed

deploy-manage/maintenance/ece/deployments-maintenance.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,9 @@ mapped_pages:
77

88
In some circumstances, you might need to temporarily restrict access to a node so you can perform corrective actions that might otherwise be difficult to complete. For example, if your cluster is being overwhelmed by requests because it is undersized for its workload, its nodes might not respond to efforts to resize.
99

10-
These actions act as a maintenance mode for cluster node. Performing these actions can stop the cluster from becoming completely unresponsive so that you can resolve operational issues much more effectively.
10+
These actions act as a maintenance mode for cluster node. Performing these actions can stop the cluster from becoming unresponsive so that you can resolve operational issues much more effectively.
1111

1212
* [**Stop routing to the instance**](start-stop-routing-requests.md): Block requests from being routed to the cluster node. This is a less invasive action than pausing the cluster.
1313
* [**Pause an instance**](pause-instance.md): Suspend the node immediately by stopping the container that the node runs on without completing existing requests. This is a more aggressive action to regain control of an unresponsive node.
1414

1515
As an alternative, to quickly add capacity to a deployment if it is unhealthy or at capacity, you can also [override the resource limit for a deployment](../../deploy/cloud-enterprise/resource-overrides.md).
16-
17-
18-

deploy-manage/maintenance/ece/start-stop-routing-requests.md

Lines changed: 24 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,30 @@ mapped_urls:
66

77
# Start and stop routing requests
88

9-
% What needs to be done: Refine
9+
## Request routing [maintenance-mode-routing]
1010

11-
% GitHub issue: https://github.com/elastic/docs-projects/issues/353
11+
The {{ecloud}} proxy service routes traffic from external sources to the deployment, between deployments, and between products within a deployment. For example, it routes API requests from your local machine to your deployment, CCR and CCS requests between your deployments, and communications between {{kib}} and {{es}}. It does not direct the TCP traffic between {{es}} nodes, nor does it manage requests starting within {{es}} outwards to external sources such as to snapshot repositories.
1212

13-
% Use migrated content from existing pages that map to this page:
13+
The {{ecloud}} proxy routes HTTP requests to its deployment’s individual product instances through the product’s endpoint. By default, instances are enabled to route HTTP traffic and will report no special messaging.
1414

15-
% - [ ] ./raw-migrated-files/cloud/cloud-enterprise/ece-maintenance-mode-routing.md
16-
% - [ ] ./raw-migrated-files/cloud/cloud/ec-maintenance-mode-routing.md
15+
It might be helpful to temporarily block upstream requests in order to protect some or all instances or products within your deployment. For example, you might stop request routing in the following cases:
16+
17+
* If another team within your company starts streaming new data into your production {{integrations-server}} without previous load testing, both it and {{es}} might experience performance issues. You might consider stopping routing requests on all {{integrations-server}} instances in order to protect your downstream {{es}} instance.
18+
* If {{es}} is being overwhelmed by upstream requests, it might experience increased response times or even become unresponsive. This might impact your ability to resize components in your deployment and increase the duration of pending plans or increase the chance of plan changes failing. Because every {{es}} node is an [implicit coordinating node](https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-node.html), you should stop routing requests across all {{es}} nodes to completely block upstream traffic.
19+
20+
## Considerations [request-routing-considerations]
21+
22+
* {{ecloud}} will automatically set and remove routing blocks during plan changes. Elastic recommends avoiding manually overriding these settings for a deployment while its plans are pending.
23+
* The [{{es}} API console](../../../explore-analyze/query-filter/tools/console.md) bypasses {{ecloud}} proxy routing blocks against {{es}} to enable administrative tasks while plan changes are pending. You should generally default traffic to the {{es}} endpoint. However, if you enable **Stop routing requests** across all {{es}} nodes, you need to use this UI to administer your cluster.
24+
* While {{es}} has **Stop routing requests** set across all nodes, other products with the deployment may become unhealthy. This is because {{es}} is a prerequisite for those other products, such as {{kib}}. In {{kib}}, this results in a [**Kibana server is not ready yet**](../../../troubleshoot/kibana/error-server-not-ready.md#not-ready) message.
25+
* Enabling **Stop routing requests** does not affect your [billing](../../deploy-manage/cloud-organization/billing.md). If needed, you can stop charges for a deployment by [deleting the deployment](../../deploy-manage/uninstall/delete-a-cloud-deployment.md).
26+
27+
## Stop routing requests [stop-routing-requests]
28+
29+
To block HTTP requests for an instance, select **Stop routing requests** under from instance’s menu.
30+
31+
The instance will then report **Not routing requests**. It will complete existing requested traffic, but not be sent new requests.
32+
33+
## Restart routing requests [restart-routing-requests]
34+
35+
To unblock HTTP requests for an instance, select **Start routing requests** under from instance’s menu.

raw-migrated-files/cloud/cloud-enterprise/ece-maintenance-mode-routing.md

Lines changed: 0 additions & 30 deletions
This file was deleted.

raw-migrated-files/toc.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,6 @@ toc:
6868
- file: cloud/cloud-enterprise/ece-ingest-guides.md
6969
- file: cloud/cloud-enterprise/ece-install-offline.md
7070
- file: cloud/cloud-enterprise/ece-integrations-server-api-example.md
71-
- file: cloud/cloud-enterprise/ece-maintenance-mode-routing.md
7271
- file: cloud/cloud-enterprise/ece-manage-apm-settings.md
7372
- file: cloud/cloud-enterprise/ece-manage-enterprise-search-settings.md
7473
- file: cloud/cloud-enterprise/ece-manage-integrations-server.md

0 commit comments

Comments
 (0)