From 526968398490d9a283fc32776d110d3961f16cd6 Mon Sep 17 00:00:00 2001 From: George Wallace Date: Wed, 4 Dec 2024 07:46:30 -0700 Subject: [PATCH] Apply suggestions from code review Co-authored-by: David Kilfoyle <41695641+kilfoyle@users.noreply.github.com> --- .../reference-architectures/hot-frozen.asciidoc | 16 ++++++++-------- .../reference-architectures/index.asciidoc | 2 +- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/reference/reference-architectures/hot-frozen.asciidoc b/docs/reference/reference-architectures/hot-frozen.asciidoc index 69a1795f417f2..e3d7599ef8940 100644 --- a/docs/reference/reference-architectures/hot-frozen.asciidoc +++ b/docs/reference/reference-architectures/hot-frozen.asciidoc @@ -120,16 +120,16 @@ N2| **Shard Management: ** -* The most important foundational step to maintaining performance as you scale is proper shard management. This includes even shard distribution amongst nodes, shard size, and shard count. For a complete understanding of what shards are and how they should be used please review this documentation on https://www.elastic.co/guide/en/elasticsearch/reference/current/size-your-shards.html[sizing your shards]. +* The most important foundational step to maintaining performance as you scale is proper shard management. This includes even shard distribution amongst nodes, shard size, and shard count. For a complete understanding of what shards are and how they should be used, refer to https://www.elastic.co/guide/en/elasticsearch/reference/current/size-your-shards.html[Size your shards]. **Snapshots:** -* If auditable or business critical events are being logged a backup is necessary. The choice to backup data will be up to each business's needs and requirements. Please see this documentation if you need to create a https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-register-repository.html[snapshot repository]. -* To automate snapshots and attach to Index Lifecycle Management policies see https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-take-snapshot.html#automate-snapshots-slm[SLM (Snapshot Lifecycle Management)] +* If auditable or business critical events are being logged, a backup is necessary. The choice to back up data will depend on each individual business's needs and requirements. Refer to our https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-register-repository.html[snapshot repository] documentation to learn more. +* To automate snapshots and attach to Index lifecycle management policies, refer to https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-take-snapshot.html#automate-snapshots-slm[SLM (Snapshot lifecycle management)]. **Kibana:** -* If self-deploying outside of Elasticsearch Service ensure Kibana is configured for https://www.elastic.co/guide/en/kibana/current/production.html#high-availability[high availability]. +* If self-deploying outside of {ess}, ensure that {kib} is configured for https://www.elastic.co/guide/en/kibana/current/production.html#high-availability[high availability]. [discrete] [[hot-frozen-estimate]] @@ -137,8 +137,8 @@ N2| It depends on: * The type of data being ingested (such as logs, metrics, traces) -* The retention of searchable data (such as 30 days, 90 days, 1 year) -* The amount of data you need to ingest each day. +* The retention period of searchable data (such as 30 days, 90 days, 1 year) +* The amount of data you need to ingest each day You can https://www.elastic.co/contact[contact us] for an estimate and recommended configuration based on your specific scenario. @@ -146,8 +146,8 @@ You can https://www.elastic.co/contact[contact us] for an estimate and recommend [[hot-frozen-resources]] === Resources and references -* https://www.elastic.co/guide/en/elasticsearch/reference/current/scalability.html[Elasticsearch - Get ready for production] +* https://www.elastic.co/guide/en/elasticsearch/reference/current/scalability.html[{es} - Get ready for production] -* https://www.elastic.co/guide/en/cloud/current/ec-prepare-production.html[Elastic Cloud - Preparing a deployment for production] +* https://www.elastic.co/guide/en/cloud/current/ec-prepare-production.html[{ecloud - Preparing a deployment for production] * https://www.elastic.co/guide/en/elasticsearch/reference/current/size-your-shards.html[Size your shards] diff --git a/docs/reference/reference-architectures/index.asciidoc b/docs/reference/reference-architectures/index.asciidoc index f5a84bd4b1591..a46de786804ba 100644 --- a/docs/reference/reference-architectures/index.asciidoc +++ b/docs/reference/reference-architectures/index.asciidoc @@ -24,7 +24,7 @@ These reference architectures are recommendations and should be adapted to fit y A high availability architecture that is cost optimized for large time-series datasets. a| -* Have a requirement for cost effective long term data storage (many months or years) +* Have a requirement for cost effective long term data storage (many months or years). * Provide insights and alerts using logs, metrics, traces, or various event types to ensure optimal performance and quick issue resolution for applications. * Apply Machine Learning and Search AI to assist in dealing with the large amount of data. * Deploy an architecture model that allows for maximum flexibility between storage cost and performance.