[DOC] Move page navigation (#5128)

* Move page navigation, clean up formatting, and copy edits to naming conventions (plugins changed to management) 

---------

Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
This commit is contained in:
Melissa Vagi 2023-10-03 17:30:10 -06:00 committed by GitHub
parent 0d5e2cb549
commit e74dc48481
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
16 changed files with 67 additions and 48 deletions

View File

@ -1,10 +1,10 @@
---
layout: default
title: Customizing your branding
nav_order: 15
title: Custom branding
nav_order: 125
---
# Customizing your branding
# Custom branding
Introduced 1.2
{: .label .label-purple }

View File

@ -1,7 +1,7 @@
---
layout: default
title: Dev Tools
nav_order: 100
nav_order: 110
has_children: true
---

View File

@ -1,7 +1,7 @@
---
layout: default
title: Component templates
parent: Index management in Dashboards
parent: Index Management
nav_order: 50
---

View File

@ -1,7 +1,7 @@
---
layout: default
title: Data streams
parent: Index management in Dashboards
parent: Index Management
nav_order: 20
redirect_from:
- /dashboards/admin-ui-index/datastream/

View File

@ -1,7 +1,7 @@
---
layout: default
title: Force merge
parent: Index management in Dashboards
parent: Index Management
nav_order: 30
redirect_from:
- /dashboards/admin-ui-index/forcemerge/

View File

@ -1,7 +1,7 @@
---
layout: default
title: Indexes
parent: Index management in Dashboards
parent: Index Management
nav_order: 16
redirect_from:
- /dashboards/admin-ui-index/index-management/

View File

@ -1,40 +1,52 @@
---
layout: default
title: Index management in Dashboards
title: Index Management
nav_order: 80
has_children: true
redirect_from:
- /dashboards/admin-ui-index/
---
# Index management in Dashboards
# Index Management
Introduced 2.5
{: .label .label-purple }
The Index Management interface in OpenSearch Dashboards provides a unified solution for managing common indexing and data stream operations. The interface allows you to perform create, read, update, and delete (CRUD) and mapping operations for indexes, index templates, and aliases instead of using REST APIs or YAML configurations for basic administrative operations and interventions, along with other operations such as open, close, reindex, shrink, and split indexes. The interface also provides you with the capabilities to run index status and data validation before submitting requests and compare changes with previously saved settings before making updates.
## Get started with index management using Dashboards
An example of the interface is shown in the following image.
![Index Management user interface]({{site.url}}{{site.baseurl}}/images/dashboards/index-management-UI.png)
## Get started with Index Management using Dashboards
**Step 1: Open Index Management**
Once you're in OpenSearch Dashboards, select **Index Management** from the **OpenSearch Plugins** main menu. Then select **Indices**.
- Once you're in OpenSearch Dashboards, select **Index Management** from the **OpenSearch Plugins** main menu. Then select **Indices**.
**Step 2: View indexes**
In the Indices interface you will see a list of existing indexes in your OpenSearch cluster. The list provides information such as index name, health state, document count, index size, and other relevant details.
- In the **Indices** interface you will see a list of existing indexes in your OpenSearch cluster. The list provides information such as index name, health state, document count, index size, and other relevant details.
**Step 3: Create an index**
To create a new index, select the **Create index** button in the upper-right corner. You will be prompted to enter the index name and configure the index settings, such as number of shards and replicas. Fill in the required information and select **Create** to create the index.
- To create a new index, select the **Create index** button in the upper-right corner. You will be prompted to enter the index name and configure the index settings, such as number of shards and replicas. Fill in the required information and select **Create** to create the index.
**Step 4: Delete an index**
To delete an index, locate the index and select the checkbox next to it. Then select the **Actions** button and choose **Delete** from the dropdown list. Use caution when deleting indexes because this action is irreversible.
- To delete an index, locate the index and select the checkbox next to it. Then select the **Actions** button and choose **Delete** from the dropdown list. Use caution when deleting indexes because this action is irreversible.
**Step 5: Modify an index**
To modify the settings of an existing index, locate the index in the list and select its name. This takes you to the index details page. Here you can update settings such as the numbers of shards, replicas, and other advanced configurations. After making the desired changes, select **Save**.
- To modify the settings of an existing index, locate the index in the list and select its name. This takes you to the index details page. Here you can update settings such as the numbers of shards, replicas, and other advanced configurations. After making the desired changes, select **Save**.
**Step 7: Refresh indexes**
To refresh an index, locate the index and select the checkbox next to it. Then select the **Actions** button and choose **Refresh** from the dropdown list.
- To refresh an index, locate the index and select the checkbox next to it. Then select the **Actions** button and choose **Refresh** from the dropdown list.
**Step 8: Filter and search indexes**
If you have a large number of indexes and want to filter or search for specific indexes, you can use the search bar located above the list of indexes. Enter the relevant keywords or filters to narrow the list of indexes.
- If you have a large number of indexes and want to filter or search for specific indexes, you can use the search bar located above the list of indexes. Enter the relevant keywords or filters to narrow the list of indexes.
**Step 9: Additional operations**
Index Management provides additional functionalities such as creating index patterns, managing lifecycle policies, and configuring index templates. These options are available in their respective sections of the Index Management interface.
- Index Management provides additional functionalities such as creating index patterns, managing lifecycle policies, and configuring index templates. These options are available in their respective sections of the Index Management interface.

View File

@ -1,7 +1,7 @@
---
layout: default
title: Notification settings
parent: Index management in Dashboards
parent: Index Management
nav_order: 60
---

View File

@ -1,7 +1,7 @@
---
layout: default
title: Rollover
parent: Index management in Dashboards
parent: Index Management
nav_order: 40
redirect_from:
- /dashboards/admin-ui-index/rollover/

View File

@ -1,7 +1,7 @@
---
layout: default
title: Dashboards Management
nav_order: 110
nav_order: 100
has_children: true
---

View File

@ -1,11 +1,11 @@
---
layout: default
title: Managing search telemetry settings
nav_order: 100
title: Search telemetry
nav_order: 130
---
# Managing search telemetry settings
# Search telemetry
You can use search telemetry to analyze search request performance by success or failure in OpenSearch Dashboards. OpenSearch stores telemetry data in the `.kibana_1` index.

View File

@ -1,15 +1,21 @@
---
layout: default
title: Snapshot management in Dashboards
title: Snapshot Management
nav_order: 90
redirect_from:
- /dashboards/admin-ui-index/sm-dashboards/
---
# Snapshot Management in Dashboards
# Snapshot Management
[Snapshots]({{site.url}}{{site.baseurl}}/opensearch/snapshots/index/) are backups of a clusters indexes and state. The state includes cluster settings, node information, index metadata (mappings, settings, templates), and shard allocation. The Snapshot Management (SM) interface in OpenSearch Dashboards provides a unified solution for taking and restoring snapshots.
An example of the interface is shown in the following image.
![Snapshot Management user interface]({{site.url}}{{site.baseurl}}/images/dashboards/snapshots-UI.png)
## Snapshots use cases
Snapshots have two main uses:
1. Recovering from failure
@ -24,12 +30,13 @@ Snapshots have two main uses:
Before you create an SM policy, set up a repository for snapshots.
1. From the OpenSearch Dashboards main menu, select **OpenSearch Plugins** > **Snapshot Management**.
1. In the left panel, under **Snapshot Management**, select **Repositories**.
1. Choose the **Create Repository** button.
1. Enter the repository name, type, and location.
1. (Optional) Select **Advanced Settings** and enter additional settings for this repository as a JSON object. Example:
```json
1. From the OpenSearch Dashboards main menu, select **Management** > **Snapshot Management**.
2. In the left panel, under **Snapshot Management**, select **Repositories**.
3. Choose the **Create Repository** button.
4. Enter the repository name, type, and location.
5. (Optional) Select **Advanced Settings** and enter additional settings for this repository as a JSON object.
#### Example
```json
{
"chunk_size": null,
"compress": false,
@ -37,11 +44,11 @@ Before you create an SM policy, set up a repository for snapshots.
"max_snapshot_bytes_per_sec": "40m",
"readonly": false
}
```
1. Choose the **Add** button.
```
6. Choose the **Add** button.
If you need to automate snapshot creation, you can use a snapshot policy.
{: .note}
{::nomarkdown}<img src="{{site.url}}{{site.baseurl}}/images/icons/star-icon.png" class="inline-icon" alt="star icon"/>{:/} **Note:** If you need to automate snapshot creation, you can use a snapshot policy.
{: .note purple}
## Deleting a repository
@ -51,7 +58,7 @@ To delete a snapshot repository configuration, select the repository from the **
Create an SM policy to set up automatic snapshots. An SM policy defines an automated snapshot creation schedule and an optional automated deletion schedule.
1. From the OpenSearch Dashboards main menu, select **OpenSearch Plugins** > **Snapshot Management**.
1. From the OpenSearch Dashboards main menu, select **Management** > **Snapshot Management**.
1. In the left panel, under **Snapshot Management**, select **Snapshot Policies**.
1. Select the **Create Policy** button.
1. In the **Policy settings** section:
@ -77,7 +84,7 @@ Create an SM policy to set up automatic snapshots. An SM policy defines an autom
You can view, edit, or delete an SM policy on the policy details page.
1. From the OpenSearch Dashboards main menu, select **OpenSearch Plugins** > **Snapshot Management**.
1. From the OpenSearch Dashboards main menu, select **Management** > **Snapshot Management**.
1. In the left panel, under **Snapshot Management**, select **Snapshot Policies**.
1. Click on the **Policy name** of the policy you want to view, edit, or delete. <br>
The policy settings, snapshot schedule, snapshot retention period, notifications, and last creation and deletion are displayed in the policy details page. <br> If a snapshot creation or deletion fails, you can view information about the failure in the **Last Creation/Deletion** section. To view the failure message, click on the **cause** in the **Info** column.
@ -85,14 +92,14 @@ The policy settings, snapshot schedule, snapshot retention period, notifications
## Enable, disable, or delete SM policies
1. From the OpenSearch Dashboards main menu, select **OpenSearch Plugins** > **Snapshot Management**.
1. From the OpenSearch Dashboards main menu, select **Management** > **Snapshot Management**.
1. In the left panel, under **Snapshot Management**, select **Snapshot Policies**.
1. Select one or more policies in the list.
1. To enable or disable selected SM policies, select the **Enable** or **Disable** button. To delete selected SM policies, in the **Actions** list, select the **Delete** option.
## View snapshots
1. From the OpenSearch Dashboards main menu, select **OpenSearch Plugins** > **Snapshot Management**.
1. From the OpenSearch Dashboards main menu, select **Management** > **Snapshot Management**.
1. In the left panel, under **Snapshot Management**, select **Snapshots**.
All automatically or manually taken snapshots appear in the list.
1. To view a snapshot, click on its **Name**.
@ -101,7 +108,7 @@ All automatically or manually taken snapshots appear in the list.
Follow these steps to take a snapshot manually:
1. From the OpenSearch Dashboards main menu, select **OpenSearch Plugins** > **Snapshot Management**.
1. From the OpenSearch Dashboards main menu, select **Management** > **Snapshot Management**.
1. In the left panel, under **Snapshot Management**, select **Snapshots**.
1. Select the **Take snapshot** button.
1. Enter the snapshot name.
@ -122,13 +129,13 @@ The **Delete** button [deletes]({{site.url}}{{site.baseurl}}/api-reference/snaps
## Restoring a snapshot
1. From the OpenSearch Dashboards main menu, select **OpenSearch Plugins** > **Snapshot Management**.
1. From the OpenSearch Dashboards main menu, select **Management** > **Snapshot Management**.
1. In the left panel, under **Snapshot Management**, select **Snapshots**. The **Snapshots** tab is selected by default.
1. Select the checkbox next to the snapshot you want to restore, as shown in the following image:
1. Select the checkbox next to the snapshot you want to restore. An example is shown in the following image:
<img src="{{site.url}}{{site.baseurl}}/images/restore-snapshot/restore-snapshot-main.png" alt="Snapshots">{: .img-fluid}
You can only restore snapshots with the status of `Success` or `Partial`. The status of the snapshot is displayed in the **Snapshot status** column.
{: .note}
{::nomarkdown}<img src="{{site.url}}{{site.baseurl}}/images/icons/star-icon.png" class="inline-icon" alt="star icon"/>{:/} **Note:** You can only restore snapshots with the status of `Success` or `Partial`. The status of the snapshot is displayed in the **Snapshot status** column.
{: .note purple}
1. In the **Restore snapshot** flyout, select the options for restoring the snapshot.
The **Restore snapshot** flyout lists the snapshot name and status. To view the list of indexes in the snapshot, select the number under **Indices** (for example, `27` in the following image). This number represents the number of indexes in the snapshot.
@ -162,8 +169,8 @@ The **Delete** button [deletes]({{site.url}}{{site.baseurl}}/api-reference/snaps
You can view the percentage of the job that has been completed in the **Status** column. Once the snapshot restore is complete, the **Status** changes to `Completed (100%)`.
The **Restore activities in progress** panel is not persistent. It displays only the progress of the current restore operation. If multiple restore operations are running, the panel displays the most recent one.
{: .note }
{::nomarkdown}<img src="{{site.url}}{{site.baseurl}}/images/icons/star-icon.png" class="inline-icon" alt="star icon"/>{:/} **Note:** The **Restore activities in progress** panel is not persistent. It displays only the progress of the current restore operation. If multiple restore operations are running, the panel displays the most recent one.
{: .note purple}
To view the status of each index being restored, select the link in the **Indices being restored** column (in the preceding image, the `27 Indices` link). The **Indices being restored** flyout (shown in the following image) displays each index and its restore status.
<img src="{{site.url}}{{site.baseurl}}/images/restore-snapshot/restore-snapshot-indices.png" alt="Restore Indices">{: .img-fluid}

Binary file not shown.

After

Width:  |  Height:  |  Size: 202 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 232 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 241 KiB

BIN
images/icons/star-icon.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.4 KiB