Skip to content

Commit d36d4ec

Browse files
eedugoneedugon
committed
prod guidance backup
1 parent 7d68fd4 commit d36d4ec

File tree

1 file changed

+48
-84
lines changed

1 file changed

+48
-84
lines changed

‎deploy-manage/production-guidance.md‎

Lines changed: 48 additions & 84 deletions
Original file line numberDiff line numberDiff line change
@@ -1,128 +1,92 @@
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+
- https://www.elastic.co/guide/en/cloud/current/ec-planning.html
5+
- https://www.elastic.co/guide/en/cloud-heroku/current/ech-planning.html
6+
applies_to:
7+
deployment:
8+
ess: all
9+
ece: all
10+
eck: all
11+
self: all
512
---
613
$$$ec-best-practices-data$$$
7-
# Production guidance [scalability]
814

915
% start bringing https://www.elastic.co/guide/en/elasticsearch/reference/current/scalability.html here
16+
1017
% try to merge https://www.elastic.co/guide/en/cloud/current/ec-planning.html and https://www.elastic.co/guide/en/cloud/current/ec-best-practices-data.html
1118
% mention all deployment types! what the user needs to be aware for orchestrated deployments.
1219

13-
Many teams rely on {{es}} to run their key services. To keep these services running, you can design your {{es}} deployment to keep {{es}} available, even in case of large-scale outages. To keep it running fast, you also can design your deployment to be responsive to production workloads.
14-
15-
{{es}} is built to be always available and to scale with your needs. It does this using a [distributed architecture](./distributed-architecture.md). By distributing your cluster, you can keep Elastic online and responsive to requests.
16-
17-
In case of failure, {{es}} offers tools for [cross-cluster replication](./tools/cross-cluster-replication.md) and [cluster snapshots](./tools/snapshot-and-restore.md) that can help you fall back or recover quickly. You can also use cross-cluster replication to serve requests based on the geographic location of your users and your resources.
18-
19-
% not very relevant
20-
{{es}} also offers security and monitoring tools to help you keep your cluster highly available.
21-
22-
23-
Recommendations out there:
24-
- Use multiple nodes and shards
25-
26-
## Section overview
20+
# Production guidance
2721

2822
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.
2923

30-
* High availability (HA) and resilience
31-
* Resilience in small clusters
32-
* Resilienve in larger clusters
33-
34-
* Performance optimizations:
35-
* Elasticsearch
36-
* General recomendations
37-
* Tune for indexing speed
38-
* Tune for search speed
39-
* Tune for approximate kNN search
40-
* Tune for disk usage
41-
* Size your shards
42-
* Use {{es}} for time series data
43-
* Kibana
44-
* Kibana task manager scaling considerations
45-
* Kibana alerting
46-
47-
* Scaling
48-
49-
For additional production-critical topics, refer to:
50-
51-
* [](./security.md)
52-
53-
* [](./tools.md)
54-
55-
* [](./monitor.md)
56-
57-
24+
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.
5825

59-
(Regardless if you are running a hosted or a self managed deployment, the content of this section allow you to understand and take key decisions when designing your clusters in the following areas:)
26+
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.
6027

61-
Cluster design tiene:
62-
- design for resilience
63-
- tune for xxx
64-
- tune for xxx
28+
By following this guidance, you can ensure your {{stack}} deployment is robust, efficient, and prepared for production-scale workloads.
6529

30+
::::{note}
31+
* In the context of {{es}} deployments, an `availability zone`, or simply `zone`, represents an isolated failure domain within your infrastructure. Depending on the design of your cluster, this could be a physically separate data center, a different section within the same data center, distinct server racks, or logically separated node groups. The goal of using availability zones is to minimize the risk of a single point of failure affecting the entire deployment.
6632

33+
* For example, in {{ech}}, availability zones correspond to the cloud provider’s availability zones. Each of these is typically a physically separate data center, ensuring redundancy and fault tolerance at the infrastructure level.
34+
::::
6735

6836
## Deployment types
6937

70-
These concepts aren’t essential if you’re just getting started. How you [deploy {{es}}](/get-started/deployment-options.md) in production determines what you need to know:
71-
72-
* **Self-managed {{es}}**: You are responsible for setting up and managing nodes, clusters, shards, and replicas. This includes managing the underlying infrastructure, scaling, and ensuring high availability through failover and backup strategies.
73-
* **Elastic Cloud**: Elastic can autoscale resources in response to workload changes. Choose from different deployment types to apply sensible defaults for your use case. A basic understanding of nodes, shards, and replicas is still important.
74-
* **Elastic Cloud Serverless**: You don’t need to worry about nodes, shards, or replicas. These resources are 100% automated on the serverless platform, which is designed to scale with your workload.
75-
76-
(add ECE and ECK)
38+
Production guidelines 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}}. However, certain parts may be relevant only to self-managed clusters, as orchestration systems automate some of the configurations discussed here.
7739

40+
Check the headers of each document or section to confirm whether the content applies to your deployment type.
7841

79-
% discarded text (from ECH best practices)
80-
81-
## HA and Resilience
82-
83-
{{es}} and {{kib}} provide mechanisms for HA and resilience
84-
42+
::::{note}
43+
**{{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/elastic-cloud/project-settings.md#elasticsearch-manage-project-search-ai-lake-settings).
44+
::::
8545

86-
### Use multiple nodes and shards
46+
## Section overview
8747

88-
### CCR for disaster recovery and geo-proximity
48+
**{{es}}**
8949

90-
## Performance tuning [cluster-design]
50+
* [](./production-guidance/getting-ready-for-production-elasticsearch.md)
51+
* [](./production-guidance/availability-and-resilience.md)
52+
* [](./production-guidance/availability-and-resilience/resilience-in-small-clusters.md)
53+
* [](./production-guidance/availability-and-resilience/resilience-in-larger-clusters.md)
54+
* [](./production-guidance/optimize-performance.md)
55+
* [Scaling considerations](./production-guidance/plan-for-production-elastic-cloud.md)
9156

92-
{{es}} offers many options that allow you to configure your cluster to meet your organization’s goals, requirements, and restrictions. You can review the following guides to learn how to tune your cluster to meet your needs:
57+
**{{kib}}**
9358

94-
::::{note}
95-
In orchestrated deployments some of the settings mentioned in this section are not applicable. Refer to each of the section headers to understand whether is applicable to your deployment type.
96-
::::
59+
* [](./production-guidance/kibana-in-production-environments.md)
60+
* [](./production-guidance/kibana-task-manager-scaling-considerations.md)
61+
* [](./production-guidance/kibana-alerting-production-considerations.md)
62+
* [](./production-guidance/kibana-reporting-production-considerations.md)
9763

98-
* [Designing for resilience](availability-and-resilience.md)
99-
* [Tune for indexing speed](optimize-performance/indexing-speed.md)
100-
* [Tune for search speed](optimize-performance/search-speed.md)
101-
* [Tune for disk usage](optimize-performance/disk-usage.md)
102-
* [Tune for time series data](../../manage-data/use-case-use-elasticsearch-to-manage-time-series-data.md)
10364

104-
Many {{es}} options come with different performance considerations and trade-offs. The best way to determine the optimal configuration for your use case is through [testing with your own data and queries](https://www.elastic.co/elasticon/conf/2016/sf/quantitative-cluster-sizing).
10565

10666

107-
## Scaling
10867

109-
% from https://www.elastic.co/guide/en/cloud/current/ec-planning.html ?
110-
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.
68+
## Other sections
11169

70+
Other sections of the documentation provide important guidance for running {{stack}} applications in production.
11271

113-
## Plan your data structure, availability, and formatting [ec_plan_your_data_structure_availability_and_formatting]
72+
### Plan your data structure, availability, and formatting [ec_plan_your_data_structure_availability_and_formatting]
11473

115-
* 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.
116-
* 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).
74+
* Build a [data architecture](/manage-data/lifecycle/data-tiers.md) that best fits your needs. Based on your own access and retention policies, you can add warm, cold, frozen data tiers, and automated deletion of old data.
75+
* 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), or consider [](./tools/cross-cluster-replication.md) to replicate indices across clusters.
11776
* Normalize event data to better analyze, visualize, and correlate your events by adopting the [Elastic Common Schema](asciidocalypse://docs/ecs/docs/reference/ecs-getting-started.md) (ECS). Elastic integrations use ECS out-of-the-box. If you are writing your own integrations, ECS is recommended.
11877

78+
### Optimize data storage and retention [ec_optimize_data_storage_and_retention]
11979

120-
## Optimize data storage and retention [ec_optimize_data_storage_and_retention]
121-
122-
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).
80+
* 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).
12381

12482
::::{tip}
12583
[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).
12684
::::
12785

86+
### Security and monitoring [security-and-monitoring]
87+
88+
As with any enterprise system, you need tools to secure, manage, and monitor your deployments. Security, monitoring, and administrative features that are integrated into {{es}} enable you to use [Kibana](../../get-started/the-stack.md) as a control center for managing a cluster.
89+
90+
[Learn about securing an {{es}} cluster](./security.md).
12891

92+
[Learn about monitoring your cluster](./monitor.md).

0 commit comments

Comments
 (0)