snapshots.asciidoc 32 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763
  1. [[modules-snapshots]]
  2. == Snapshot And Restore
  3. A snapshot is a backup taken from a running Elasticsearch cluster. You can take
  4. a snapshot of individual indices or of the entire cluster and store it in a
  5. repository on a shared filesystem, and there are plugins that support remote
  6. repositories on S3, HDFS, Azure, Google Cloud Storage and more.
  7. Snapshots are taken incrementally. This means that when creating a snapshot of
  8. an index Elasticsearch will avoid copying any data that is already stored in
  9. the repository as part of an earlier snapshot of the same index. Therefore it
  10. can be efficient to take snapshots of your cluster quite frequently.
  11. Snapshots can be restored into a running cluster via the restore API. When
  12. restoring an index it is possible to alter the name of the restored index as
  13. well as some of its settings, allowing a great deal of flexibility in how the
  14. snapshot and restore functionality can be used.
  15. WARNING: It is not possible to back up an Elasticsearch cluster simply by
  16. taking a copy of the data directories of all of its nodes. Elasticsearch may be
  17. making changes to the contents of its data directories while it is running, and
  18. this means that copying its data directories cannot be expected to capture a
  19. consistent picture of their contents. Attempts to restore a cluster from such a
  20. backup may fail, reporting corruption and/or missing files, or may appear to
  21. have succeeded having silently lost some of its data. The only reliable way to
  22. back up a cluster is by using the snapshot and restore functionality.
  23. [float]
  24. === Version compatibility
  25. A snapshot contains a copy of the on-disk data structures that make up an
  26. index. This means that snapshots can only be restored to versions of
  27. Elasticsearch that can read the indices:
  28. * A snapshot of an index created in 5.x can be restored to 6.x.
  29. * A snapshot of an index created in 2.x can be restored to 5.x.
  30. * A snapshot of an index created in 1.x can be restored to 2.x.
  31. Conversely, snapshots of indices created in 1.x **cannot** be restored to 5.x
  32. or 6.x, and snapshots of indices created in 2.x **cannot** be restored to 6.x.
  33. Each snapshot can contain indices created in various versions of Elasticsearch,
  34. and when restoring a snapshot it must be possible to restore all of the indices
  35. into the target cluster. If any indices in a snapshot were created in an
  36. incompatible version, you will not be able restore the snapshot.
  37. IMPORTANT: When backing up your data prior to an upgrade, keep in mind that you
  38. won't be able to restore snapshots after you upgrade if they contain indices
  39. created in a version that's incompatible with the upgrade version.
  40. If you end up in a situation where you need to restore a snapshot of an index
  41. that is incompatible with the version of the cluster you are currently running,
  42. you can restore it on the latest compatible version and use
  43. <<reindex-from-remote,reindex-from-remote>> to rebuild the index on the current
  44. version. Reindexing from remote is only possible if the original index has
  45. source enabled. Retrieving and reindexing the data can take significantly
  46. longer than simply restoring a snapshot. If you have a large amount of data, we
  47. recommend testing the reindex from remote process with a subset of your data to
  48. understand the time requirements before proceeding.
  49. [float]
  50. === Repositories
  51. You must register a snapshot repository before you can perform snapshot and
  52. restore operations. We recommend creating a new snapshot repository for each
  53. major version. The valid repository settings depend on the repository type.
  54. If you register same snapshot repository with multiple clusters, only
  55. one cluster should have write access to the repository. All other clusters
  56. connected to that repository should set the repository to `readonly` mode.
  57. IMPORTANT: The snapshot format can change across major versions, so if you have
  58. clusters on different versions trying to write the same repository, snapshots
  59. written by one version may not be visible to the other and the repository could
  60. be corrupted. While setting the repository to `readonly` on all but one of the
  61. clusters should work with multiple clusters differing by one major version, it
  62. is not a supported configuration.
  63. [source,js]
  64. -----------------------------------
  65. PUT /_snapshot/my_backup
  66. {
  67. "type": "fs",
  68. "settings": {
  69. "location": "my_backup_location"
  70. }
  71. }
  72. -----------------------------------
  73. // CONSOLE
  74. // TESTSETUP
  75. To retrieve information about a registered repository, use a GET request:
  76. [source,js]
  77. -----------------------------------
  78. GET /_snapshot/my_backup
  79. -----------------------------------
  80. // CONSOLE
  81. which returns:
  82. [source,js]
  83. -----------------------------------
  84. {
  85. "my_backup": {
  86. "type": "fs",
  87. "settings": {
  88. "location": "my_backup_location"
  89. }
  90. }
  91. }
  92. -----------------------------------
  93. // TESTRESPONSE
  94. To retrieve information about multiple repositories, specify a
  95. a comma-delimited list of repositories. You can also use the * wildcard when
  96. specifying repository names. For example, the following request retrieves
  97. information about all of the snapshot repositories that start with `repo` or
  98. contain `backup`:
  99. [source,js]
  100. -----------------------------------
  101. GET /_snapshot/repo*,*backup*
  102. -----------------------------------
  103. // CONSOLE
  104. To retrieve information about all registered snapshot repositories, omit the
  105. repository name or specify `_all`:
  106. [source,js]
  107. -----------------------------------
  108. GET /_snapshot
  109. -----------------------------------
  110. // CONSOLE
  111. or
  112. [source,js]
  113. -----------------------------------
  114. GET /_snapshot/_all
  115. -----------------------------------
  116. // CONSOLE
  117. [float]
  118. ===== Shared File System Repository
  119. The shared file system repository (`"type": "fs"`) uses the shared file system to store snapshots. In order to register
  120. the shared file system repository it is necessary to mount the same shared filesystem to the same location on all
  121. master and data nodes. This location (or one of its parent directories) must be registered in the `path.repo`
  122. setting on all master and data nodes.
  123. Assuming that the shared filesystem is mounted to `/mount/backups/my_fs_backup_location`, the following setting should
  124. be added to `elasticsearch.yml` file:
  125. [source,yaml]
  126. --------------
  127. path.repo: ["/mount/backups", "/mount/longterm_backups"]
  128. --------------
  129. The `path.repo` setting supports Microsoft Windows UNC paths as long as at least server name and share are specified as
  130. a prefix and back slashes are properly escaped:
  131. [source,yaml]
  132. --------------
  133. path.repo: ["\\\\MY_SERVER\\Snapshots"]
  134. --------------
  135. After all nodes are restarted, the following command can be used to register the shared file system repository with
  136. the name `my_fs_backup`:
  137. [source,js]
  138. -----------------------------------
  139. PUT /_snapshot/my_fs_backup
  140. {
  141. "type": "fs",
  142. "settings": {
  143. "location": "/mount/backups/my_fs_backup_location",
  144. "compress": true
  145. }
  146. }
  147. -----------------------------------
  148. // CONSOLE
  149. // TEST[skip:no access to absolute path]
  150. If the repository location is specified as a relative path this path will be resolved against the first path specified
  151. in `path.repo`:
  152. [source,js]
  153. -----------------------------------
  154. PUT /_snapshot/my_fs_backup
  155. {
  156. "type": "fs",
  157. "settings": {
  158. "location": "my_fs_backup_location",
  159. "compress": true
  160. }
  161. }
  162. -----------------------------------
  163. // CONSOLE
  164. // TEST[continued]
  165. The following settings are supported:
  166. [horizontal]
  167. `location`:: Location of the snapshots. Mandatory.
  168. `compress`:: Turns on compression of the snapshot files. Compression is applied only to metadata files (index mapping and settings). Data files are not compressed. Defaults to `true`.
  169. `chunk_size`:: Big files can be broken down into chunks during snapshotting if needed. The chunk size can be specified in bytes or by
  170. using size value notation, i.e. 1g, 10m, 5k. Defaults to `null` (unlimited chunk size).
  171. `max_restore_bytes_per_sec`:: Throttles per node restore rate. Defaults to `40mb` per second.
  172. `max_snapshot_bytes_per_sec`:: Throttles per node snapshot rate. Defaults to `40mb` per second.
  173. `readonly`:: Makes repository read-only. Defaults to `false`.
  174. [float]
  175. ===== Read-only URL Repository
  176. The URL repository (`"type": "url"`) can be used as an alternative read-only way to access data created by the shared file
  177. system repository. The URL specified in the `url` parameter should point to the root of the shared filesystem repository.
  178. The following settings are supported:
  179. [horizontal]
  180. `url`:: Location of the snapshots. Mandatory.
  181. URL Repository supports the following protocols: "http", "https", "ftp", "file" and "jar". URL repositories with `http:`,
  182. `https:`, and `ftp:` URLs has to be whitelisted by specifying allowed URLs in the `repositories.url.allowed_urls` setting.
  183. This setting supports wildcards in the place of host, path, query, and fragment. For example:
  184. [source,yaml]
  185. -----------------------------------
  186. repositories.url.allowed_urls: ["http://www.example.org/root/*", "https://*.mydomain.com/*?*#*"]
  187. -----------------------------------
  188. URL repositories with `file:` URLs can only point to locations registered in the `path.repo` setting similar to
  189. shared file system repository.
  190. [float]
  191. [role="xpack"]
  192. [testenv="basic"]
  193. ===== Source Only Repository
  194. A source repository enables you to create minimal, source-only snapshots that take up to 50% less space on disk.
  195. Source only snapshots contain stored fields and index metadata. They do not include index or doc values structures
  196. and are not searchable when restored. After restoring a source-only snapshot, you must <<docs-reindex,reindex>>
  197. the data into a new index.
  198. Source repositories delegate to another snapshot repository for storage.
  199. [IMPORTANT]
  200. ==================================================
  201. Source only snapshots are only supported if the `_source` field is enabled and no source-filtering is applied.
  202. When you restore a source only snapshot:
  203. * The restored index is read-only and can only serve `match_all` search or scroll requests to enable reindexing.
  204. * Queries other than `match_all` and `_get` requests are not supported.
  205. * The mapping of the restored index is empty, but the original mapping is available from the types top
  206. level `meta` element.
  207. ==================================================
  208. When you create a source repository, you must specify the type and name of the delegate repository
  209. where the snapshots will be stored:
  210. [source,js]
  211. -----------------------------------
  212. PUT _snapshot/my_src_only_repository
  213. {
  214. "type": "source",
  215. "settings": {
  216. "delegate_type": "fs",
  217. "location": "my_backup_location"
  218. }
  219. }
  220. -----------------------------------
  221. // CONSOLE
  222. // TEST[continued]
  223. [float]
  224. ===== Repository plugins
  225. Other repository backends are available in these official plugins:
  226. * {plugins}/repository-s3.html[repository-s3] for S3 repository support
  227. * {plugins}/repository-hdfs.html[repository-hdfs] for HDFS repository support in Hadoop environments
  228. * {plugins}/repository-azure.html[repository-azure] for Azure storage repositories
  229. * {plugins}/repository-gcs.html[repository-gcs] for Google Cloud Storage repositories
  230. [float]
  231. ===== Repository Verification
  232. When a repository is registered, it's immediately verified on all master and data nodes to make sure that it is functional
  233. on all nodes currently present in the cluster. The `verify` parameter can be used to explicitly disable the repository
  234. verification when registering or updating a repository:
  235. [source,js]
  236. -----------------------------------
  237. PUT /_snapshot/my_unverified_backup?verify=false
  238. {
  239. "type": "fs",
  240. "settings": {
  241. "location": "my_unverified_backup_location"
  242. }
  243. }
  244. -----------------------------------
  245. // CONSOLE
  246. // TEST[continued]
  247. The verification process can also be executed manually by running the following command:
  248. [source,js]
  249. -----------------------------------
  250. POST /_snapshot/my_unverified_backup/_verify
  251. -----------------------------------
  252. // CONSOLE
  253. // TEST[continued]
  254. It returns a list of nodes where repository was successfully verified or an error message if verification process failed.
  255. [float]
  256. === Snapshot
  257. A repository can contain multiple snapshots of the same cluster. Snapshots are identified by unique names within the
  258. cluster. A snapshot with the name `snapshot_1` in the repository `my_backup` can be created by executing the following
  259. command:
  260. [source,js]
  261. -----------------------------------
  262. PUT /_snapshot/my_backup/snapshot_1?wait_for_completion=true
  263. -----------------------------------
  264. // CONSOLE
  265. // TEST[continued]
  266. The `wait_for_completion` parameter specifies whether or not the request should return immediately after snapshot
  267. initialization (default) or wait for snapshot completion. During snapshot initialization, information about all
  268. previous snapshots is loaded into the memory, which means that in large repositories it may take several seconds (or
  269. even minutes) for this command to return even if the `wait_for_completion` parameter is set to `false`.
  270. By default a snapshot of all open and started indices in the cluster is created. This behavior can be changed by
  271. specifying the list of indices in the body of the snapshot request.
  272. [source,js]
  273. -----------------------------------
  274. PUT /_snapshot/my_backup/snapshot_2?wait_for_completion=true
  275. {
  276. "indices": "index_1,index_2",
  277. "ignore_unavailable": true,
  278. "include_global_state": false
  279. }
  280. -----------------------------------
  281. // CONSOLE
  282. // TEST[continued]
  283. The list of indices that should be included into the snapshot can be specified using the `indices` parameter that
  284. supports <<multi-index,multi index syntax>>. The snapshot request also supports the
  285. `ignore_unavailable` option. Setting it to `true` will cause indices that do not exist to be ignored during snapshot
  286. creation. By default, when `ignore_unavailable` option is not set and an index is missing the snapshot request will fail.
  287. By setting `include_global_state` to false it's possible to prevent the cluster global state to be stored as part of
  288. the snapshot. By default, the entire snapshot will fail if one or more indices participating in the snapshot don't have
  289. all primary shards available. This behaviour can be changed by setting `partial` to `true`.
  290. Snapshot names can be automatically derived using <<date-math-index-names,date math expressions>>, similarly as when creating
  291. new indices. Note that special characters need to be URI encoded.
  292. For example, creating a snapshot with the current day in the name, like `snapshot-2018.05.11`, can be achieved with
  293. the following command:
  294. [source,js]
  295. -----------------------------------
  296. # PUT /_snapshot/my_backup/<snapshot-{now/d}>
  297. PUT /_snapshot/my_backup/%3Csnapshot-%7Bnow%2Fd%7D%3E
  298. -----------------------------------
  299. // CONSOLE
  300. // TEST[continued]
  301. The index snapshot process is incremental. In the process of making the index snapshot Elasticsearch analyses
  302. the list of the index files that are already stored in the repository and copies only files that were created or
  303. changed since the last snapshot. That allows multiple snapshots to be preserved in the repository in a compact form.
  304. Snapshotting process is executed in non-blocking fashion. All indexing and searching operation can continue to be
  305. executed against the index that is being snapshotted. However, a snapshot represents the point-in-time view of the index
  306. at the moment when snapshot was created, so no records that were added to the index after the snapshot process was started
  307. will be present in the snapshot. The snapshot process starts immediately for the primary shards that has been started
  308. and are not relocating at the moment. Before version 1.2.0, the snapshot operation fails if the cluster has any relocating or
  309. initializing primaries of indices participating in the snapshot. Starting with version 1.2.0, Elasticsearch waits for
  310. relocation or initialization of shards to complete before snapshotting them.
  311. Besides creating a copy of each index the snapshot process can also store global cluster metadata, which includes persistent
  312. cluster settings and templates. The transient settings and registered snapshot repositories are not stored as part of
  313. the snapshot.
  314. Only one snapshot process can be executed in the cluster at any time. While snapshot of a particular shard is being
  315. created this shard cannot be moved to another node, which can interfere with rebalancing process and allocation
  316. filtering. Elasticsearch will only be able to move a shard to another node (according to the current allocation
  317. filtering settings and rebalancing algorithm) once the snapshot is finished.
  318. Once a snapshot is created information about this snapshot can be obtained using the following command:
  319. [source,sh]
  320. -----------------------------------
  321. GET /_snapshot/my_backup/snapshot_1
  322. -----------------------------------
  323. // CONSOLE
  324. // TEST[continued]
  325. This command returns basic information about the snapshot including start and end time, version of
  326. Elasticsearch that created the snapshot, the list of included indices, the current state of the
  327. snapshot and the list of failures that occurred during the snapshot. The snapshot `state` can be
  328. [horizontal]
  329. `IN_PROGRESS`::
  330. The snapshot is currently running.
  331. `SUCCESS`::
  332. The snapshot finished and all shards were stored successfully.
  333. `FAILED`::
  334. The snapshot finished with an error and failed to store any data.
  335. `PARTIAL`::
  336. The global cluster state was stored, but data of at least one shard wasn't stored successfully.
  337. The `failure` section in this case should contain more detailed information about shards
  338. that were not processed correctly.
  339. `INCOMPATIBLE`::
  340. The snapshot was created with an old version of Elasticsearch and therefore is incompatible with
  341. the current version of the cluster.
  342. Similar as for repositories, information about multiple snapshots can be queried in one go, supporting wildcards as well:
  343. [source,sh]
  344. -----------------------------------
  345. GET /_snapshot/my_backup/snapshot_*,some_other_snapshot
  346. -----------------------------------
  347. // CONSOLE
  348. // TEST[continued]
  349. All snapshots currently stored in the repository can be listed using the following command:
  350. [source,sh]
  351. -----------------------------------
  352. GET /_snapshot/my_backup/_all
  353. -----------------------------------
  354. // CONSOLE
  355. // TEST[continued]
  356. The command fails if some of the snapshots are unavailable. The boolean parameter `ignore_unavailable` can be used to
  357. return all snapshots that are currently available.
  358. Getting all snapshots in the repository can be costly on cloud-based repositories,
  359. both from a cost and performance perspective. If the only information required is
  360. the snapshot names/uuids in the repository and the indices in each snapshot, then
  361. the optional boolean parameter `verbose` can be set to `false` to execute a more
  362. performant and cost-effective retrieval of the snapshots in the repository. Note
  363. that setting `verbose` to `false` will omit all other information about the snapshot
  364. such as status information, the number of snapshotted shards, etc. The default
  365. value of the `verbose` parameter is `true`.
  366. A currently running snapshot can be retrieved using the following command:
  367. [source,sh]
  368. -----------------------------------
  369. GET /_snapshot/my_backup/_current
  370. -----------------------------------
  371. // CONSOLE
  372. // TEST[continued]
  373. A snapshot can be deleted from the repository using the following command:
  374. [source,sh]
  375. -----------------------------------
  376. DELETE /_snapshot/my_backup/snapshot_2
  377. -----------------------------------
  378. // CONSOLE
  379. // TEST[continued]
  380. When a snapshot is deleted from a repository, Elasticsearch deletes all files that are associated with the deleted
  381. snapshot and not used by any other snapshots. If the deleted snapshot operation is executed while the snapshot is being
  382. created the snapshotting process will be aborted and all files created as part of the snapshotting process will be
  383. cleaned. Therefore, the delete snapshot operation can be used to cancel long running snapshot operations that were
  384. started by mistake.
  385. A repository can be unregistered using the following command:
  386. [source,sh]
  387. -----------------------------------
  388. DELETE /_snapshot/my_backup
  389. -----------------------------------
  390. // CONSOLE
  391. // TEST[continued]
  392. When a repository is unregistered, Elasticsearch only removes the reference to the location where the repository is storing
  393. the snapshots. The snapshots themselves are left untouched and in place.
  394. [float]
  395. === Restore
  396. A snapshot can be restored using the following command:
  397. [source,sh]
  398. -----------------------------------
  399. POST /_snapshot/my_backup/snapshot_1/_restore
  400. -----------------------------------
  401. // CONSOLE
  402. // TEST[continued]
  403. By default, all indices in the snapshot are restored, and the cluster state is
  404. *not* restored. It's possible to select indices that should be restored as well
  405. as to allow the global cluster state from being restored by using `indices` and
  406. `include_global_state` options in the restore request body. The list of indices
  407. supports <<multi-index,multi index syntax>>. The `rename_pattern`
  408. and `rename_replacement` options can be also used to rename indices on restore
  409. using regular expression that supports referencing the original text as
  410. explained
  411. http://docs.oracle.com/javase/6/docs/api/java/util/regex/Matcher.html#appendReplacement(java.lang.StringBuffer,%20java.lang.String)[here].
  412. Set `include_aliases` to `false` to prevent aliases from being restored together
  413. with associated indices
  414. [source,js]
  415. -----------------------------------
  416. POST /_snapshot/my_backup/snapshot_1/_restore
  417. {
  418. "indices": "index_1,index_2",
  419. "ignore_unavailable": true,
  420. "include_global_state": true,
  421. "rename_pattern": "index_(.+)",
  422. "rename_replacement": "restored_index_$1"
  423. }
  424. -----------------------------------
  425. // CONSOLE
  426. // TEST[continued]
  427. The restore operation can be performed on a functioning cluster. However, an
  428. existing index can be only restored if it's <<indices-open-close,closed>> and
  429. has the same number of shards as the index in the snapshot. The restore
  430. operation automatically opens restored indices if they were closed and creates
  431. new indices if they didn't exist in the cluster. If cluster state is restored
  432. with `include_global_state` (defaults to `false`), the restored templates that
  433. don't currently exist in the cluster are added and existing templates with the
  434. same name are replaced by the restored templates. The restored persistent
  435. settings are added to the existing persistent settings.
  436. [float]
  437. ==== Partial restore
  438. By default, the entire restore operation will fail if one or more indices participating in the operation don't have
  439. snapshots of all shards available. It can occur if some shards failed to snapshot for example. It is still possible to
  440. restore such indices by setting `partial` to `true`. Please note, that only successfully snapshotted shards will be
  441. restored in this case and all missing shards will be recreated empty.
  442. [float]
  443. ==== Changing index settings during restore
  444. Most of index settings can be overridden during the restore process. For example, the following command will restore
  445. the index `index_1` without creating any replicas while switching back to default refresh interval:
  446. [source,js]
  447. -----------------------------------
  448. POST /_snapshot/my_backup/snapshot_1/_restore
  449. {
  450. "indices": "index_1",
  451. "index_settings": {
  452. "index.number_of_replicas": 0
  453. },
  454. "ignore_index_settings": [
  455. "index.refresh_interval"
  456. ]
  457. }
  458. -----------------------------------
  459. // CONSOLE
  460. // TEST[continued]
  461. Please note, that some settings such as `index.number_of_shards` cannot be changed during restore operation.
  462. [float]
  463. ==== Restoring to a different cluster
  464. The information stored in a snapshot is not tied to a particular cluster or a cluster name. Therefore it's possible to
  465. restore a snapshot made from one cluster into another cluster. All that is required is registering the repository
  466. containing the snapshot in the new cluster and starting the restore process. The new cluster doesn't have to have the
  467. same size or topology. However, the version of the new cluster should be the same or newer (only 1 major version newer) than the cluster that was used to create the snapshot. For example, you can restore a 1.x snapshot to a 2.x cluster, but not a 1.x snapshot to a 5.x cluster.
  468. If the new cluster has a smaller size additional considerations should be made. First of all it's necessary to make sure
  469. that new cluster have enough capacity to store all indices in the snapshot. It's possible to change indices settings
  470. during restore to reduce the number of replicas, which can help with restoring snapshots into smaller cluster. It's also
  471. possible to select only subset of the indices using the `indices` parameter.
  472. If indices in the original cluster were assigned to particular nodes using
  473. <<shard-allocation-filtering,shard allocation filtering>>, the same rules will be enforced in the new cluster. Therefore
  474. if the new cluster doesn't contain nodes with appropriate attributes that a restored index can be allocated on, such
  475. index will not be successfully restored unless these index allocation settings are changed during restore operation.
  476. The restore operation also checks that restored persistent settings are compatible with the current cluster to avoid accidentally
  477. restoring an incompatible settings such as `discovery.zen.minimum_master_nodes` and as a result disable a smaller cluster until the
  478. required number of master eligible nodes is added. If you need to restore a snapshot with incompatible persistent settings, try
  479. restoring it without the global cluster state.
  480. [float]
  481. === Snapshot status
  482. A list of currently running snapshots with their detailed status information can be obtained using the following command:
  483. [source,sh]
  484. -----------------------------------
  485. GET /_snapshot/_status
  486. -----------------------------------
  487. // CONSOLE
  488. // TEST[continued]
  489. In this format, the command will return information about all currently running snapshots. By specifying a repository name, it's possible
  490. to limit the results to a particular repository:
  491. [source,sh]
  492. -----------------------------------
  493. GET /_snapshot/my_backup/_status
  494. -----------------------------------
  495. // CONSOLE
  496. // TEST[continued]
  497. If both repository name and snapshot id are specified, this command will return detailed status information for the given snapshot even
  498. if it's not currently running:
  499. [source,sh]
  500. -----------------------------------
  501. GET /_snapshot/my_backup/snapshot_1/_status
  502. -----------------------------------
  503. // CONSOLE
  504. // TEST[continued]
  505. The output looks similar to the following:
  506. [source,js]
  507. --------------------------------------------------
  508. {
  509. "snapshots": [
  510. {
  511. "snapshot": "snapshot_1",
  512. "repository": "my_backup",
  513. "uuid": "XuBo4l4ISYiVg0nYUen9zg",
  514. "state": "SUCCESS",
  515. "include_global_state": true,
  516. "shards_stats": {
  517. "initializing": 0,
  518. "started": 0,
  519. "finalizing": 0,
  520. "done": 5,
  521. "failed": 0,
  522. "total": 5
  523. },
  524. "stats": {
  525. "incremental": {
  526. "file_count": 8,
  527. "size_in_bytes": 4704
  528. },
  529. "processed": {
  530. "file_count": 7,
  531. "size_in_bytes": 4254
  532. },
  533. "total": {
  534. "file_count": 8,
  535. "size_in_bytes": 4704
  536. },
  537. "start_time_in_millis": 1526280280355,
  538. "time_in_millis": 358
  539. }
  540. }
  541. ]
  542. }
  543. --------------------------------------------------
  544. // TESTRESPONSE
  545. The output is composed of different sections. The `stats` sub-object provides details on the number and size of files that were
  546. snapshotted. As snapshots are incremental, copying only the Lucene segments that are not already in the repository,
  547. the `stats` object contains a `total` section for all the files that are referenced by the snapshot, as well as an `incremental` section
  548. for those files that actually needed to be copied over as part of the incremental snapshotting. In case of a snapshot that's still
  549. in progress, there's also a `processed` section that contains information about the files that are in the process of being copied.
  550. Multiple ids are also supported:
  551. [source,sh]
  552. -----------------------------------
  553. GET /_snapshot/my_backup/snapshot_1,snapshot_2/_status
  554. -----------------------------------
  555. // CONSOLE
  556. // TEST[continued]
  557. [float]
  558. === Monitoring snapshot/restore progress
  559. There are several ways to monitor the progress of the snapshot and restores processes while they are running. Both
  560. operations support `wait_for_completion` parameter that would block client until the operation is completed. This is
  561. the simplest method that can be used to get notified about operation completion.
  562. The snapshot operation can be also monitored by periodic calls to the snapshot info:
  563. [source,sh]
  564. -----------------------------------
  565. GET /_snapshot/my_backup/snapshot_1
  566. -----------------------------------
  567. // CONSOLE
  568. // TEST[continued]
  569. Please note that snapshot info operation uses the same resources and thread pool as the snapshot operation. So,
  570. executing a snapshot info operation while large shards are being snapshotted can cause the snapshot info operation to wait
  571. for available resources before returning the result. On very large shards the wait time can be significant.
  572. To get more immediate and complete information about snapshots the snapshot status command can be used instead:
  573. [source,sh]
  574. -----------------------------------
  575. GET /_snapshot/my_backup/snapshot_1/_status
  576. -----------------------------------
  577. // CONSOLE
  578. // TEST[continued]
  579. While snapshot info method returns only basic information about the snapshot in progress, the snapshot status returns
  580. complete breakdown of the current state for each shard participating in the snapshot.
  581. The restore process piggybacks on the standard recovery mechanism of the Elasticsearch. As a result, standard recovery
  582. monitoring services can be used to monitor the state of restore. When restore operation is executed the cluster
  583. typically goes into `red` state. It happens because the restore operation starts with "recovering" primary shards of the
  584. restored indices. During this operation the primary shards become unavailable which manifests itself in the `red` cluster
  585. state. Once recovery of primary shards is completed Elasticsearch is switching to standard replication process that
  586. creates the required number of replicas at this moment cluster switches to the `yellow` state. Once all required replicas
  587. are created, the cluster switches to the `green` states.
  588. The cluster health operation provides only a high level status of the restore process. It's possible to get more
  589. detailed insight into the current state of the recovery process by using <<indices-recovery, indices recovery>> and
  590. <<cat-recovery, cat recovery>> APIs.
  591. [float]
  592. === Stopping currently running snapshot and restore operations
  593. The snapshot and restore framework allows running only one snapshot or one restore operation at a time. If a currently
  594. running snapshot was executed by mistake, or takes unusually long, it can be terminated using the snapshot delete operation.
  595. The snapshot delete operation checks if the deleted snapshot is currently running and if it does, the delete operation stops
  596. that snapshot before deleting the snapshot data from the repository.
  597. [source,sh]
  598. -----------------------------------
  599. DELETE /_snapshot/my_backup/snapshot_1
  600. -----------------------------------
  601. // CONSOLE
  602. // TEST[continued]
  603. The restore operation uses the standard shard recovery mechanism. Therefore, any currently running restore operation can
  604. be canceled by deleting indices that are being restored. Please note that data for all deleted indices will be removed
  605. from the cluster as a result of this operation.
  606. [float]
  607. === Effect of cluster blocks on snapshot and restore operations
  608. Many snapshot and restore operations are affected by cluster and index blocks. For example, registering and unregistering
  609. repositories require write global metadata access. The snapshot operation requires that all indices and their metadata as
  610. well as the global metadata were readable. The restore operation requires the global metadata to be writable, however
  611. the index level blocks are ignored during restore because indices are essentially recreated during restore.
  612. Please note that a repository content is not part of the cluster and therefore cluster blocks don't affect internal
  613. repository operations such as listing or deleting snapshots from an already registered repository.