Skip to content

Commit

Permalink
docs: Explain about region in storage class for OBC
Browse files Browse the repository at this point in the history
The default value for region in RGW is us-east-1, if users want to use
other regions then they need to create zone/zonegroup accordingly before
defining it in storage class.

Fixes: #9486
Signed-off-by: Jiffin Tony Thottan <thottanjiffin@gmail.com>
  • Loading branch information
thotz committed Jan 11, 2022
1 parent 511c250 commit f8f0058
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions Documentation/ceph-object-bucket-claim.md
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` needs to create required zone/zonegroup in RGW before defining it here. Please refer [ceph documentation](https://docs.ceph.com/en/latest/radosgw/multisite/#multi-site) for more details.
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

0 comments on commit f8f0058

Please sign in to comment.