From 6138632c6f65547d3ebeded6a26f3aca5a12f8ab Mon Sep 17 00:00:00 2001 From: vagimeli Date: Mon, 30 Jan 2023 15:02:52 -0700 Subject: [PATCH] Revert "Admin UI further editorial updates (#2444)" This reverts commit 5f7e57094a404227addadeea768d7f846b194157. --- .../admin-ui-index/index-management.md | 129 +++++++++--------- _dashboards/admin-ui-index/sm-dashboards.md | 48 +++---- 2 files changed, 88 insertions(+), 89 deletions(-) diff --git a/_dashboards/admin-ui-index/index-management.md b/_dashboards/admin-ui-index/index-management.md index 965c520999..93629d2e70 100644 --- a/_dashboards/admin-ui-index/index-management.md +++ b/_dashboards/admin-ui-index/index-management.md @@ -13,28 +13,27 @@ In the **Index Management** section, you can perform the operations available in ## Index policies -[Policies]({{site.url}}{{site.baseurl}}/im-plugin/ism/policies/) are configurations that define the possible states of an index, the actions to perform when an index enters a given state, and the conditions that must be met to transition between states: +[Policies]({{site.url}}{{site.baseurl}}/im-plugin/ism/policies/) are configurations that define the possible states of an index, the actions to perform when an index enters a state, and the conditions that must be met to transition between states: 1. **States**: The possible states of an index, including the default state for new indexes. For example, you might name your states `hot`, `warm`, or `delete`. For more information, see [States]({{site.url}}{{site.baseurl}}/im-plugin/ism/policies/#states). -2. **Actions**: Any actions that you want the plugin to take when an index enters a given state, such as performing a rollover. For more information, see [Actions]({{site.url}}{{site.baseurl}}/im-plugin/ism/policies/#actions). -3. **Transitions**: The conditions that must be met for an index to move into a new state. For example, if an index is more than 8 weeks old, you might want to move it to the `delete` state. For more information, see [Transitions]({{site.url}}{{site.baseurl}}/im-plugin/ism/policies/#transitions). +2. **Actions**: Any actions that you want the plugin to take when an index enters a state, such as performing a rollover. For more information, see [Actions]({{site.url}}{{site.baseurl}}/im-plugin/ism/policies/#actions). +3. **Transitions**: The conditions that must be met for an index to move into a new state. For example, if an index is more than eight weeks old, you might want to move it to the `delete` state. For more information, see [Transitions]({{site.url}}{{site.baseurl}}/im-plugin/ism/policies/#transitions). You can also upload a JSON document to specify an index policy. {: .note} -You have complete flexibility in designing your policies. You can create any state, transition to any other state, and specify any number of actions in each state. +You have complete flexibility in the way you can design your policies. You can create any state, transition to any other state, and specify any number of actions in each state. -To attach policies to indexes, perform the following steps: +To attach policies to indices, perform the following steps: -1. Under **Index Management**, choose **Index policies**. -2. Select the index or indexes to which you want to attach your policy. +1. Under **Index Management**, select **Index policies**. +2. Choose the index or indexes to which you want to attach your policy. 3. Choose the **Apply policy** button. -4. From the **Policy ID** menu, select the policy that you created. +4. From the **Policy ID** menu, choose the policy that you created. View the preview of your policy. -5. (Optional): Specify a rollover alias if your policy includes a rollover operation. Make sure that the alias already exists. For more information about the rollover operation, see [rollover]({{site.url}}{{site.baseurl}}/im-plugin/ism/policies#rollover). +5. (Optional): Specify a rollover alias if your policy includes a rollover operation. Make sure that the alias that you enter already exists. For more information about the rollover operation, see [rollover]({{site.url}}{{site.baseurl}}/im-plugin/ism/policies#rollover). 6. Choose the **Apply** button. - -After you attach a policy to an index, Index State Management (ISM) creates a job that runs every 5 minutes by default to perform policy actions, check conditions, and transition the index into different states. To change the default time interval for this job, see [Settings]({{site.url}}{{site.baseurl}}/im-plugin/ism/settings/). +After you attach a policy to an index, ISM creates a job that runs every 5 minutes by default to perform policy actions, check conditions, and transition the index into different states. To change the default time interval for this job, see Settings. Policy jobs don't run if the cluster state is red. {: .note} @@ -43,14 +42,14 @@ Policy jobs don't run if the cluster state is red. To attach policies to indexes, perform the following steps: -1. Under **Index Management**, choose **Manage Indices**. -2. Select the index or indexes to which you want to attach your policy. -3. Choose the **Change policy** button. +1. Under **Index Management**, select **Manage Indices**. +2. Choose the index or indexes to which you want to attach your policy. +3. Select the **Change policy** button. 4. Choose the **Apply policy** button. ## Indexes -The **Indices** section displays a list of indexes in your OpenSearch cluster. For each index, you can see its health status (`green`, `yellow`, or `red`), policy (if the index is managed by a policy), status, total size, primary sizes, 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. The following are the three index health statuses: @@ -58,7 +57,7 @@ The following are the three index health statuses: - Yellow: At least one replica shard is not assigned. - Red: At least one primary shard is not assigned. -### Creating an index +### 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. @@ -71,73 +70,73 @@ To create an index, select the **Create Index** button located under the **Indic You can also add fields and objects using either the visual editor or the JSON editor. -The **Advanced settings** allow you to upload a JSON configuration. +**Advanced settings** allows you to upload a JSON configuration. -### Applying a 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. +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. -[ISM]({{site.url}}{{site.baseurl}}/im-plugin/ism/index/) 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. +[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. You might want to perform an index rollover after a certain amount of time or run a **force_merge** operation on an index during off-peak hours to improve search performance during peak hours. -To apply a policy, select the index to which you want to apply the policy from the **Indices** list under **Index Management**. Then select the **Actions** button and select **Apply policy** from the dropdown list as shown in the following image. +To apply a policy, select the index to which you want to apply the policy in the **Indices** list under **Index Management**. Then select the **Actions** button, and select **Apply policy** from the dropdown list. User interface showing apply policy prompt -### Closing an index +### 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 from the **Indices** list under **Index Management**. Then select the **Actions** button and select **Close** from the dropdown list. +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. -### Opening an index +### Open index -The [open index]({{site.url}}{{site.baseurl}}/api-reference/index-apis/open-index/) operation opens a closed index, letting you add data to it or search for data within the 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 from the **Indices** list under **Index Management**. Then select the **Actions** button and select **Open** from the dropdown list. +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. -### Reindexing an index +### Reindex -The [reindex]({{site.url}}{{site.baseurl}}/api-reference/document-apis/reindex/) operation lets you copy all of your data or a subset of data from a source index into a destination index. +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 from the **Indices** list under **Index Management**. Then select the **Actions** button and select **Reindex** from the dropdown list as shown in the following image. +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. User interface showing reindex prompt -### Shrinking an index +### Shrink index 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 from the **Indices** list under **Index Management**. Then choose the **Actions** button and choose **Shrink** from the dropdown list as shown in the following image. +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. User interface showing shrink prompt -### Splitting an index +### 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 from the **Indices** list under **Index Management**. Then choose the **Actions** button and choose **Split** from the dropdown list as shown in the following image. +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. User interface showing split page -### Deleting an index +### 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. -To delete an index, select the index you want to delete from the **Indices** list under **Index Management**. Then select the **Actions** button and select **Delete** from the dropdown list. +To delete an index, select the index you want to delete in the **Indices** list under **Index Management**. Then select the **Actions** button, and select **Delete** from the dropdown list. ## Templates -[Index templates]({{site.url}}{{site.baseurl}}/opensearch/index-templates/) let you initialize new indexes with predefined mappings and settings. For example, if you continuously index log data, you can define an index template so that all of the indexes have the same number of shards and replicas as shown in the following image. +[Index templates]({{site.url}}{{site.baseurl}}/opensearch/index-templates/) let you initialize new indexes with predefined mappings and settings. For example, if you continuously index log data, you can define an index template so that all of these indexes have the same number of shards and replicas. User interface showing Templates page ### Creating a template -To create a template, choose the **Create template** button on the **Templates** page under **Index Management**. +To create a template, select the **Create template** button on the **Templates** page under **Index Management**. Next, define the template: @@ -150,7 +149,7 @@ Next, define the template: 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 as shown in the following image. +1. Under **Advanced Settings** you can specify advanced index settings with a comma-delimited list. User interface showing Create Template page @@ -164,30 +163,30 @@ To delete a template, select the template you want to delete from the list of te ## 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 as shown in the following image. +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. User interface showing Alias page To create an alias, perform the following steps: -1. Choose the **Create Alias** button on the **Aliases** page under **Index Management**. +1. Select the **Create Alias** button on the **Aliases** page under **Index Management**. 2. Specify the alias name. -3. Enter the index, or index patterns, to be included in the alias. -4. Choose **Create alias** as shown in the following image. +3. Enter the index, or index patterns, to be part of the alias. +4. Select **Create alias**. User interface showing creat Alias page To edit an alias, perform the following steps: 1. Select the alias you want to edit. -2. Choose the **Actions** button. -3. Choose **Edit** from the dropdown list. +2. Select the **Actions** button. +3. Select **Edit** from the dropdown list. To delete an alias, perform the following steps: 1. Select the alias you want to edit. -2. Choose the **Actions** button. -3. Choose **Delete** from the dropdown list. +2. Select the **Actions** button. +3. Select **Delete** from the dropdown list. ## Rollup jobs @@ -195,19 +194,19 @@ The **Rollup Jobs** section under **Index Management** allows you to create or u To create a rollup job, perform the following steps: -1. Choose the **Create rollup job** button on the **Rollup Jobs** page under **Index Management**. +1. Select the **Create rollup job** button on the **Rollup Jobs** page under **Index Management**. 2. Set the name, source index, and target index. -3. Choose **Next**. +3. Select **Next**. 4. Set the timestamp field and interval type. -5. Optionally, set additional aggregations and metrics. -6. Choose **Next**. +5. Optionally, set additional aggregations and additional metrics. +6. Select **Next**. 7. Under **Schedule**, check or uncheck **Enable job by default**. 8. Set the **Continuous**, **Execution frequency**, **Rollup interval**, and **Pages per execution** settings. 9. Additionally, you can set an execution delay. -10. Choose **Next**. -11. Review the settings for the rollup job and choose **Create**. +10. Select **Next**. +11. Review the settings for the rollup job and select **Create**. -You can also enable and disable rollup jobs by choosing the corresponding buttons on the **Rollup Jobs** page. +You can also disable and enable rollup jobs by selecting the corresponding buttons on the **Rollup Jobs** page. ## Transform jobs @@ -215,28 +214,28 @@ You can create, start, stop, and complete operations with [transform]({{site.url To create a transform job, perform the following steps: -1. Choose the **Create transform job** button on the **Transform Jobs** page under **Index Management**. +1. Select the **Create transform job** button on the **Transform Jobs** page under **Index Management**. 2. Set the name, source index, and target index. -3. Choose **Next**. -4. Select the fields to transform. From the table, select a field you want to transform by choosing **+** next to the field name. -5. Choose **Next**. +3. Select **Next**. +4. Select the fields to transform. From the table above, select a field you want to transform by clicking **+** next to the field name. +5. Select **Next**. 6. Check or uncheck **Job enabled by default**. -7. Set the transform execution interval and whether the schedule is continuous. +7. Set whether the schedule is continuous and the transform execution interval. 8. Optionally, set pages per execution under the **Advanced** dropdown list. -9. Choose **Next**. -10. Review the settings for the rollup job and choose **Create**. +9. Select **Next**. +10. Review the settings for the rollup job and select **Create**. -You can also enable and disable rollup jobs by choosing the corresponding buttons on the **Transform Jobs** page. +You can also disable and enable rollup jobs by selecting the corresponding buttons on the **Transform Jobs** page. -## Long-running operation status check +## Long running operation status check -Certain index operations take additional time to complete (usually more than 30 seconds, but up to tens of minutes or hours). This is tracked in the index status column on the **Indices** page. +Certain index operations take time to complete (usually more than 30 seconds, up to tens of minutes or hours). This is tracked on the index status on **Indices** page. -You can check the status of the reindex, shrink, and split operations because they are one-time, non-recursive operations. +You can check the status of the reindex, shrink, and split operations because they are one-time non-recursive operations. ## Security integration - Permission control is managed with existing [permissions]({{site.url}}{{site.baseurl}}/security-plugin/access-control/permissions/) or action groups that are enforced at the API level. There is currently no UI-level permission control. Users with permission to access the ISM plugin are able to view new pages. They can also make changes if they have permission to run the related APIs. + Permission control is managed with existing [permissions]({{site.url}}{{site.baseurl}}/security-plugin/access-control/permissions/) or action groups that are enforced at the API level. There is currently no UI-level permission control. Users with permissions to access the ISM plugin are able to view new pages. They can also make changes if they have permissions to run the related APIs. ## Error handling diff --git a/_dashboards/admin-ui-index/sm-dashboards.md b/_dashboards/admin-ui-index/sm-dashboards.md index 800008c862..0ada643ae0 100644 --- a/_dashboards/admin-ui-index/sm-dashboards.md +++ b/_dashboards/admin-ui-index/sm-dashboards.md @@ -9,7 +9,7 @@ nav_order: 17 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, etc.), and shard allocation. Snapshots have two main uses: @@ -19,37 +19,37 @@ Snapshots have two main uses: 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 snapshot management in OpenSearch Dashboards. -If you need to automate snapshots creation, you can use a snapshot policy. +If you need to automate taking snapshots, you can use a snapshot policy. -## Creating a repository +## Create a repository Before you create an SM policy, you need to set up a repository for snapshots. 1. On the top menu bar, go to **OpenSearch Plugins > Snapshot Management**. 1. In the left panel, under **Snapshot Management**, select **Repositories**. -1. Choose the **Create Repository** button. +1. Select 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 - { - "chunk_size": null, - "compress": false, - "max_restore_bytes_per_sec": "40m", - "max_snapshot_bytes_per_sec": "40m", - "readonly": false - } - ``` -1. Choose the **Add** button. +```json +{ + "chunk_size": null, + "compress": false, + "max_restore_bytes_per_sec": "40m", + "max_snapshot_bytes_per_sec": "40m", + "readonly": false +} +``` +1. Select the **Add** button. -## Deleting a repository +#### Delete a repository -To delete a snapshot repository configuration, select the repository from the **Repositories** list and then choose the **Delete** button. +To delete a snapshot repository configuration, select the repository in the **Repositories** list, then select the **Delete** button. -## Creating an SM policy +## Create an SM policy Create an SM policy to set up automatic snapshots. An SM policy defines an automated snapshot creation schedule and an optional automated deletion schedule. @@ -113,16 +113,16 @@ Use the steps below to take a snapshot manually: - **Include cluster state in snapshots** - **Ignore unavailable indices** - **Allow partial snapshots** -1. Choose the **Add** button. +1. Select the **Add** button. -## Deleting a snapshot +## Delete a snapshot The **Delete** button [deletes]({{site.url}}{{site.baseurl}}/api-reference/snapshots/delete-snapshot/) a snapshot from a repository. -1. To view a list of your repositories, choose **Repositories** under the **Snapshot Management** section. -2. To view a list of your snapshots, choose **Snapshots** under the **Snapshot Management** section. +1. To view a list of your repositories, select **Repositories** under the **Snapshot Management** section. +2. To view a list of your snapshots, select **Snapshots** under the **Snapshot Management** section. -## Restoring a snapshot +## Restore a snapshot 1. On the top menu bar, go to **OpenSearch Plugins > Snapshot Management**. 1. In the left panel, under **Snapshot Management**, select **Snapshots**. The **Snapshots** tab is selected by default. @@ -170,7 +170,7 @@ The **Delete** button [deletes]({{site.url}}{{site.baseurl}}/api-reference/snaps Restore Indices{: .img-fluid} - 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**, choose **Indices**. + 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**. View Indices{: .img-fluid} \ No newline at end of file