Skip to content

Clarify MinIO nonfunctional requirements #2021

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jul 7, 2025
Merged

Clarify MinIO nonfunctional requirements #2021

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a1084ef
Clarify MinIO nonfunctional requirements
DaveCTurner Jul 3, 2025
065dd3b
Merge branch 'main' into 2025/07/03/MinIO-nonfunctional-requirements
DaveCTurner Jul 7, 2025
d2ce8b1
Make an admonition
DaveCTurner Jul 7, 2025
d99c2f4
Tweaks
DaveCTurner Jul 7, 2025
6aca8c2
Merge branch 'main' into 2025/07/03/MinIO-nonfunctional-requirements
DaveCTurner Jul 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion deploy-manage/tools/snapshot-and-restore/s3-repository.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -380,7 +380,7 @@ There are a number of storage systems that provide an S3-compatible API, and the

By default {{es}} communicates with your storage system using HTTPS, and validates the repository’s certificate chain using the JVM-wide truststore. Ensure that the JVM-wide truststore includes an entry for your repository. If you wish to use unsecured HTTP communication instead of HTTPS, set `s3.client.CLIENT_NAME.protocol` to `http`.

[MinIO](https://minio.io) is an example of a storage system that provides an S3-compatible API. The `s3` repository type allows {{es}} to work with MinIO-backed repositories as well as repositories stored on AWS S3. Other S3-compatible storage systems may also work with {{es}}, but these are not covered by the {{es}} test suite.
[MinIO](https://minio.io) is an example of a storage system that provides an S3-compatible API. The `s3` repository type allows {{es}} to work with MinIO-backed repositories as well as repositories stored on AWS S3. Note however that the performance, reliability and durability of a MinIO-backed repository are dependent on the properties of the underlying infrastructure, as well as on the details of your MinIO configuration. You must design your storage infrastructure, and configure MinIO, so that your MinIO-backed repository has performance, reliability and durability characteristics which match AWS S3. If you need assistance with your MinIO configuration, please contact the MinIO support team. Other S3-compatible storage systems may also work with {{es}}, but these are not covered by the {{es}} test suite.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
[MinIO](https://minio.io) is an example of a storage system that provides an S3-compatible API. The `s3` repository type allows {{es}} to work with MinIO-backed repositories as well as repositories stored on AWS S3. Note however that the performance, reliability and durability of a MinIO-backed repository are dependent on the properties of the underlying infrastructure, as well as on the details of your MinIO configuration. You must design your storage infrastructure, and configure MinIO, so that your MinIO-backed repository has performance, reliability and durability characteristics which match AWS S3. If you need assistance with your MinIO configuration, please contact the MinIO support team. Other S3-compatible storage systems may also work with {{es}}, but these are not covered by the {{es}} test suite.
[MinIO](https://minio.io) is an example of a storage system that provides an S3-compatible API. The `s3` repository type allows {{es}} to work with MinIO-backed repositories as well as repositories stored on AWS S3. However, note that the performance, reliability, and durability of a MinIO-backed repository depend on the properties of the underlying infrastructure, as well as on the details of your MinIO configuration. You must design your storage infrastructure and configure MinIO in a way that ensures your MinIO-backed repository has the performance, reliability, and durability characteristics that match AWS S3. If you need assistance with your MinIO configuration, please contact the MinIO support team. Other S3-compatible storage systems may also work with {{es}}, but these are not covered by the {{es}} test suite.

minor style suggestion to improve readability

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@DaveCTurner , what if we include the entire MinIO paragraph in a highlighted note with three paragraphs inside?

Something like:

::::{admonition} MinIO considerations
[MinIO](https://minio.io) is an example of a storage system that provides an S3-compatible API. The `s3` repository type allows {{es}} to work with MinIO-backed repositories as well as repositories stored on AWS S3.

Note that the performance, reliability, and durability of a MinIO-backed repository depend on the properties of the underlying infrastructure, as well as on the details of your MinIO configuration. You must design your storage infrastructure and configure MinIO in a way that ensures your MinIO-backed repository has the performance, reliability, and durability characteristics that match AWS S3. If you need assistance with your MinIO configuration, please contact the MinIO support team.

Other S3-compatible storage systems may also work with {{es}}, but these are not covered by the {{es}} test suite.
::::

Considering that the section is about compatible S3 services in general, but MinIO is actually the most important for us, I think highlighting this paragraph would be beneficial for the doc, and could look like:

image


There are many systems, including some from very well-known storage vendors, which claim to offer an S3-compatible API despite failing to emulate S3’s behavior in full. If you are using such a system for your snapshots, consider using a [shared filesystem repository](shared-file-system-repository.md) based on a standardized protocol such as NFS to access your storage system instead. The `s3` repository type requires full compatibility with S3. In particular it must support the same set of API endpoints, with the same parameters, return the same errors in case of failures, and offer consistency and performance at least as good as S3 even when accessed concurrently by multiple nodes. You will need to work with the supplier of your storage system to address any incompatibilities you encounter. Don't report {{es}} issues involving storage systems which claim to be S3-compatible unless you can demonstrate that the same issue exists when using a genuine AWS S3 repository.

Expand Down
Loading