Blaine Gardner
1391228b1d
mkdocs uses a markdown renderer that is hardcoded to 4 spaces per tab
for detecting indentation levels, including ordered- and
unordered-lists. Since we cannot easily change the renderer, begin using
a markdown linter in CI that will fail if official docs do not adhere to
the spacing rules.
As a starting point, the markdownlint config does not begin with the
default set of checks, which might overwhelm attempts to fix them.
Instead, focus on list-tab-spacing rules and a few other highly useful
checks.
markdownlint also has some gaps in its abilities that allow common Rook
doc issues to pass acceptance. However, it allows creating custom
linting plugins. Create 2 such linting plugins to check 2 things:
- all doc lines (except code blocks) must be aligned to a 4-space
boundary, without exception. This ensures that markdown will render
correctly with mkdocs. This unfortunately makes it possible to create
lists that are internally aligned strangely.
- admonitions must all follow the same format of
```
!!! header
body
```
For the strange lists, this is allowed and renders correctly, but it
looks strange:
```md
- first bullet
- second bullet
still second bullet
- third bullet
has a paragraph
of text inside
- last bullet
Signed-off-by: Blaine Gardner <blaine.gardner@ibm.com>
(cherry picked from commit c9d99e01a0)
63 lines
2.4 KiB
Markdown
63 lines
2.4 KiB
Markdown
---
|
|
title: CephObjectStoreUser CRD
|
|
---
|
|
|
|
Rook allows creation and customization of object store users through the custom resource definitions (CRDs). The following settings are available
|
|
for Ceph object store users.
|
|
|
|
## Example
|
|
|
|
```yaml
|
|
apiVersion: ceph.rook.io/v1
|
|
kind: CephObjectStoreUser
|
|
metadata:
|
|
name: my-user
|
|
namespace: rook-ceph
|
|
spec:
|
|
store: my-store
|
|
displayName: my-display-name
|
|
quotas:
|
|
maxBuckets: 100
|
|
maxSize: 10G
|
|
maxObjects: 10000
|
|
capabilities:
|
|
user: "*"
|
|
bucket: "*"
|
|
```
|
|
|
|
## Object Store User Settings
|
|
|
|
### Metadata
|
|
|
|
* `name`: The name of the object store user to create, which will be reflected in the secret and other resource names.
|
|
* `namespace`: The namespace of the Rook cluster where the object store user is created.
|
|
|
|
### Spec
|
|
|
|
* `store`: The object store in which the user will be created. This matches the name of the objectstore CRD.
|
|
* `displayName`: The display name which will be passed to the `radosgw-admin user create` command.
|
|
* `clusterNamespace`: The namespace where the parent CephCluster and CephObjectStore are found. If not specified,
|
|
the user must be in the same namespace as the cluster and object store.
|
|
To enable this feature, the CephObjectStore allowUsersInNamespaces must include the namespace of this user.
|
|
* `quotas`: This represents quota limitation can be set on the user. Please refer [here](https://docs.ceph.com/en/latest/radosgw/admin/#quota-management) for details.
|
|
* `maxBuckets`: The maximum bucket limit for the user.
|
|
* `maxSize`: Maximum size limit of all objects across all the user's buckets.
|
|
* `maxObjects`: Maximum number of objects across all the user's buckets.
|
|
* `capabilities`: Ceph allows users to be given additional permissions. Due to missing APIs in go-ceph for updating the user capabilities, this setting can currently only be used during the creation of the object store user. If a user's capabilities need modified, the user must be deleted and re-created.
|
|
See the [Ceph docs](https://docs.ceph.com/en/latest/radosgw/admin/#add-remove-admin-capabilities) for more info.
|
|
Rook supports adding `read`, `write`, `read, write`, or `*` permissions for the following resources:
|
|
* `user`
|
|
* `buckets`
|
|
* `usage`
|
|
* `metadata`
|
|
* `zone`
|
|
* `roles`
|
|
* `info`
|
|
* `amz-cache`
|
|
* `bilog`
|
|
* `mdlog`
|
|
* `datalog`
|
|
* `user-policy`
|
|
* `odic-provider`
|
|
* `ratelimit`
|