Skip to content

Commit

Permalink
Revert "Adds documentation for Admin UI index operations (#2403)"
Browse files Browse the repository at this point in the history
This reverts commit b5e4383.
  • Loading branch information
vagimeli committed Jan 26, 2023
1 parent 22e1f90 commit 689a01f
Show file tree
Hide file tree
Showing 15 changed files with 5 additions and 272 deletions.
225 changes: 0 additions & 225 deletions _dashboards/admin-ui-index/index-management.md

This file was deleted.

16 changes: 0 additions & 16 deletions _dashboards/admin-ui-index/index.md

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,30 +1,15 @@
---
layout: default
title: Using Snapshot Management in OpenSearch Dashboards
parent: Admin UI for index operations in OpenSearch Dashboards
nav_order: 30
title: Snapshot Management in OpenSearch Dashboards
parent: Snapshots
nav_order: 35
has_children: false
---

# Using Snapshot Management in OpenSearch 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, etc.), and shard allocation.

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.

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.

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

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

## Create a repository

Before you create an SM policy, you need to set up a repository for snapshots.
Expand All @@ -45,10 +30,6 @@ Before you create an SM policy, you need to set up a repository for snapshots.
```
1. Select the **Add** button.

#### Delete a repository

To delete a snapshot repository configuration, select the repository in the **Repositories** list, then select the **Delete** button.

## 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.
Expand Down Expand Up @@ -115,13 +96,6 @@ Use the steps below to take a snapshot manually:
- **Allow partial snapshots**
1. Select the **Add** button.

## 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, select **Repositories** under the **Snapshot Management** section.
2. To view a list of your snapshots, select **Snapshots** under the **Snapshot Management** section.

## Restore a snapshot

1. On the top menu bar, go to **OpenSearch Plugins > Snapshot Management**.
Expand Down Expand Up @@ -172,4 +146,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}
<img src="{{site.url}}{{site.baseurl}}/images/restore-snapshot/restore-snapshot-indices-panel.png" alt="View Indices">{: .img-fluid}
Binary file removed images/admin-ui-index/aliases.PNG
Binary file not shown.
Binary file removed images/admin-ui-index/apply-policy.PNG
Binary file not shown.
Binary file removed images/admin-ui-index/create-alias.PNG
Binary file not shown.
Binary file removed images/admin-ui-index/create-template-expanded.png
Binary file not shown.
Binary file removed images/admin-ui-index/create-template.png
Binary file not shown.
Binary file removed images/admin-ui-index/reindex-expanded.png
Binary file not shown.
Binary file removed images/admin-ui-index/reindex.png
Binary file not shown.
Binary file removed images/admin-ui-index/shrink.png
Binary file not shown.
Binary file removed images/admin-ui-index/split-expanded.png
Binary file not shown.
Binary file removed images/admin-ui-index/split.png
Binary file not shown.
Binary file removed images/admin-ui-index/templates.PNG
Binary file not shown.
Binary file removed images/admin-ui-index/view-template.png
Binary file not shown.

0 comments on commit 689a01f

Please sign in to comment.