Skip to content

Commit

Permalink
Editorial for Admin UI index operations (#2421)
Browse files Browse the repository at this point in the history
* Editorial for Admin UI index operations

Signed-off-by: ariamarble <armarble@amazon.com>

* formatting and title change

Signed-off-by: ariamarble <armarble@amazon.com>

* Tech updates

Signed-off-by: ariamarble <armarble@amazon.com>

* format changes

Signed-off-by: ariamarble <armarble@amazon.com>

* Terminology changes

Signed-off-by: ariamarble <armarble@amazon.com>

* quick change

Signed-off-by: ariamarble <armarble@amazon.com>

* editorial changes

Signed-off-by: ariamarble <armarble@amazon.com>

* Apply suggestions from doc review

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

* title change

Signed-off-by: ariamarble <armarble@amazon.com>

* further doc review changes

Signed-off-by: ariamarble <armarble@amazon.com>

* changing nav order

Signed-off-by: ariamarble <armarble@amazon.com>

Signed-off-by: ariamarble <armarble@amazon.com>
Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
  • Loading branch information
2 people authored and vagimeli committed Jan 19, 2023
1 parent 6fb83d8 commit 87859f8
Show file tree
Hide file tree
Showing 4 changed files with 54 additions and 35 deletions.
64 changes: 41 additions & 23 deletions _dashboards/admin-ui-index/index-management.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
---
layout: default
title: Index management
parent: Admin UI for index operations in OpenSearch Dashboards
nav_order: 10
parent: Index and snapshot management in OpenSearch Dashboards
nav_order: 16
---

# Index management
Introduced 2.5
{: .label .label-purple }

The Index Management section in the admin UI allows you to perform the operations available in the [Index API]({{site.url}}{{site.baseurl}}/api-reference/index-apis/index/) from OpenSearch Dashboards' web UI.
In the **Index Management** section, you can perform the operations available in the [Index API]({{site.url}}{{site.baseurl}}/api-reference/index-apis/index/).

## Index policies

Expand Down Expand Up @@ -49,9 +49,15 @@ To attach policies to indexes, perform the following steps:

## Indexes

The **Indices** section displays a list of indexes in your OpenSearch cluster. For each index included, you can see its heath status (`green`, `yellow`, or `red`), policy (if the index is managed by a policy), status, total size, size of primaries, total documents, deleted documents, primaries and replicas.
The **Indices** section displays a list of indexes in your OpenSearch cluster. For each index included, you can see its health status (`green`, `yellow`, or `red`), policy (if the index is managed by a policy), status, total size, size of primaries, total documents, deleted documents, primaries, and replicas.

#### Create index
The following are the three index health statuses:

- Green: All primary and replica shards are assigned.
- Yellow: At least one replica shard is not assigned.
- Red: At least one primary shard is not assigned.

### Create index

While you can [create an index]({{site.url}}{{site.baseurl}}/api-reference/index-apis/create-index/) by using a document as a base, you can also create an empty index for later use.

Expand All @@ -66,11 +72,11 @@ You can also add fields and objects using either the visual editor or the JSON e

**Advanced settings** allows you to upload a JSON configuration.

#### Apply policy
### Apply policy

If you analyze time series data, you likely want to prioritize new data over old data. You might periodically perform certain operations on older indexes, such as reducing replica count or deleting them.

[Index State Management]({{site.url}}{{site.baseurl}}/im-plugin/ism/index/) (ISM) is a plugin that lets you automate these periodic administrative operations by triggering them based on changes in the index age, index size, or number of documents. The admin UI uses the ISM plugin to define policies that automatically handle index rollovers or deletions to fit your use case.
[Index State Management]({{site.url}}{{site.baseurl}}/im-plugin/ism/index/) (ISM) is a plugin that lets you automate these periodic administrative operations by triggering them based on changes in the index age, index size, or number of documents. You can define policies that automatically handle index rollovers or deletions to fit your use case.

For example, you can define a policy that moves your index into a **read_only** state after 30 days and then deletes it after a set period of 90 days. You can also set up the policy to send you a notification message when the index is deleted.

Expand All @@ -80,43 +86,43 @@ To apply a policy, select the index to which you want to apply the policy in the

<img src="{{site.url}}{{site.baseurl}}/images/admin-ui-index/apply-policy.PNG" alt="User interface showing apply policy prompt">

#### Close
### Close index

The [close index]({{site.url}}{{site.baseurl}}/api-reference/index-apis/close-index/) operation closes an index. Once an index is closed, you cannot add data to it or search for any data within the index.

To close an index, select the index you want to close in the **Indices** list under **Index Management**. Then select the **Actions** button, and select **Close** from the dropdown list.

#### Open
### Open index

The [open index]({{site.url}}{{site.baseurl}}/api-reference/index-apis/open-index/) operation opens a closed index, letting you add or search for data within the index.

To open an index, select the index you want to open in the **Indices** list under **Index Management**. Then select the **Actions** button, and select **Open** from the dropdown list.

#### Reindex
### Reindex

The [reindex]({{site.url}}{{site.baseurl}}/api-reference/document-apis/reindex/) operation lets you copy all your data or a subset of data from a source index into a destination index.

To reindex an index, select the index in the **Indices** list under **Index Management**. Then select the **Actions** button, and select **Reindex** from the dropdown list.

<img src="{{site.url}}{{site.baseurl}}/images/admin-ui-index/reindex-expanded.png" alt="User interface showing reindex prompt">

#### Shrink
### Shrink index

The [shrink]({{site.url}}{{site.baseurl}}/api-reference/index-apis/shrink-index/) index operation moves all of your data in an existing index into a new index with fewer primary shards.
The [shrink]({{site.url}}{{site.baseurl}}/api-reference/index-apis/shrink-index/) index operation copies all of the data in an existing index into a new index with fewer primary shards.

To shrink an index, select the index you want to shrink in the **Indices** list under **Index Management**. Then select the **Actions** button, and select **Shrink** from the dropdown list.

<img src="{{site.url}}{{site.baseurl}}/images/admin-ui-index/shrink.png" alt="User interface showing shrink prompt">

#### Split
### Split index

The [split index]({{site.url}}{{site.baseurl}}/api-reference/index-apis/split/) operation splits an existing read-only index into a new index, splitting each primary shard into a number of primary shards in the new index.

To split an index, select the index you want to split in the **Indices** list under **Index Management**. Then select the **Actions** button, and select **Split** from the dropdown list.

<img src="{{site.url}}{{site.baseurl}}/images/admin-ui-index/split-expanded.png" alt="User interface showing split page">

#### Delete
### Delete index

If you no longer need an index, you can use the [delete index]({{site.url}}{{site.baseurl}}/api-reference/index-apis/delete-index/) operation to delete it.

Expand All @@ -128,22 +134,33 @@ To delete an index, select the index you want to delete in the **Indices** list

<img src="{{site.url}}{{site.baseurl}}/images/admin-ui-index/templates.PNG" alt="User interface showing Templates page">

### Creating a template

To create a template, select the **Create template** button on the **Templates** page under **Index Management**.

Next, define the template:

1. Enter the template name.
2. Select the template type.
3. Specify any index patterns you would like to use.
4. Set the priority of the template.
5. Select an index alias.
6. Set the number of primary shards.
7. Set the number of replicas.
8. Set the refresh intervals.
9. Add fields and objects for your index mapping using either the visual editor or the JSON editor.
1. Select the template type.
1. Specify any index patterns you would like to use.
1. Set the priority of the template.
1. Select an index alias.
1. Set the number of primary shards.
1. Set the number of replicas.
1. Set the refresh intervals.
1. Add fields and objects for your index mapping using either the visual editor or the JSON editor.
1. Under **Advanced Settings** you can specify advanced index settings with a comma-delimited list.

<img src="{{site.url}}{{site.baseurl}}/images/admin-ui-index/create-template-expanded.png" alt="User interface showing Create Template page">

### Editing a template

To edit a template, select the template you want to edit from the list of templates. Next, select the **Actions** dropdown list and select the **Edit** option.

### Deleting a template

To delete a template, select the template you want to delete from the list of templates. Next, select the **Actions** dropdown list and select the **Delete** option.

## Aliases

An alias is a virtual index name that can point to one or more indexes. If your data is spread across multiple indexes, rather than keeping track of which indexes to query, you can create an alias and query it instead.
Expand Down Expand Up @@ -193,7 +210,7 @@ You can also disable and enable rollup jobs by selecting the corresponding butto

## Transform jobs

Using the admin UI in OpenSearch Dashboards, you can create, start, stop, and complete operations with [transform]({{site.url}}{{site.baseurl}}/im-plugin/index-transforms/transforms-apis/) jobs.
You can create, start, stop, and complete operations with [transform]({{site.url}}{{site.baseurl}}/im-plugin/index-transforms/transforms-apis/) jobs.

To create a transform job, perform the following steps:

Expand Down Expand Up @@ -223,3 +240,4 @@ You can check the status of the reindex, shrink, and split operations because th
## Error handling

Similar to API calls, if the operation fails immediately, you will be notified with an error message. However, if it is a long-running operation, you will be notified of the failure at the time of failure, or you can check the index status on the **Indices** page.

10 changes: 5 additions & 5 deletions _dashboards/admin-ui-index/index.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
---
layout: default
title: Admin UI for index operations in OpenSearch Dashboards
nav_order: 1
title: Index and snapshot management in OpenSearch Dashboards
nav_order: 15
has_children: true
redirect_from:
- /dashboards/admin-ui-index/
---

# Admin UI for index operations in OpenSearch Dashboards
# Index and snapshot management in OpenSearch Dashboards
Introduced 2.5
{: .label .label-purple }

The admin user interface (UI) for index operation allows you to perform common index operations through a user-friendly interface and prevent unintentional changes.
Previously, users relied on REST APIs or YAML configurations for basic administrative operations and interventions. This release takes the first step toward a unified administration panel in OpenSearch Dashboards with the launch of several index management UI enhancements. The new interface provides a more user-friendly way to run common indexing and data stream operations. Now you can perform create, read, update, and delete (CRUD) and mapping operations for indexes, index templates, and aliases through the UI. Additionally, you can open, close, reindex, shrink, and split indexes. The UI runs index status and data validation before submitting requests and lets you compare changes with previously saved settings before making updates.

The admin UI interface allows you to perform basic cluster administrative operations, or to view cluster health metrics and status. While there have been some administration user experiences in OpenSearch Dashboards (ISM, Alerting on HTTP inputs, Security, etc.), there is now a unified web UI experience for cluster administrators to administer their deployments.
<img src="{{site.url}}{{site.baseurl}}/images/admin-ui-index/admin-UI-preview.gif" alt="Index management demo gif">{: .img-fluid}
15 changes: 8 additions & 7 deletions _dashboards/admin-ui-index/sm-dashboards.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
layout: default
title: Using Snapshot Management in OpenSearch Dashboards
parent: Admin UI for index operations in OpenSearch Dashboards
nav_order: 30
title: Snapshot management
parent: Index and snapshot management in OpenSearch Dashboards
nav_order: 17
---

# Using Snapshot Management in OpenSearch Dashboards
# Snapshot management

You can set up Snapshot Management (SM) in OpenSearch Dashboards.

Expand All @@ -15,13 +15,13 @@ Snapshots have two main uses:

1. Recovering from failure

For example, if cluster health goes red, you might restore the red indexes from a snapshot.
For example, if cluster health goes red, you might restore the red indexes from a snapshot.

2. Migrating from one cluster to another

For example, if you’re moving from a proof-of-concept to a production cluster, you might take a snapshot of the former and restore it on the latter.
For example, if you’re moving from a proof-of-concept to a production cluster, you might take a snapshot of the former and restore it on the latter.

You can take and restore snapshots using the admin UI in Dashboards.
You can take and restore snapshots using snapshot management in OpenSearch Dashboards.

If you need to automate taking snapshots, you can use a snapshot policy.

Expand Down Expand Up @@ -173,3 +173,4 @@ The **Delete** button [deletes]({{site.url}}{{site.baseurl}}/api-reference/snaps
After the restore operation is complete, the restored indexes are listed in the **Indices** panel. To view the indexes, in the left panel, under **Index Management**, select **Indices**.

<img src="{{site.url}}{{site.baseurl}}/images/restore-snapshot/restore-snapshot-indices-panel.png" alt="View Indices">{: .img-fluid}

Binary file added images/admin-ui-index/admin-UI-preview.gif
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 87859f8

Please sign in to comment.