kolchfa-aws afbfa85da1
Add index codec documentation (#4589)
* Add index codec documentation

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Fix links

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Apply suggestions from code review

Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

* Rewording and doc review comments

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

---------

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
2023-07-21 16:10:18 -04:00

1.0 KiB

layout title nav_order has_children parent redirect_from has_toc
default Snapshots 5 true Availability and recovery
/opensearch/snapshots/
/opensearch/snapshots/index/
false

Snapshots

Snapshots are backups of a cluster's indexes and state. State includes cluster settings, node information, index metadata (mappings, settings, or templates), and shard allocation.

Snapshots have two main uses:

  • Recovering from failure

    For example, if cluster health goes red, you might restore the red indexes from a snapshot.

  • 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 snapshot API.

If you need to automate snapshot creation, you can use the snapshot management feature.