mirrors/ceph-csi
1
0
Fork 0
mirror of https://github.com/ceph/ceph-csi.git synced 2024-09-19 15:09:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc: minor cleanup

Browse Source 
Signed-off-by: Anthony D'Atri <anthonyeleven@users.noreply.github.com>
This commit is contained in:
Anthony D'Atri 2022-07-31 01:24:26 -07:00 committed by mergify[bot]
parent f4d6e51c4b
commit 56d7d3cd15
2 changed files with 18 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -21,15 +21,15 @@ Card](https://goreportcard.com/badge/github.com/ceph/ceph-csi)](https://goreport
- [Dev standup](#dev-standup) - [Dev standup](#dev-standup)
- [Contact](#contact) - [Contact](#contact)
This repo contains Ceph This repo contains the Ceph
[Container Storage Interface (CSI)](https://github.com/container-storage-interface/) [Container Storage Interface (CSI)](https://github.com/container-storage-interface/)
driver for RBD, CephFS and kubernetes sidecar deployment yamls of provisioner, driver for RBD, CephFS and Kubernetes sidecar deployment YAMLs to support CSI
attacher, resizer, driver-registrar and snapshotter for supporting CSI functionalities. functionality: provisioner, attacher, resizer, driver-registrar and snapshotter.
## Overview ## Overview
Ceph CSI plugins implement an interface between CSI enabled Container Orchestrator Ceph CSI plugins implement an interface between a CSI-enabled Container Orchestrator
(CO) and Ceph cluster. It allows dynamically provisioning Ceph volumes and (CO) and Ceph clusters. They enable dynamically provisioning Ceph volumes and
attaching them to workloads. attaching them to workloads.
Independent CSI plugins are provided to support RBD and CephFS backed volumes, Independent CSI plugins are provided to support RBD and CephFS backed volumes,
@ -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 [rbd doc](https://github.com/ceph/ceph-csi/blob/devel/docs/deploy-rbd.md) and
for CephFS plugin configuration and deployment please for CephFS plugin configuration and deployment please
refer [cephFS doc](https://github.com/ceph/ceph-csi/blob/devel/docs/deploy-cephfs.md). 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). - Stale resource cleanup, please refer [cleanup doc](docs/resource-cleanup.md).
NOTE: NOTE:
@ -51,7 +51,7 @@ Status: **GA**
## Known to work CO platforms ## 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. environments.
| Ceph CSI Version | Container Orchestrator Name | Version Tested| | Ceph CSI Version | Container Orchestrator Name | Version Tested|
@ -62,18 +62,17 @@ environments.
| v3.5.0 | Kubernetes | v1.21, v1.22, v1.23| | v3.5.0 | Kubernetes | v1.21, v1.22, v1.23|
| v3.4.0 | Kubernetes | v1.20, v1.21, v1.22| | v3.4.0 | Kubernetes | v1.20, v1.21, v1.22|
There is work in progress to make this CO independent and thus There is work in progress to make this CO-independent and thus
support other orchestration environments (Nomad, Mesos..etc) in the future. support other orchestration environments (Nomad, Mesos..etc).
NOTE: 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)). (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 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 Ceph CSI version, they will be asked to upgrade when requesting support.
cluster.
## Support Matrix ## Support Matrix

9
docs/capabilities.md
View File

@ -1,6 +1,7 @@
# Capabilities of a user required for ceph-csi in a Ceph cluster # 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. to exercise the functionality of the monitors, OSDs and metadata servers.
Capabilities can also restrict access to data within a pool or pool namespace. 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 A Ceph administrative user sets a user's capabilities when creating or
@ -11,8 +12,8 @@ Hence, those capabilities are documented below.
## RBD ## RBD
We have provisioner, controller expand and node stage secrets in storageclass. We have provisioner, controller expand and node stage secrets in storageclass.
For the provisioner and controller expand stage secret in storageclass, the For the provisioner and controller expand stage secrets in storageclass, the
user needs to have the below mentioned ceph capabilities. user needs to have the below Ceph capabilities.
``` ```
"mon", "profile rbd", "mon", "profile rbd",
@ -50,7 +51,7 @@ the below mentioned ceph capabilities.
"mds", "allow rw" "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/) [this document](https://ceph.readthedocs.io/en/latest/cephfs/client-auth/)
## Command to a create user with required capabilities ## Command to a create user with required capabilities