Skip to content
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.

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

Docs | S3 Compatibility #1449

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Conversation

Neon-White
Copy link
Contributor

Explain the changes

  1. Add documentation regarding S3 compatibility in NooBaa

Signed-off-by: Ben <[email protected]>
@Neon-White Neon-White added the documentation Improvements or additions to documentation label Sep 27, 2024
@nimrod-becker
Copy link
Contributor

I think it can be good to add a table with the different types and what we support on them?
We can also add a doc in the core repo that refers to this one.
wdyt?

We can sync on the table content and fill it together

@Neon-White Neon-White marked this pull request as ready for review November 13, 2024 11:01
S3 (also known as Simple Storage Service) is an object storage service provided by Amazon. However, S3 is often colloquially used to refer to the S3 API - the RESTful interface for interaction with AWS S3. Over time, the S3 API has reached a point where many consider it the de facto standard API for object storage, and is supported by many cloud providers and storage vendors - even ones like Microsoft Azure and Google Cloud Platform, which also offer their own APIs alongside S3 compatibility.

## API Compatibility
Due to the wide adoption of the S3 API, NooBaa has been designed to be S3 compatible and adherent. NooBaa buckets and objects can be managed with most S3 clients without a need for proprietary tools or workarounds. All a user needs in order to interact with NooBaa through an S3 client is the endpoint of the NooBaa system, and a set of fitting credentials.
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we add the step on how to get the information here?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation size/S
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants