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 | Bucket Types #1448

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

Conversation

Neon-White
Copy link
Contributor

@Neon-White Neon-White commented Sep 27, 2024

Explain the changes

  1. Add documentation regarding NooBaa bucket types

Signed-off-by: Ben <[email protected]>
@Neon-White Neon-White added the documentation Improvements or additions to documentation label Sep 27, 2024
@Neon-White Neon-White marked this pull request as draft September 27, 2024 13:40
Namespace buckets work differently than data buckets, since they try¹ to not apply any processing on the objects that are uploaded to them, and act as more of a 'passthrough'.
The objects can be accessed both from within NooBaa, as well as from whatever storage providers hosts them.

<sup><sub>1. In some cases, object metadata (such as tags) might have to be modified in order to comply with a cloud provider's limits</sub></sup>
Copy link
Contributor

Choose a reason for hiding this comment

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

  1. would mention the types of NS we supports.
  2. Add that when the underlying storage does not support S3 , NooBaa performs the logic and semantics on top what is supported by the underlying storage


Once a store is created, it's necessary to create a [bucketclass](bucket-class-crd.md) resource. Bucketclasses allow users to define bucket policies relating to data placement and replication, and are used as a middle layer between buckets and stores.

After the bucketclass has been created, it's now finally possible to create an [object bucket claim](obc-provisioner.md), which is then reconciled by NooBaa and creates a bucket in the system.
Copy link
Contributor

Choose a reason for hiding this comment

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

Add a section of what is supported which each bucket which will point to the S3 compatibility doc (see my other comment there)

Signed-off-by: Ben <[email protected]>
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/M
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants