Add Blog: OpenSearch Simplified: The Power of Application-Based Configuration Templates #3509
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Mohit Godwani <[email protected]>
mgodwan
requested review from
elfisher,
AMoo-Miki,
nknize,
krisfreedain,
peterzhuamazon,
CEHENKLE,
dtaivpp,
kolchfa-aws,
nateynateynate and
natebower
as code owners
pajuric
reviewed
Dec 18, 2024
| # OpenSearch Simplified: The Power of Application-Based Configuration Templates | ||
|
|
||
|
|
||
| OpenSearch supports a wide variety of use-cases, ranging from logs, metrics, traces, website search, vectors, etc., and enables users to build solutions for various applications based on their use cases. As the use cases for OpenSearch continue to grow, managing indices and configuring them with the right settings can become a daunting task, both for experienced and new users. OpenSearch provides numerous knobs and settings to fine-tune indices for different performance and usability dimensions, such as throughput, latency, disk utilization, and more. However, for new users, finding the optimal configuration often requires extensive experimentation and developer effort, creating friction during the on-boarding process. As new features are developed and released, experienced users of OpenSearch may miss out on them as well. |
There was a problem hiding this comment.
Consider adding links to the following:
- Logs: https://opensearch.org/docs/latest/install-and-configure/configuring-opensearch/logs/
- Metrics: https://opensearch.org/docs/latest/monitoring-your-cluster/metrics/getting-started/
- Search: https://opensearch.org/docs/latest/search-plugins/
- Vector: https://opensearch.org/docs/latest/search-plugins/vector-search/
pajuric
reviewed
Dec 18, 2024
|
|
||
| OpenSearch supports a wide variety of use-cases, ranging from logs, metrics, traces, website search, vectors, etc., and enables users to build solutions for various applications based on their use cases. As the use cases for OpenSearch continue to grow, managing indices and configuring them with the right settings can become a daunting task, both for experienced and new users. OpenSearch provides numerous knobs and settings to fine-tune indices for different performance and usability dimensions, such as throughput, latency, disk utilization, and more. However, for new users, finding the optimal configuration often requires extensive experimentation and developer effort, creating friction during the on-boarding process. As new features are developed and released, experienced users of OpenSearch may miss out on them as well. | ||
|
|
||
| To address this challenge, OpenSearch 2.17 introduced the concept of Application Based Configuration templates as an experimental feature. This feature allows users to easily configure their indices based on the specific use case they are building it for, reducing the need for manual tweaking and promoting a seamless on-boarding experience and managing the lifecycle of the index and its settings/mappings as new features are introduced. |
There was a problem hiding this comment.
Link the reference to OpenSearch 2.17 to the following: https://opensearch.org/blog/introducing-opensearch-2-17/
There was a problem hiding this comment.
Lowercase application-based configuration templates and link it to here: https://opensearch.org/docs/latest/im-plugin/index-context/
pajuric
reviewed
Dec 18, 2024
|
|
||
| ## What are Application-Based Configuration (ABC) Templates? | ||
|
|
||
| Application-Based Configuration (ABC) templates in OpenSearch are predefined system templates designed to simplify the process of configuring indices for various use cases by providing predefined settings and configurations out of the box. These templates encapsulate various optimized settings, mappings, and configurations tailored for different use cases, eliminating the need for users to manually handle each setting or knob individually. |
There was a problem hiding this comment.
Sentence case - Application-based configuration (ABC) templates for consistency.
Signed-off-by: Fanit Kolchina <[email protected]>
Signed-off-by: Fanit Kolchina <[email protected]>
natebower
reviewed
Dec 19, 2024
There was a problem hiding this comment.
@kolchfa-aws @mgodwan Editorial review complete. Nicely written 😄. Please see my comments and changes and let me know if you have any questions. Thanks!
Cc: @pajuric
_posts/2024-12-20-OpenSearch-Simplified-The-Power-of-Application-Based-Templates.markdown
Outdated
Show resolved
Hide resolved
_posts/2024-12-20-OpenSearch-Simplified-The-Power-of-Application-Based-Templates.markdown
Outdated
Show resolved
Hide resolved
| OpenSearch supports a wide variety of use cases---such as [logs](https://opensearch.org/docs/latest/install-and-configure/configuring-opensearch/logs/), [metrics](https://opensearch.org/docs/latest/monitoring-your-cluster/metrics/getting-started/), [traces](https://opensearch.org/docs/latest/data-prepper/common-use-cases/trace-analytics/), [website search](https://opensearch.org/docs/latest/search-plugins/), and [vectors](https://opensearch.org/docs/latest/search-plugins/vector-search/)---and enables you to build solutions for various applications based on your use case. As the use cases for OpenSearch continue to grow, managing indexes and configuring them with the right settings can become a daunting task, both for experienced and new users. OpenSearch provides numerous settings to fine-tune indexes for various performance and usability dimensions, such as throughput, latency, and disk utilization. However, for new users, finding the optimal configuration often requires extensive experimentation and developer effort, creating friction during the onboarding process. As new features are developed and released, experienced users of OpenSearch may overlook them as well. | ||
|
|
||
| To address this challenge, [OpenSearch 2.17](https://opensearch.org/blog/introducing-opensearch-2-17/) introduced the concept of _Application-Based Configuration (ABC) templates_ as an experimental feature. This feature allows you to easily configure your indexes based on your specific use case, reducing the need for manual updating while promoting a seamless onboarding experience and managing the lifecycle of the index and its settings and mappings as new features are introduced. | ||
|
|
There was a problem hiding this comment.
Should "Application-Based Configuration (ABC) templates" be used in the title?
_posts/2024-12-20-OpenSearch-Simplified-The-Power-of-Application-Based-Templates.markdown
Outdated
Show resolved
Hide resolved
_posts/2024-12-20-OpenSearch-Simplified-The-Power-of-Application-Based-Templates.markdown
Outdated
Show resolved
Hide resolved
_posts/2024-12-20-OpenSearch-Simplified-The-Power-of-Application-Based-Templates.markdown
Outdated
Show resolved
Hide resolved
_posts/2024-12-20-OpenSearch-Simplified-The-Power-of-Application-Based-Templates.markdown
Outdated
Show resolved
Hide resolved
_posts/2024-12-20-OpenSearch-Simplified-The-Power-of-Application-Based-Templates.markdown
Outdated
Show resolved
Hide resolved
_posts/2024-12-20-OpenSearch-Simplified-The-Power-of-Application-Based-Templates.markdown
Outdated
Show resolved
Hide resolved
| To get started with ABC templates, see [Index context](https://opensearch.org/docs/latest/im-plugin/index-context/). | ||
|
|
||
| The following animation illustrates creating an index using ABC templates. The template sets the required mappings and settings to the index. Additionally, it configures direct integration with OpenSearch dashboards for the data ingested thereafter. | ||
|
|
There was a problem hiding this comment.
Line 51: Confirm that my change to "an ABC template" is correct (following "The template" in the next sentence).
kolchfa-aws
reviewed
Dec 19, 2024
_posts/2024-12-20-OpenSearch-Simplified-The-Power-of-Application-Based-Templates.markdown
Outdated
Show resolved
Hide resolved
Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: kolchfa-aws <[email protected]>
|
@pajuric Could you provide the meta for this blog? |
pajuric
reviewed
Dec 19, 2024
| - technical-post | ||
| meta_keywords: | ||
| meta_description: | ||
| --- |
There was a problem hiding this comment.
Please add the following meta:
meta_keywords: Application-Based Configuration templates, ABC templates, index templates, index configuration, OpenSearch performance optimization
meta_description: Explore OpenSearch's Application-Based Configuration (ABC) templates simplifies index configuration, optimizes performance, and streamlines setup for various use cases including logs, metrics, and traces.
kolchfa-aws
reviewed
Dec 19, 2024
_posts/2024-12-20-OpenSearch-Simplified-The-Power-of-Application-Based-Templates.markdown
Outdated
Show resolved
Hide resolved
…on-Based-Templates.markdown Signed-off-by: kolchfa-aws <[email protected]>
kolchfa-aws
reviewed
Dec 19, 2024
_posts/2024-12-20-OpenSearch-Simplified-The-Power-of-Application-Based-Templates.markdown
Outdated
Show resolved
Hide resolved
…on-Based-Templates.markdown Signed-off-by: kolchfa-aws <[email protected]>
kolchfa-aws
reviewed
Dec 23, 2024
_posts/2024-12-20-OpenSearch-Simplified-The-Power-of-Application-Based-Templates.markdown
Outdated
Show resolved
Hide resolved
…on-Based-Templates.markdown Signed-off-by: kolchfa-aws <[email protected]>
|
@nateynateynate @krisfreedain - Blog is ready to publish today. Thanks all and Happy Holidays! |
|
@nateynateynate @krisfreedain - Let's get this one published on 12/26, please. |
kolchfa-aws
approved these changes
Dec 23, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
[BLOG] OpenSearch Simplified: The Power of Application-Based Configuration Templates
Issues Resolved
#3508
Check List
By submitting this pull request, I confirm that my contribution is made under the terms of the BSD-3-Clause License.