snapshots.asciidoc 4.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114
  1. [float]
  2. [[breaking_80_snapshots_changes]]
  3. === Snapshot and restore changes
  4. //NOTE: The notable-breaking-changes tagged regions are re-used in the
  5. //Installation and Upgrade Guide
  6. //tag::notable-breaking-changes[]
  7. // end::notable-breaking-changes[]
  8. .The get snapshot API's response format has changed.
  9. [%collapsible]
  10. ====
  11. *Details* +
  12. It's possible to get snapshots from multiple repositories in one go. The response format has changed
  13. and now contains separate response for each repository.
  14. For example, requesting one snapshot from particular repository
  15. [source,console]
  16. -----------------------------------
  17. GET _snapshot/repo1/snap1
  18. -----------------------------------
  19. // TEST[skip:no repo and snapshots are created]
  20. produces the following response
  21. [source,console-result]
  22. -----------------------------------
  23. {
  24. "responses": [
  25. {
  26. "repository": "repo1",
  27. "snapshots": [
  28. {
  29. "snapshot": "snap1",
  30. "uuid": "cEzdqUKxQ5G6MyrJAcYwmA",
  31. "version_id": 8000099,
  32. "version": "8.0.0",
  33. "indices": [],
  34. "include_global_state": true,
  35. "state": "SUCCESS",
  36. "start_time": "2019-05-10T17:01:57.868Z",
  37. "start_time_in_millis": 1557507717868,
  38. "end_time": "2019-05-10T17:01:57.909Z",
  39. "end_time_in_millis": 1557507717909,
  40. "duration_in_millis": 41,
  41. "failures": [],
  42. "shards": {
  43. "total": 0,
  44. "failed": 0,
  45. "successful": 0
  46. }
  47. }
  48. ]
  49. }
  50. ]
  51. }
  52. -----------------------------------
  53. // TESTRESPONSE[skip:no repo and snapshots are created]
  54. See <<modules-snapshots>> for more information.
  55. ====
  56. .The `repositories.fs.compress` node-level setting has been removed.
  57. [%collapsible]
  58. ====
  59. *Details* +
  60. For shared file system repositories (`"type": "fs"`), the node level setting `repositories.fs.compress` could
  61. previously be used to enable compression for all shared file system repositories where `compress` was not specified.
  62. The `repositories.fs.compress` setting has been removed.
  63. Instead use the repository specific `compress` setting to enable compression. See <<modules-snapshots>> for information
  64. on the `compress` setting.
  65. ====
  66. .Metadata files are now compressed by default.
  67. [%collapsible]
  68. ====
  69. *Details* +
  70. Previously, the default value for `compress` was `false`. The default has been changed to `true`.
  71. This change will affect both newly created repositories and existing repositories where `compress=false` has not been
  72. explicitly specified.
  73. For more information on the compress option, see <<modules-snapshots>>
  74. ====
  75. .The S3 repository plugin now uses a DNS-style access pattern by default.
  76. [%collapsible]
  77. ====
  78. *Details* +
  79. Starting in version 7.4 the `repository-s3` plugin does not use the
  80. now-deprecated path-style access pattern by default. In versions 7.0, 7.1, 7.2
  81. and 7.3 the `repository-s3` plugin always used the path-style access pattern.
  82. This is a breaking change for deployments that only support path-style access
  83. but which are recognized as supporting DNS-style access by the AWS SDK. If your
  84. deployment only supports path-style access and is affected by this change then
  85. you must configure the S3 client setting `path_style_access` to `true`. This
  86. breaking change was made necessary by
  87. https://aws.amazon.com/blogs/aws/amazon-s3-path-deprecation-plan-the-rest-of-the-story/[AWS's
  88. announcement] that the path-style access pattern is deprecated and will be
  89. unsupported on buckets created after September 30th 2020.
  90. ====
  91. .Restore requests no longer accept settings.
  92. [%collapsible]
  93. ====
  94. *Details* +
  95. In earlier versions, you could pass both `settings` and `index_settings` in the
  96. body of a restore snapshot request, but the `settings` value was ignored. The
  97. restore snapshot API now rejects requests that include a `settings` value.
  98. ====