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.

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

Jump to bottom

docs: Explain about region in storage class for OBC #9556

Closed
wants to merge 1 commit into from
Closed

docs: Explain about region in storage class for OBC #9556

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
7 changes: 4 additions & 3 deletions Documentation/ceph-object-bucket-claim.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,13 +105,14 @@ provisioner: rook-ceph.ceph.rook.io/bucket [2]
parameters: [3]
objectStoreName: my-store
objectStoreNamespace: rook-ceph
region: us-west-1
bucketName: ceph-bucket [4]
reclaimPolicy: Delete [5]
region: us-west-1 [4]
bucketName: ceph-bucket [5]
reclaimPolicy: Delete [6]
```
1. `label`(optional) here associates this `StorageClass` to a specific provisioner.
1. `provisioner` responsible for handling `OBCs` referencing this `StorageClass`.
1. **all** `parameter` required.
1. `region` defines the region in which the bucket should be created. For Rook, this is CephObjectZoneGroup (if applicable) of the related CephObjectStore; So if you need to define region other than `us-east-1` create `CephObjectZoneGroup` accordingly. Please refer to [Ceph's documentation](https://docs.ceph.com/en/latest/radosgw/multisite/#zone-groups) for more details.
Copy link
Member

Choose a reason for hiding this comment

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

Is the name of the CephObjectZoneGroup CR the name of the region? If so, how do we get us-east-1 by default since the default zone group name is the same as the object store? Maybe an example yaml would help show how to create a region named us-west-1 to match the region in the storage class.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@travisn us-east-1 is the default hard corded value inside rgw code base, most likely default zone group set by rook may also work(aka the name of object store). But people tend to use the region as us-east-1 for was clients. Hence I mentioned about us-east-1 other than the zone group value set by the rook. Or in other words, if the us-east-1 it may pick up the default zone group value or else they try to find out the corresponding zonegroup

Copy link
Member

Choose a reason for hiding this comment

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

I'm still not clear... So if they want to have the region: us-west-1 as in this example, how would the object store, zone group, etc need to be created? Perhaps we could modify the object-multisite.yaml example to use the us-west-1 region to match this example?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@travisn : What about having proper documentation in ceph docs then only this PR need to be merged, instead of modifying the object-mutlisite.yaml. If object-mutlisite.yaml is modified then that may create unnecessary confusion for users who only intended to use mutlisite.

Copy link
Member

Choose a reason for hiding this comment

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

Sounds good to include a yaml snippet here in the docs that shows how to create the object store with a non-default region.

1. `bucketName` is required for access to existing buckets but is omitted when provisioning new buckets.
Unlike greenfield provisioning, the brownfield bucket name appears in the `StorageClass`, not the `OBC`.
1. rook-ceph provisioner decides how to treat the `reclaimPolicy` when an `OBC` is deleted for the bucket. See explanation as [specified in Kubernetes](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#retain)
Expand Down