Skip to content

Commit 6e5a606

Browse files
authored
Slightly adjust docs about S3 incompatibilities (#99624) (#99628)
It's often useful to quote these docs to users encountering problems with their not-quite-S3-compatible storage system. In practice we don't need to quote the bits in the middle but we do need the last sentence about working with the supplier to address incompatibilities. This commit reorders things so that the most commonly quoted sentences form a standalone paragraph.
1 parent 809c557 commit 6e5a606

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

docs/reference/snapshot-restore/repository-s3.asciidoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -226,16 +226,16 @@ emulate S3's behaviour in full. The `repository-s3` type requires full
226226
compatibility with S3. In particular it must support the same set of API
227227
endpoints, return the same errors in case of failures, and offer consistency
228228
and performance at least as good as S3 even when accessed concurrently by
229-
multiple nodes. Incompatible error codes, consistency or performance may be
230-
particularly hard to track down since errors, consistency failures, and
231-
performance issues are usually rare and hard to reproduce.
229+
multiple nodes. You will need to work with the supplier of your storage system
230+
to address any incompatibilities you encounter.
232231

233232
You can perform some basic checks of the suitability of your storage system
234233
using the {ref}/repo-analysis-api.html[repository analysis API]. If this API
235234
does not complete successfully, or indicates poor performance, then your
236235
storage system is not fully compatible with AWS S3 and therefore unsuitable for
237-
use as a snapshot repository. You will need to work with the supplier of your
238-
storage system to address any incompatibilities you encounter.
236+
use as a snapshot repository. However, these checks do not guarantee full
237+
compatibility. Incompatible error codes and consistency or performance issues
238+
may be rare and hard to reproduce.
239239

240240
[[repository-s3-repository]]
241241
==== Repository settings

0 commit comments

Comments
 (0)