snapshots.asciidoc 4.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132
  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. *Impact* +
  56. Update your workflow and applications to use the get snapshot API's new response
  57. format.
  58. ====
  59. .The `repositories.fs.compress` node-level setting has been removed.
  60. [%collapsible]
  61. ====
  62. *Details* +
  63. For shared file system repositories (`"type": "fs"`), the node level setting `repositories.fs.compress` could
  64. previously be used to enable compression for all shared file system repositories where `compress` was not specified.
  65. The `repositories.fs.compress` setting has been removed.
  66. *Impact* +
  67. Use the repository specific `compress` setting to enable compression. See
  68. <<modules-snapshots>> for information on the `compress` setting.
  69. Discontinue use of the `repositories.fs.compress` node-level setting.
  70. ====
  71. .Metadata files are now compressed by default.
  72. [%collapsible]
  73. ====
  74. *Details* +
  75. Previously, the default value for `compress` was `false`. The default has been changed to `true`.
  76. This change will affect both newly created repositories and existing repositories where `compress=false` has not been
  77. explicitly specified.
  78. For more information on the compress option, see <<modules-snapshots>>
  79. *Impact* +
  80. Update your workflow and applications to assume a default value of `true` for
  81. the `compress` parameter.
  82. ====
  83. .The S3 repository plugin now uses a DNS-style access pattern by default.
  84. [%collapsible]
  85. ====
  86. *Details* +
  87. Starting in version 7.4 the `repository-s3` plugin does not use the
  88. now-deprecated path-style access pattern by default. In versions 7.0, 7.1, 7.2
  89. and 7.3 the `repository-s3` plugin always used the path-style access pattern.
  90. This is a breaking change for deployments that only support path-style access
  91. but which are recognized as supporting DNS-style access by the AWS SDK. This
  92. breaking change was made necessary by
  93. https://aws.amazon.com/blogs/aws/amazon-s3-path-deprecation-plan-the-rest-of-the-story/[AWS's
  94. announcement] that the path-style access pattern is deprecated and will be
  95. unsupported on buckets created after September 30th 2020.
  96. *Impact* +
  97. If your deployment only supports path-style access and is affected by this
  98. change then you must configure the S3 client setting `path_style_access` to
  99. `true`.
  100. ====
  101. .Restore requests no longer accept settings.
  102. [%collapsible]
  103. ====
  104. *Details* +
  105. In earlier versions, you could pass both `settings` and `index_settings` in the
  106. body of a restore snapshot request, but the `settings` value was ignored. The
  107. restore snapshot API now rejects requests that include a `settings` value.
  108. *Impact* +
  109. Discontinue use of the `settings` parameter in restore
  110. snapshot request. Requests that include these parameters will return an error.
  111. ====