Skip to content

Commit

Permalink
Add documentation for IM UI index templates (opensearch-project#3459)
Browse files Browse the repository at this point in the history
* Add documentation for IM UI index templates

Signed-off-by: ariamarble <[email protected]>

* Content planning

Signed-off-by: vagimeli <[email protected]>

* Content planning

Signed-off-by: vagimeli <[email protected]>

* Content planning

Signed-off-by: vagimeli <[email protected]>

* Content planning

Signed-off-by: vagimeli <[email protected]>

* minor update

Signed-off-by: ariamarble <[email protected]>

* Content planning

Signed-off-by: vagimeli <[email protected]>

* Content planning

Signed-off-by: vagimeli <[email protected]>

* Content planning

Signed-off-by: vagimeli <[email protected]>

* Content planning

Signed-off-by: vagimeli <[email protected]>

* Content planning

Signed-off-by: vagimeli <[email protected]>

* Content planning

Signed-off-by: vagimeli <[email protected]>

* Content planning

Signed-off-by: vagimeli <[email protected]>

* Content planning

Signed-off-by: vagimeli <[email protected]>

* Content planning

Signed-off-by: vagimeli <[email protected]>

* Content planning

Signed-off-by: vagimeli <[email protected]>

* quick status update

Signed-off-by: ariamarble <[email protected]>

* content updates

Signed-off-by: ariamarble <[email protected]>

* add gif demo

Signed-off-by: ariamarble <[email protected]>

* Apply suggestions from doc review

Co-authored-by: Chris Moore <[email protected]>

* Apply suggestions from editorial review

Co-authored-by: Nathan Bower <[email protected]>

* added image text

Signed-off-by: ariamarble <[email protected]>

* Apply suggestions from editorial review

Co-authored-by: Nathan Bower <[email protected]>

---------

Signed-off-by: ariamarble <[email protected]>
Signed-off-by: vagimeli <[email protected]>
Co-authored-by: vagimeli <[email protected]>
Co-authored-by: Chris Moore <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
  • Loading branch information
4 people authored and harshavamsi committed Oct 31, 2023
1 parent 085789b commit 6de49f6
Show file tree
Hide file tree
Showing 4 changed files with 66 additions and 0 deletions.
66 changes: 66 additions & 0 deletions _dashboards/im-dashboards/component-templates.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
---
layout: default
title: Component templates
parent: Index management in Dashboards
nav_order: 50
---

# Component templates
Introduced 2.7
{: .label .label-purple }

Component templates allow you to create a single index pattern that matches multiple indexes. This pattern can include wildcards or regular expressions, enabling you to apply the same setting or mapping to multiple indexes simultaneously.

Using them with [index templates]({{site.url}}{{site.baseurl}}/im-plugin/index-templates/) can provide a powerful tool for managing large volumes of data. You can create an index template that defines the basic structure and settings of your indexes and then use the component templates to apply the settings to all indexes that match a specific pattern or set of criteria.

You can create component templates using the Index Management UI. The UI maximizes ease of use for common indexing and data stream administrative operations such as create, read, update, delete (CRUD) and mapping indexes; CRUD and mapping aliases; reindexing; and open/close, shrink, and split indexes, along with the monitoring of actions and logging of audit records.

The following GIF demonstrates creating a component template.

![Component template demo]({{site.url}}{{site.baseurl}}/images/admin-ui-index/component.gif)

## Prerequisites

This tutorial is intended for admin users who [manage OpenSearch clusters]({{site.url}}{{site.baseurl}}/tuning-your-cluster/cluster/) and are familiar with [index management in OpenSearch Dashboards]({{site.url}}{{site.baseurl}}/dashboards/im-dashboards/index/).

## Key terms

It's helpful to understand the following terms before starting this tutorial:

- *Component template* refers to a reusable building block with settings, mappings, and aliases that can be attached to an index template.
- *Index template* refers to a predefined structure used to organize and store data in a database or search index.

## Creating component templates using the Index Management UI

You can use predefined OpenSearch Dashboards component templates or customize your own, either by creating original templates or by modifying existing templates. Predefined component templates include preconfigured charts, tables, and graphs and are a good starting point for users who are new to OpenSearch Dashboards. Alternatively, customized template components provide you with options for tailoring reports and visualizations that meet your specific requirements and preferences.

To create template components using the UI, follow these steps:

1. On the OpenSearch Dashboards main page, select **Index Management** in the navigation menu.
1. In the Index Management window, select **Templates** > **Component templates**.
1. Select **Create** and then define the component template settings.
1. To configure aliases, settings, and mappings, toggle **Use configuration**, as shown in the following image.

![Component template use configuration]({{site.url}}{{site.baseurl}}/images/admin-ui-index/component_use_config.png)

1. Enter details in the aliases, settings, and mappings fields.
1. Select **Create component template**.

When you create component templates, those templates apply only to new index templates that you create and not to existing index templates.
{: .note }

## Associating component templates with index templates

To associate a component template with an index template, follow these steps:

1. In the **Index Management** navigation menu, select **Templates**.
1. In the Templates window, select **Create template**.
1. Select **Component template** as the method for defining your template.
1. In the **Component template** pane, select **Associate component template**, as shown in the following image.

![Component template associate configuration]({{site.url}}{{site.baseurl}}/images/admin-ui-index/associate_component.png)

1. In the **Associate component template** pop-up window, select the component templates that you want to associate with your index template.
1. Select **Associate**.
1. Select **Preview template** to view the template settings.
1. Select **Create template**.
Binary file added images/admin-ui-index/associate_component.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/admin-ui-index/component.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/admin-ui-index/component_use_config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 6de49f6

Please sign in to comment.