Skip to content

Commit 152791b

Browse files
Prod guidance content refined (#802)
Should close elastic/docs-projects#341 Preview: all content and sub-docs from - [Production guidance](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/802/deploy-manage/production-guidance) Pending items: > Refine Kibana task manager scaling considerations to cover only deployment considerations, link up to the functionality overview in Distributed architecture I haven't done that, but it should be pretty quick and easy if we want to do it at a later stage. This PR requires PR #799 to be merged first, in order to have this link available `/deploy-manage/deploy/kibana-reporting-configuration.md#install-reporting-packages`. --------- Co-authored-by: shainaraskas <[email protected]>
1 parent 3581831 commit 152791b

36 files changed

+730
-399
lines changed
Lines changed: 27 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,74 +1,60 @@
11
---
2+
navigation_title: High availability
23
applies_to:
34
deployment:
45
ece: all
56
mapped_pages:
67
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-ha.html
78
---
89

9-
# High availability [ece-ha]
10+
# High availability in ECE
1011

11-
Ensuring high availability in {{ece}} (ECE) requires careful planning and implementation across multiple areas, including availability zones, master nodes, replica shards, snapshot backups, and Zookeeper nodes.
12+
Ensuring high availability (HA) in {{ece}} (ECE) requires careful planning and implementation across multiple areas, including availability zones, master nodes, replica shards, snapshot backups, and Zookeeper nodes.
1213

13-
This section describes key considerations and best practices to prevent downtime and data loss at both the ECE platform level and within orchestrated deployments.
14-
15-
## Availability zones [ece-ece-ha-1-az]
16-
17-
Fault tolerance for ECE is based around the concept of *availability zones*.
18-
19-
An availability zone contains resources available to an ECE installation that are isolated from other availability zones to safeguard against potential failure.
20-
21-
Planning for a fault-tolerant installation with multiple availability zones means avoiding any single point of failure that could bring down ECE.
22-
23-
The main difference between ECE installations that include two or three availability zones is that three availability zones enable ECE to create clusters with a *tiebreaker*. If you have only two availability zones in total in your installation, no tiebreaker is created.
14+
::::{note}
15+
This section focuses on ensuring high availability at the ECE platform level. For deployment-level considerations, including resiliency, scaling, and performance optimizations for running {{es}} and {{kib}}, refer to the general [production guidance](/deploy-manage/production-guidance.md).
16+
::::
2417

25-
We recommend that for each deployment you use at least two availability zones for production and three for mission-critical systems. Using more than three availability zones for a deployment is not required nor supported. Availability zones are intended for high availability, not scalability.
18+
To maintain a minimum HA, you should deploy at least two ECE hosts for each role—**allocator, constructor, and proxy**—and at least three hosts for the **director** role, which runs ZooKeeper and requires quorum to operate reliably.
2619

27-
::::{warning}
28-
{{es}} clusters that are set up to use only one availability zone are not [highly available](/deploy-manage/production-guidance/availability-and-resilience.md) and are at risk of data loss. To safeguard against data loss, you must use at least two {{ece}} availability zones.
29-
::::
20+
In addition, to improve resiliency at the availability zone level, it’s recommended to deploy ECE across three availability zones, with at least two allocators per zone and spare capacity to accommodate instance failover and workload redistribution in case of failures.
3021

31-
::::{warning}
32-
Increasing the number of zones should not be used to add more resources. The concept of zones is meant for High Availability (2 zones) and Fault Tolerance (3 zones), but neither will work if the cluster relies on the resources from those zones to be operational. The recommendation is to scale up the resources within a single zone until the cluster can take the full load (add some buffer to be prepared for a peak of requests), then scale out by adding additional zones depending on your requirements: 2 zones for High Availability, 3 zones for Fault Tolerance.
33-
::::
22+
All Elastic-documented architectures recommend using three availability zones with ECE roles distributed across all zones. Refer to [deployment scenarios](./identify-deployment-scenario.md) for examples of small, medium, and large installations.
3423

24+
Regardless of the resiliency level at the platform level, it’s important to also [configure your deployments for high availability](/deploy-manage/production-guidance/availability-and-resilience/resilience-in-ech.md).
3525

36-
## Master nodes [ece-ece-ha-2-master-nodes]
26+
## Availability zones [ece-ece-ha-1-az]
3727

38-
Tiebreakers are used in distributed clusters to avoid cases of [split brain](https://en.wikipedia.org/wiki/Split-brain_(computing)), where an {{es}} cluster splits into multiple, autonomous parts that continue to handle requests independently of each other, at the risk of affecting cluster consistency and data loss. A split-brain scenario is avoided by making sure that a minimum number of [master-eligible nodes](elasticsearch://reference/elasticsearch/configuration-reference/node-settings.md#master-node) must be present in order for any part of the cluster to elect a master node and accept user requests. To prevent multiple parts of a cluster from being eligible, there must be a [quorum-based majority](/deploy-manage/distributed-architecture/discovery-cluster-formation/modules-discovery-quorums.md) of `(n/2)+1` nodes, where `n` is the number of master-eligible nodes in the cluster. The minimum number of master nodes to reach quorum in a two-node cluster is the same as for a three-node cluster: two nodes must be available.
28+
Fault tolerance for ECE is based around the concept of *availability zones*.
3929

40-
When you create a cluster with nodes in two availability zones when a third zone is available, ECE can create a tiebreaker in the third availability zone to help establish quorum in case of loss of an availability zone. The extra tiebreaker node that helps to provide quorum does not have to be a full-fledged and expensive node, as it does not hold data. For example: By tagging allocators hosts in ECE, can you create a cluster with eight nodes each in zones `ece-1a` and `ece-1b`, for a total of 16 nodes, and one tiebreaker node in zone `ece-1c`. This cluster can lose any of the three availability zones whilst maintaining quorum, which means that the cluster can continue to process user requests, provided that there is sufficient capacity available when an availability zone goes down.
30+
An availability zone contains resources available to an ECE installation that are isolated from other availability zones to safeguard against potential failure.
4131

42-
By default, each node in an {{es}} cluster is a master-eligible node and a data node. In larger clusters, such as production clusters, it’s a good practice to split the roles, so that master nodes are not handling search or indexing work. When you create a cluster, you can specify to use dedicated [master-eligible nodes](elasticsearch://reference/elasticsearch/configuration-reference/node-settings.md#master-node), one per availability zone.
32+
Planning for a fault-tolerant installation with multiple availability zones means avoiding any single point of failure that could bring down ECE.
4333

44-
::::{warning}
45-
Clusters that only have two or fewer master-eligible node are not [highly available](/deploy-manage/production-guidance/availability-and-resilience.md) and are at risk of data loss. You must have [at least three master-eligible nodes](/deploy-manage/distributed-architecture/discovery-cluster-formation/modules-discovery-quorums.md).
34+
::::{important}
35+
Adding more availability zones should not be used as a way to increase processing capacity and performance. The concept of zones is meant for high availability (2 zones) and fault tolerance (3 zones), but neither will work if your deployments rely on the resources from those zones to be operational. Refer to [scaling considerations](/deploy-manage/production-guidance/scaling-considerations.md#scaling-and-fault-tolerance) for more information.
4636
::::
4737

48-
## Replica shards [ece-ece-ha-3-replica-shards]
38+
The main difference between ECE installations that include two or three availability zones is that three availability zones enable ECE to create {{es}} clusters with a [voting-only tiebreaker](/deploy-manage/distributed-architecture/clusters-nodes-shards/node-roles.md#voting-only-node) instance. If you have only two availability zones in your installation, no tiebreaker can be placed in a third zone, limiting the cluster’s ability to tolerate certain failures.
4939

50-
With multiple {{es}} nodes in multiple availability zones you have the recommended hardware, the next thing to consider is having the recommended index replication. Each index, with the exception of searchable snapshot indexes, should have one or more replicas. Use the index settings API to find any indices with no replica:
40+
## Tiebreaker master nodes
5141

52-
```sh
53-
GET _all/_settings/index.number_of_replicas
54-
```
42+
A tiebreaker is a lightweight voting-only node used in distributed clusters to help avoid split-brain scenarios, where the cluster could incorrectly split into multiple autonomous parts during a network partition.
5543

56-
::::{warning}
57-
Indices with no replica, except for [searchable snapshot indices](/deploy-manage/tools/snapshot-and-restore/searchable-snapshots.md), are not highly available. You should use replicas to mitigate against possible data loss.
58-
::::
44+
When you create a cluster with nodes in two availability zones when a third zone is available, ECE can create a tiebreaker in the third availability zone to help establish quorum in case of loss of an availability zone. The extra tiebreaker node that helps to provide quorum does not have to be a full-fledged and expensive node, as it does not hold data. For example: By [tagging allocators](./ece-configuring-ece-tag-allocators.md) hosts in ECE, can you create a cluster with eight nodes each in zones `ece-1a` and `ece-1b`, for a total of 16 nodes, and one tiebreaker node in zone `ece-1c`. This cluster can lose any of the three availability zones whilst maintaining quorum, which means that the cluster can continue to process user requests, provided that there is sufficient capacity available when an availability zone goes down.
5945

60-
Refer to [](../../reference-architectures.md) for information about {{es}} architectures.
46+
## Zookeeper nodes
6147

62-
## Snapshot backups [ece-ece-ha-4-snapshot]
48+
Make sure you have three Zookeepers—by default, on the Director host—for your ECE installation. Similar to three {{es}} master nodes can form a quorum, three Zookeepers can form the quorum for high availability purposes.
6349

64-
You should configure and use [{{es}} snapshots](/deploy-manage/tools/snapshot-and-restore.md). Snapshots provide a way to backup and restore your {{es}} indices. They can be used to copy indices for testing, to recover from failures or accidental deletions, or to migrate data to other deployments. We recommend configuring an [{{ece}}-level repository](../../tools/snapshot-and-restore/cloud-enterprise.md) to apply across all deployments. See [Work with snapshots](../../tools/snapshot-and-restore.md) for more guidance.
50+
Backing up Zookeeper data directory is also recommended. Refer to [rebuilding a broken Zookeeper quorum](../../../troubleshoot/deployments/cloud-enterprise/rebuilding-broken-zookeeper-quorum.md) for more guidance.
6551

66-
## Further considerations [ece-ece-ha-5-other]
52+
## External resources accessibility
6753

68-
* Make sure you have three Zookeepers - by default, on the Director host - for your ECE installation. Similar to three Elasticsearch master nodes can form a quorum, three Zookeepers can forum the quorum for high availability purposes. Backing up the Zookeeper data directory is also recommended: refer to [](/troubleshoot/deployments/cloud-enterprise/rebuilding-broken-zookeeper-quorum.md) for more guidance.
54+
If you’re using a [private Docker registry server](ece-install-offline-with-registry.md) or hosting any [custom bundles and plugins](../../../solutions/search/full-text/search-with-synonyms.md) on a web server, make sure these resources are accessible from all ECE allocators, so they can continue to be accessed in the event of a network partition or zone outage.
6955

70-
* Make sure that if you’re using a [private Docker registry server](ece-install-offline-with-registry.md) or are using any [custom bundles and plugins](../../../solutions/search/full-text/search-with-synonyms.md) hosted on a web server, that these are available to all ECE allocators, so that they can continue to be accessed in the event of a network partition or zone outage.
56+
## Other recommendations
7157

72-
* Don’t delete containers unless guided by Elastic Support or there’s public documentation explicitly describing this as required action. Otherwise, it can cause issues and you may lose access or functionality of your {{ece}} platform. See [](/troubleshoot/deployments/cloud-enterprise/troubleshooting-container-engines.md) for more information.
58+
Avoid deleting containers unless explicitly instructed by Elastic Support or official documentation. Doing so may lead to unexpected issues or loss of access to your {{ece}} platform. For more details, refer to [](/troubleshoot/deployments/cloud-enterprise/troubleshooting-container-engines.md).
7359

7460
If in doubt, please [contact support for help](/troubleshoot/index.md#contact-us).

deploy-manage/deploy/elastic-cloud/cloud-hosted.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ Of course, you can choose to follow your own path and use Elastic components ava
106106

107107
**Adjust the capacity and capabilities of your deployments for production**
108108

109-
There are a few things that can help you make sure that your production deployments remain available, healthy, and ready to handle your data in a scalable way over time, with the expected level of performance. Check [](/deploy-manage/production-guidance/plan-for-production-elastic-cloud.md).
109+
There are a few things that can help you make sure that your production deployments remain available, healthy, and ready to handle your data in a scalable way over time, with the expected level of performance. Check [](/deploy-manage/production-guidance.md).
110110

111111
**Secure your environment**
112112

deploy-manage/deploy/elastic-cloud/create-an-elastic-cloud-hosted-deployment.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ You can also create a deployment using the [Elastic Cloud API](https://www.elast
6565

6666
To make sure you’re all set for production, consider the following actions:
6767

68-
* [Plan for your expected workloads](/deploy-manage/production-guidance/plan-for-production-elastic-cloud.md) and consider how many availability zones you’ll need.
68+
* [Plan for your expected workloads](/deploy-manage/production-guidance.md) and consider how many availability zones you’ll need.
6969
* [Create a deployment](/deploy-manage/deploy/elastic-cloud/create-an-elastic-cloud-hosted-deployment.md) on the region you need and with a hardware profile that matches your use case.
7070
* [Change your configuration](/deploy-manage/deploy/elastic-cloud/ec-customize-deployment-components.md) by turning on autoscaling, adding high availability, or adjusting components of the Elastic Stack.
7171
* [Add extensions and plugins](/deploy-manage/deploy/elastic-cloud/add-plugins-extensions.md) to use Elastic supported extensions or add your own custom dictionaries and scripts.

deploy-manage/production-guidance.md

Lines changed: 28 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,44 @@
11
---
22
mapped_pages:
33
- https://www.elastic.co/guide/en/cloud/current/ec-best-practices-data.html
4-
- https://www.elastic.co/guide/en/elasticsearch/reference/current/scalability.html
4+
applies_to:
5+
deployment:
6+
ess: all
7+
ece: all
8+
eck: all
9+
self: all
510
---
611

7-
# Production guidance [ec-best-practices-data]
12+
% scope: the scope of this page is just a brief introduction to prod guidance at elastic stack level, links to ES and KIB,
13+
# Production guidance
814

9-
This section provides some best practices for managing your data to help you set up a production environment that matches your workloads, policies, and deployment needs.
15+
Running the {{stack}} in production requires careful planning to ensure resilience, performance, and scalability. This section outlines best practices and recommendations for optimizing {{es}} and {{kib}} in production environments.
1016

17+
You’ll learn how to design highly available and resilient deployments, implement best practices for managing workloads, and apply performance optimizations to handle scaling demands efficiently.
1118

12-
## Plan your data structure, availability, and formatting [ec_plan_your_data_structure_availability_and_formatting]
19+
For {{es}}, this includes strategies for fault tolerance, data replication, and workload distribution to maintain stability under load. For {{kib}}, you’ll explore how to deploy multiple Kibana instances within the same environment and make informed decisions about scaling horizontally or vertically based on the task manager metrics, which provide insights into background task execution and resource consumption.
1320

14-
* Build a [data architecture](/manage-data/lifecycle/data-tiers.md) that best fits your needs. Your {{ech}} deployment comes with default hot tier {{es}} nodes that store your most frequently accessed data. Based on your own access and retention policies, you can add warm, cold, frozen data tiers, and automated deletion of old data.
15-
* Make your data [highly available](/deploy-manage/tools.md) for production environments or otherwise critical data stores, and take regular [backup snapshots](tools/snapshot-and-restore.md).
16-
* Normalize event data to better analyze, visualize, and correlate your events by adopting the [Elastic Common Schema](ecs://reference/ecs-getting-started.md) (ECS). Elastic integrations use ECS out-of-the-box. If you are writing your own integrations, ECS is recommended.
21+
By following this guidance, you can ensure your {{stack}} deployment is robust, efficient, and prepared for production-scale workloads.
1722

23+
For detailed, component-specific guidance, refer to:
24+
* [](./production-guidance/elasticsearch-in-production-environments.md)
25+
* [](./production-guidance/kibana-in-production-environments.md)
1826

19-
## Optimize data storage and retention [ec_optimize_data_storage_and_retention]
27+
## Deployment types
2028

21-
Once you have your data tiers deployed and you have data flowing, you can [manage the index lifecycle](/manage-data/lifecycle/index-lifecycle-management.md).
29+
Production guidelines and concepts described in this section apply to all [deployment types](/deploy-manage/deploy.md#choosing-your-deployment-type)—including {{ech}}, {{ece}}, {{eck}}, and self-managed clusters—**except** {{serverless-full}}.
2230

23-
::::{tip}
24-
[Elastic integrations](https://www.elastic.co/integrations) provide default index lifecycle policies, and you can [build your own policies for your custom integrations](/manage-data/lifecycle/index-lifecycle-management/tutorial-automate-rollover.md).
31+
However, certain parts may be relevant only to self-managed clusters, as orchestration systems automate some of the configurations discussed here. Check the [badges](/get-started/versioning-availability.md#availability-of-features) on each document or section to confirm whether the content applies to your deployment type.
32+
33+
::::{note}
34+
**{{serverless-full}}** projects are fully managed and automatically scaled by Elastic. Your project’s performance and general data retention are controlled by the [Search AI Lake settings](/deploy-manage/deploy/elastic-cloud/project-settings.md#elasticsearch-manage-project-search-ai-lake-settings).
2535
::::
2636

37+
## Other Elastic products
38+
39+
If you are looking for production guidance for Elastic products other than {{es}} or {{kib}}, check out the following resources:
2740

41+
* [High availability on ECE orchestrator](/deploy-manage/deploy/cloud-enterprise/ece-ha.md)
42+
* [APM scalability and performance](/troubleshoot/observability/apm/processing-performance.md)
43+
* [Fleet server scalability](/reference/fleet/fleet-server-scalability.md)
44+
* [Deploying and scaling Logstash](logstash://reference/deploying-scaling-logstash.md)

0 commit comments

Comments
 (0)