From f19159a5871d9e861834bf48aa2ad45b0ce5648a Mon Sep 17 00:00:00 2001 From: David Turner Date: Wed, 24 Feb 2021 09:05:16 +0000 Subject: [PATCH] Link to repo analyser from docs on S3-compat repos (#69513) Adds a link to the repository analyser API from the docs regarding "S3-compatible" repository types. --- docs/plugins/repository-s3.asciidoc | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/docs/plugins/repository-s3.asciidoc b/docs/plugins/repository-s3.asciidoc index e9a5e37ff3b2d..21731483e3cd3 100644 --- a/docs/plugins/repository-s3.asciidoc +++ b/docs/plugins/repository-s3.asciidoc @@ -222,12 +222,17 @@ Note that some storage systems claim to be S3-compatible without correctly supporting the full S3 API. The `repository-s3` plugin requires full compatibility with S3. In particular it must support the same set of API endpoints, return the same errors in case of failures, and offer a consistency -model no weaker than S3's when accessed concurrently by multiple nodes. If you -wish to use another storage system with the `repository-s3` plugin then you -will need to work with the supplier of the storage system to address any -incompatibilities you encounter. Incompatible error codes and consistency -models may be particularly hard to track down since errors and consistency -failures are usually rare and hard to reproduce. +model no weaker than S3's when accessed concurrently by multiple nodes. +Incompatible error codes and consistency models may be particularly hard to +track down since errors and consistency failures are usually rare and hard to +reproduce. + +You can perform some basic checks of the suitability of your storage system +using the {ref}/repo-analysis-api.html[repository analysis API]. If this API +does not complete successfully, or indicates poor performance, then your +storage system is not fully compatible with AWS S3 and therefore unsuitable for +use as a snapshot repository. You will need to work with the supplier of your +storage system to address any incompatibilities you encounter. [[repository-s3-repository]] ==== Repository Settings