[DOCS] Updates Snapshot and Restore docs (#40894)

This commit is contained in:
gchaps 2019-07-12 11:29:57 -07:00 committed by gchaps
parent 00e68eab64
commit 1f412e320c
7 changed files with 74 additions and 55 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 193 KiB

After

Width:  |  Height:  |  Size: 188 KiB

Before After
Before After

Binary file not shown.

Before

Width:  |  Height:  |  Size: 113 KiB

After

Width:  |  Height:  |  Size: 114 KiB

Before After
Before After

Binary file not shown.

After

Width:  |  Height:  |  Size: 106 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 154 KiB

After

Width:  |  Height:  |  Size: 149 KiB

Before After
Before After

Binary file not shown.

After

Width:  |  Height:  |  Size: 87 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 185 KiB

View file

@ -1,68 +1,90 @@
[role="xpack"]
[[snapshot-repositories]]
== Snapshot repositories
== Snapshot and Restore
Use *Snapshot Repositories* to store backups of your
{es} indices and clusters. Snapshots are important because they provide
a copy of your data in case something goes wrong. If you need to roll
back to an older version of your data, you can restore a snapshot from the repository.
*Snapshot and Restore* enables you to backup your {es}
indices and clusters using data and state snapshots.
Snapshots are important because they provide a copy of your data in case
something goes wrong. If you need to roll back to an older version of your data,
you can restore a snapshot from the repository.
Youll find *Snapshot and Restore* under *Management > Elasticsearch*.
With this UI, you can:
* View a list of your snapshots and drill down into details
* Register a repository for storing your snapshots
* Restore data into your cluster from a snapshot
* Delete a snapshot to free storage space
[role="screenshot"]
image:management/snapshot-restore/images/snapshot_list.png["Snapshot list"]
Before using this feature, you should be familiar with how snapshots work.
{ref}/modules-snapshots.html[Snapshot and Restore] is a good source for
more detailed information.
To get started, go to *Management > Elasticsearch > Snapshot Repositories*. You
begin with an overview of your repositories. You can then use the UI to
drill down into your repositories and snapshots.
[float]
=== Register a repository
The *Repositories* view provides an overview of your repositories. You can
drill down into each repository for further investigation.
[role="screenshot"]
image:management/snapshot-restore/images/repository_list.png["Repository list"]
[float]
=== Registering a repository
If you don't have a repository, you're prompted to register one. The
*Register repository* wizard supports three repository types
out of the box: shared file system, read-only URL, and source-only.
For details about these repositories and their settings,
see {ref}/modules-snapshots.html#_repositories[Repositories]. For an example,
see <<snapshot-repositories-example, registering a shared file system repository>>.
You must have a registry before you can save your snapshots. If you dont see a
repository in the list, navigate to *Register repository* to create one.
[role="screenshot"]
image:management/snapshot-restore/images/register_repo.png["Register repository"]
{kib} supports three types of repositories on startup:
* *Shared file system.* Uses a shared file system to store the snapshots.
* *Read-only url.* Provides a read-only alternative to access snapshot data
in another repository.
* *Source-only.* Enables storage of minimal, source-only snapshots.
A source-only repository can take up to 50% less disk space.
For more information on these repositories and the settings that you can
configure, see {ref}/modules-snapshots.html#_repositories[Repositories].
To add support for additional types, see
To use other repositories, such as S3, you can install plugins. See
{ref}/modules-snapshots.html#_repository_plugins[Repository plugins].
A best practice is to register a repository for each major version of
{es}. If you register the same snapshot repository with multiple clusters,
give only one cluster write access to the repository. All other clusters
connected to that repository should have read-only access.
[float]
=== Creating a snapshot
=== View your snapshots
Use the Kibana <<console-kibana, Console>> to create your snapshots. The
{ref}//modules-snapshots.html#_snapshot[snapshot API]
takes the current state and data in your index or cluster and saves it to a
shared repository.
The snapshot process is "smart." Your first snapshot is a complete copy of data.
All subsequent snapshots save the changes between the existing snapshots and
the new data.
For an overview of the snapshots in your cluster, go to the *Snapshots* tab in *Snapshot Repositories*.
You can then drill down into the details for each snapshot.
The *Snapshots* view gives an overview of your snapshots. You can drill down
into each snapshot for further investigation.
[role="screenshot"]
image:management/snapshot-restore/images/snapshot_details.png["Snapshot details"]
To create snapshots, use the Kibana <<console-kibana, Console>>. The
{ref}//modules-snapshots.html#_snapshot[snapshot API]
takes the current state and data in your index or cluster, and then saves it to a
shared repository.
The snapshot process is "smart." Your first snapshot is a complete copy of
the data in your index or cluster.
All subsequent snapshots save the changes between the existing snapshots and
the new data.
[float]
=== Restore a snapshot
The *Restore* wizard walks you through the process of restoring a snapshot
into a running cluster. To get started, go to the *Snapshots* view, find the
snapshot, and click the restore icon in the *Actions* column. Youre presented
options for defining the restore, including which
indices to restore and whether to modify the index settings.
To track the progress of a restore, use the *Restore Status* view. Youll
see the current state for each shard in the snapshot.
[role="screenshot"]
image:management/snapshot-restore/images/restore-status.png["Snapshot details"]
[float]
=== Delete a snapshot
Delete snapshots to manage your repository storage space.
Find the snapshot in the *Snapshots* view and click the trash icon in the
*Actions* column. To delete snapshots in bulk, select their checkboxes,
and then click *Delete snapshots*.
[[snapshot-repositories-example]]
[float]
=== Example: Register a shared file system repository
@ -84,10 +106,11 @@ your master and data nodes. You can do this in one of two ways:
[float]
==== Register the repository
Use *Snapshot Repositories* to register a repository.
Use *Snapshot and Restore* to register the repository where your snapshots
will live.
. Go to *Management > Elasticsearch > Snapshot Repositories*.
. Go to *Management > Elasticsearch > Snapshot and Restore*.
. Open the *Repositories* view.
. Click *Register a repository*.
. Enter a name for your repository. For example, `my_backup`.
. Set *Repository type* to Shared file system.
@ -103,14 +126,10 @@ image:management/snapshot-restore/images/register_repo.png["Register repository"
+
Your new repository is listed on the *Repositories* tab.
+
. Inspect the details for the repository.
. Click the respository and inspect its details.
+
The repository currently doesnt have any snapshots.
+
. Click *Verify repository* to view the repository connection status.
+
[role="screenshot"]
image:management/snapshot-restore/images/verify_repository.png["Verify repository"]
[float]
==== Add a snapshot to the repository
@ -125,9 +144,9 @@ use {ref}//date-math-index-names.html[date math expression] for the snapshot nam
[role="screenshot"]
image:management/snapshot-restore/images/create_snapshot.png["Create snapshot"]
+
. Open *Snapshot Repositories*.
. Open *Snapshot and Restore*.
+
Your new snapshot is available in the *Snapshots* tab.
Your new snapshot is available in the *Snapshots* view.