Skip to content

Commit

Permalink
[DOC] Update Management navigation interface in dashboards for UX rev…
Browse files Browse the repository at this point in the history
…isions and add index management tutorial (#4550)

* Update Management navigation interface images and terminology 

Signed-off-by: Melissa Vagi <[email protected]>

---------

Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
  • Loading branch information
vagimeli and natebower authored Jul 13, 2023
1 parent 2904d1b commit 583eecb
Show file tree
Hide file tree
Showing 10 changed files with 69 additions and 52 deletions.
6 changes: 3 additions & 3 deletions _dashboards/dev-tools/index-dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ has_children: true

# Dev Tools

**Dev Tools** allows you to set up your OpenSearch Dashboards environment, identify and fix bugs, and customize your dashboards' appearance and behavior.
Use **Dev Tools** to set up your OpenSearch Dashboards environment, identify and fix bugs, and customize dashboards' appearance and behavior.

To access the Dev Tools console, select **Dev Tools** in the menu on the OpenSearch Dashboards home page. You'll see an interface like the one shown in the following image.
To access the Dev Tools console, select **Dev Tools** under the **Management** menu on the OpenSearch Dashboards home page. You'll see an interface like the one shown in the following image.

<img src="{{site.url}}{{site.baseurl}}/images/dashboards/dev-tools-console.png" alt="Dev Tools interface from home page">
<img src="{{site.url}}{{site.baseurl}}/images/dashboards/dev-tools-console.png)" alt="Dev Tools interface">
20 changes: 8 additions & 12 deletions _dashboards/dev-tools/run-queries.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,25 +9,15 @@ redirect_from:

# Running queries in the Dev Tools console

You can use the OpenSearch Dev Tools Console to send queries to OpenSearch.

## Navigating to the console

To open the console, select **Dev Tools** on the main OpenSearch Dashboards page:

<img src="{{site.url}}{{site.baseurl}}/images/dev-tools/dev-tools-main.png" alt="Dev Tools Console from main page">{: .img-fluid }

You can open the console from any other page by navigating to the main menu and selecting **Management** > **Dev Tools**.

<img src="{{site.url}}{{site.baseurl}}/images/dev-tools/dev-tools-left.png" width=200 alt="Dev Tools Console from all pages">
Use the Dev Tools console to send queries to OpenSearch. To access the Dev Tools console, select **Dev Tools** under the **Management** menu on the OpenSearch Dashboards home page.

## Writing queries

Write your queries in the editor pane on the left side of the console:

<img src="{{site.url}}{{site.baseurl}}/images/dev-tools/dev-tools-request.png" alt="Request pane">{: .img-fluid }

You can collapse and expand parts of your query by selecting the small triangles next to the line numbers.
Collapse or expand your query by selecting the triangle next to the line numbers.
{: .tip}

To learn more about writing queries in OpenSearch domain-specific language (DSL), see [Query DSL]({{site.url}}{{site.baseurl}}/opensearch/query-dsl).
Expand Down Expand Up @@ -56,6 +46,7 @@ The console uses an easier syntax to format REST requests than the `curl` comman

For example, the following `curl` command runs a search query:

````
```bash
curl -XGET http://localhost:9200/shakespeare/_search?pretty -H 'Content-Type: application/json' -d'
{
Expand All @@ -66,9 +57,12 @@ curl -XGET http://localhost:9200/shakespeare/_search?pretty -H 'Content-Type: ap
}
}'
```
{% include copy.html %}
````

The same query has a simpler syntax in the console format:

````
```json
GET shakespeare/_search
{
Expand All @@ -79,6 +73,8 @@ GET shakespeare/_search
}
}
```
{% include copy-curl.html %}
````

If you paste a `curl` command directly into the console, the command is automatically converted into the format the console uses.

Expand Down
16 changes: 8 additions & 8 deletions _dashboards/discover/multi-data-sources.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ To enable multiple data sources:
2. Open your local copy of the Dashboards configuration file, `opensearch_dashboards.yml`. If you don't have a copy, [`opensearch_dashboards.yml`](https://github.com/opensearch-project/OpenSearch-Dashboards/blob/main/config/opensearch_dashboards.yml) is available on GitHub.
3. Set `data_source.enabled:` to `true` and save the YAML file.
4. Restart the Dashboards container.
5. Verify that the configuration settings were created and configured properly by connecting to Dashboards and viewing the **Stack Management** console. **Data Sources** appears in the sidebar, as shown in the following image.
5. Verify that the configuration settings were created and configured properly by connecting to Dashboards and viewing the **Dashboards Management** console. **Data Sources** appears in the sidebar, as shown in the following image.

![Data Sources navigation menu]({{site.url}}{{site.baseurl}}/images/dashboards/data-sources.png)

Expand All @@ -32,8 +32,8 @@ A data source connection specifies the parameters needed to connect to a data so
To create a new data source connection:

1. Go to [`http://localhost:5601`](http://localhost:5601/) and log in with the username `admin` and password `admin`. If you’re running the Security plugin, go to [`https://localhost:5601`](https://localhost:5601/).
2. From the OpenSearch Dashboards main menu, select **Stack Management**, **Data Sources**, and then **Create data source connection**.
3. Add information to each field to configure **Connection Details**, **Endpoint URL**, and **Authentication Method**.
2. From the OpenSearch Dashboards main menu, select **Dashboards Management** > **Data Sources** > **Create data source connection**.
3. Add information to each field to configure **Connection Details** > **Endpoint URL** > **Authentication Method**.

In the **Connection Details** window, enter a title. Entering a description is optional.

Expand Down Expand Up @@ -128,18 +128,18 @@ Selecting multiple data sources in the Dev Tools console allows you to work with

To create data visualizations for a dashboard, follow these steps:

1. In the Dashboards console, choose **Visualize** and then **Create visualization**.
1. In the Dashboards console, choose **Visualize** > **Create visualization**.
2. Select the visualization type. For this tutorial, choose **Line**.
3. Select a source. For this tutorial, choose the index pattern `opensearch_dashboards_sample_data_ecommerce`.
4. Under **Buckets**, choose **Add** and then **X-axis**.
5. In the **Aggregation** field, choose **Date Histogram** and then choose **Update**.
4. Under **Buckets**, choose **Add** > **X-axis**.
5. In the **Aggregation** field, choose **Date Histogram** > **Update**.
6. Choose **Save** and add the file name.

## Connecting visualizations in a single dashboard

To connect your visualizations in a single dashboard, follow these steps:

1. In the Dashboards console, choose **Dashboard** and then **Create dashboard**.
1. In the Dashboards console, choose **Dashboard** > **Create dashboard**.
2. Choose **Add an existing** and then select the data you want to add.
3. Choose **Save** and add the dashboard name in the **Title field**. This tutorial uses preconfigured dashboards, so you won’t be able to save your dashboard.
4. Click on the white space left of **Add panels** to view the visualizations in a single dashboard.
Expand All @@ -154,4 +154,4 @@ This feature has the following limitations:

* The multiple data sources feature is supported for index-pattern-based visualizations only.
* The visualization types Time Series Visual Builder (TSVB), Vega and Vega-Lite, and timeline are not supported.
* External plugins, such as Gantt chart, and non-visualization plugins, such as the developer console, are not supported.
* External plugins, such as Gantt chart, and non-visualization plugins, such as the developer console, are not supported.
2 changes: 1 addition & 1 deletion _dashboards/discover/time-filter.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ redirect_from:

You can change the time range to display dashboard data over minutes, hours, days, weeks, months, or years.

The default time range is **Last 15 minutes**. You can change the time range at the dashboard level or under **Stack Management > Advanced Settings > Time filter defaults**.
The default time range is **Last 15 minutes**. You can change the time range at the dashboard level or under **Dashboards Management** > **Advanced Settings** > **Time filter defaults**.
{: .note}

To change the time range at the dashboard level, perform the following steps:
Expand Down
28 changes: 26 additions & 2 deletions _dashboards/im-dashboards/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,30 @@ redirect_from:
Introduced 2.5
{: .label .label-purple }

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 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.

<img src="{{site.url}}{{site.baseurl}}/images/admin-ui-index/admin-UI-preview.gif" alt="Index management demo gif">{: .img-fluid}
## Get started with index management using Dashboards

**Step 1: Open Index Management**
Once you're in OpenSearch Dashboards, select **Index Management** under the Management 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.

**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.

**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.

**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**.

**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.

**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.

**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.
14 changes: 7 additions & 7 deletions _dashboards/im-dashboards/notifications.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ You can configure global default notification settings for index operations on t

## Configuring default notification settings

On the **Notification settings** page, you can configure the default notification settings for the following index operations that may take longer to complete:
In the **Notification settings** interface, you can configure the default notification settings for the following index operations that may take longer to complete:

- Open
- Reindex
Expand All @@ -20,22 +20,22 @@ On the **Notification settings** page, you can configure the default notificatio
- Clone
- Force merge

To get started, select **OpenSearch Plugins** > **Index Management** from the top menu. Under **Index Management**, select **Notification settings**.
To get started, under the OpenSearch Dashboards main menu, select **Management** > **Index Management**. Under **Index Management**, select **Notification settings**.

You can choose to be notified when the operation has completed or failed. Additionally, you can select the notification channels for this notification, as shown in the following image.

![Default notification settings]({{site.url}}{{site.baseurl}}/images/admin-ui-index/notifications.png)

If you don't have permission to view notification settings, you will not be able to view the default settings.
If you don't have permission to view notification settings, you cannot view the default settings.
{: .note}

## Configuring notification settings for an individual operation

You can view default notification settings when you perform an indexing operation. You can also set up additional notifications. For example, if you want to configure an additional notification for a reindex operation, perform the following steps:
You can view default notification settings when you perform an indexing operation as well as set up additional notifications. For example, if you want to configure an additional notification for a reindex operation, perform the following steps:

1. From the top menu, select **OpenSearch Plugins** > **Index Management**.
1. Select **Management** > **Index Management**.

1. Under **Index Management**, select **Indices**.
1. In the **Index Management** interface, select **Indices**.

1. Select the index you want to reindex.

Expand All @@ -54,7 +54,7 @@ You can view default notification settings when you perform an indexing operatio

1. Select a channel from the **Notification channels** dropdown list. If you want to configure a new notification channel, select **Manage channels**.

To configure a new notification channel, ensure the `dashboards-notification` plugin is enabled in OpenSearch Dashboards.
To configure a new notification channel, confirm that the `dashboards-notification` plugin is enabled in OpenSearch Dashboards.
{: .note}

1. Select the **Reindex** button.
31 changes: 14 additions & 17 deletions _dashboards/sm-dashboards.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,9 @@ redirect_from:
- /dashboards/admin-ui-index/sm-dashboards/
---

# Snapshot management
# Snapshot Management in Dashboards

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

[Snapshots]({{site.url}}{{site.baseurl}}/opensearch/snapshots/index/) are backups of a cluster’s indexes and state. The state includes cluster settings, node information, index metadata (mappings, settings, templates), and shard allocation.
[Snapshots]({{site.url}}{{site.baseurl}}/opensearch/snapshots/index/) are backups of a cluster’s 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.

Snapshots have two main uses:

Expand All @@ -22,15 +20,11 @@ Snapshots have two main uses:

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 snapshot management in OpenSearch Dashboards.

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

## Creating a repository

Before you create an SM policy, you need to set up a repository for snapshots.
Before you create an SM policy, set up a repository for snapshots.

1. On the top menu bar, go to **OpenSearch Plugins > Snapshot Management**.
1. From the OpenSearch Dashboards main menu, select **Management** > **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.
Expand All @@ -46,6 +40,9 @@ Before you create an SM policy, you need to set up a repository for snapshots.
```
1. Choose the **Add** button.

If you need to automate snapshot creation, you can use a snapshot policy.
{: .note}

## Deleting a repository

To delete a snapshot repository configuration, select the repository from the **Repositories** list and then choose the **Delete** button.
Expand All @@ -54,7 +51,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. On the top menu bar, go to **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:
Expand All @@ -80,31 +77,31 @@ 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. On the top menu bar, go to **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.
1. To edit or delete the SM policy, select the **Edit** or **Delete** button.

## Enable, disable, or delete SM policies

1. On the top menu bar, go to **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. On the top menu bar, go to **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**.

## Take a snapshot

Use the steps below to take a snapshot manually:
Follow these steps to take a snapshot manually:

1. On the top menu bar, go to **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.
Expand All @@ -125,7 +122,7 @@ The **Delete** button [deletes]({{site.url}}{{site.baseurl}}/api-reference/snaps

## Restoring a snapshot

1. On the top menu bar, go to **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:
<img src="{{site.url}}{{site.baseurl}}/images/restore-snapshot/restore-snapshot-main.png" alt="Snapshots">{: .img-fluid}
Expand Down
Loading

0 comments on commit 583eecb

Please sign in to comment.