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 Feb 22, 2022
1 parent 6a97c0e commit dcc908a
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions Documentation/ceph-object-bucket-claim.md
Expand Up @@ -105,13 +105,13 @@ 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`(optional) defines the region in which the bucket should be created. For RGW, this maps to `zonegroup` of the server. If user does not define `region`, Rook will fill this from in-memory `objectStoreContext` for the `ceph object store` and by default this value is the name of `ceph object store` for the internal cluster. If region is specified by the user and if it is different from default value, then create [CephObjectZoneGroup](ceph-object-multisite-crd.md#object-zone-group-settings) for the `ceph object store`. Please refer to [Ceph's documentation](https://docs.ceph.com/en/latest/radosgw/multisite/#zone-groups) 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 dcc908a

Please sign in to comment.