From 95af191d21a2b1cba1a54a1c2ee797b9bacb6bea Mon Sep 17 00:00:00 2001 From: Ben Date: Thu, 26 Sep 2024 18:25:00 +0200 Subject: [PATCH] Initial draft Signed-off-by: Ben --- doc/s3-compatibility.md | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 doc/s3-compatibility.md diff --git a/doc/s3-compatibility.md b/doc/s3-compatibility.md new file mode 100644 index 000000000..2c255be16 --- /dev/null +++ b/doc/s3-compatibility.md @@ -0,0 +1,10 @@ +[NooBaa Operator](../README.md) / + +# S3 Compatibility in NooBaa +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 average S3 client is the endpoint of the NooBaa system, and a set of fitting credentials. + +## Utilization of S3 Compatible Storage Services +NooBaa can also be used as a gateway to other storage services that are S3 compatible. This means that NooBaa can be used to store and manage data in certain storage services (as long as they provide an S3 compatible API), even if they are not natively supported by the product. This is done by creating a [backingstore](backing-store-crd.md)/[namespacestore](namespace-store-crd.md) of type `s3-compatible` and providing the the appropriate endpoint. \ No newline at end of file