Skip to content

Commit

Permalink
Documentation cleanup
Browse files Browse the repository at this point in the history
Signed-off-by: Anthony D'Atri <[email protected]>
  • Loading branch information
anthonyeleven committed Jul 31, 2022
1 parent f4d6e51 commit 1855fea
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 18 deletions.
25 changes: 12 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,15 @@ Card](https://goreportcard.com/badge/github.com/ceph/ceph-csi)](https://goreport
- [Dev standup](#dev-standup)
- [Contact](#contact)

This repo contains Ceph
This repo contains the Ceph
[Container Storage Interface (CSI)](https://github.com/container-storage-interface/)
driver for RBD, CephFS and kubernetes sidecar deployment yamls of provisioner,
attacher, resizer, driver-registrar and snapshotter for supporting CSI functionalities.
driver for RBD, CephFS and Kubernetes sidecar deployment YAMLs to support CSI
functionality: provisioner, attacher, resizer, driver-registrar and snapshotter.

## Overview

Ceph CSI plugins implement an interface between CSI enabled Container Orchestrator
(CO) and Ceph cluster. It allows dynamically provisioning Ceph volumes and
Ceph CSI plugins implement an interface between a CSI-enabled Container Orchestrator
(CO) and Ceph clusters. They enable dynamically provisioning Ceph volumes and
attaching them to workloads.

Independent CSI plugins are provided to support RBD and CephFS backed volumes,
Expand All @@ -38,7 +38,7 @@ Independent CSI plugins are provided to support RBD and CephFS backed volumes,
[rbd doc](https://github.com/ceph/ceph-csi/blob/devel/docs/deploy-rbd.md) and
for CephFS plugin configuration and deployment please
refer [cephFS doc](https://github.com/ceph/ceph-csi/blob/devel/docs/deploy-cephfs.md).
- For example usage of RBD and CephFS CSI plugins, see examples in `examples/`.
- For example usage of the RBD and CephFS CSI plugins, see examples in `examples/`.
- Stale resource cleanup, please refer [cleanup doc](docs/resource-cleanup.md).

NOTE:
Expand All @@ -51,7 +51,7 @@ Status: **GA**

## Known to work CO platforms

Ceph CSI drivers are currently developed and tested **exclusively** on Kubernetes
Ceph CSI drivers are currently developed and tested **exclusively** in Kubernetes
environments.

| Ceph CSI Version | Container Orchestrator Name | Version Tested|
Expand All @@ -62,18 +62,17 @@ environments.
| v3.5.0 | Kubernetes | v1.21, v1.22, v1.23|
| v3.4.0 | Kubernetes | v1.20, v1.21, v1.22|

There is work in progress to make this CO independent and thus
support other orchestration environments (Nomad, Mesos..etc) in the future.
There is work in progress to make this CO-independent and thus
support other orchestration environments (Nomad, Mesos..etc).

NOTE:

The supported window of Ceph CSI versions is known as "N.(x-1)":
The supported window of Ceph CSI versions is "N.(x-1)":
(N (Latest major release) . (x (Latest minor release) - 1)).

For example, if Ceph CSI latest major version is `3.6.0` today, support is
For example, if the Ceph CSI latest major version is `3.6.0` today, support is
provided for the versions above `3.5.0`. If users are running an unsupported
Ceph CSI version, they will be asked to upgrade when requesting support for the
cluster.
Ceph CSI version, they will be asked to upgrade when requesting support.

## Support Matrix

Expand Down
11 changes: 6 additions & 5 deletions docs/capabilities.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Capabilities of a user required for ceph-csi in a Ceph cluster

Ceph uses the term capabilities to describe authorizing an authenticated user
Ceph uses the term _capabilities_ to describe authorizations for an
authenticated user
to exercise the functionality of the monitors, OSDs and metadata servers.
Capabilities can also restrict access to data within a pool or pool namespace.
A Ceph administrative user sets a user's capabilities when creating or
Expand All @@ -10,9 +11,9 @@ Hence, those capabilities are documented below.

## RBD

We have provisioner, controller expand and node stage secrets in storage class.
For the provisioner and controller expand stage secret in storageclass, the
user needs to have the below mentioned ceph capabilities.
We have provisioner, controller expand and node stage secrets in storageclass.
For the provisioner and controller expand stage secrets in storageclass, the
user needs to have the below Ceph capabilities.

```
"mon", "profile rbd",
Expand Down Expand Up @@ -50,7 +51,7 @@ the below mentioned ceph capabilities.
"mds", "allow rw"
```

To get more insights on capabilities of cephfs you can refer
To get more insights on capabilities of CephFS you can refer
[this document](https://ceph.readthedocs.io/en/latest/cephfs/client-auth/)

## Command to a create user with required capabilities
Expand Down

0 comments on commit 1855fea

Please sign in to comment.