Commit Graph

292 Commits

Author SHA1 Message Date
yati1998
0bf5258c7a doc: update doc for disaster recovery
Volume Replication has been added to csi-addons
as a feature in it sometime back. But the doc still
uses the volume replication operator to enable
mirroring and create related resources for
disaster recovery.
this commit updates the document to use csi-addons
instead of creating volumereplication sidecar.

Signed-off-by: yati1998 <ypadia@redhat.com>
2024-11-04 19:04:45 +05:30
yati1998
a6f1af49c6 doc: resturcture the doc folder
This commit is the restructure the doc folder to
include sub-folders like csi-addons, rbd, cephfs
to contain related docs and other general docs can be
placed under doc folder.
This will enhance the doc structure will make it easier
for the users to search the docs as it get more populated.

Signed-off-by: yati1998 <ypadia@redhat.com>
2024-10-29 15:21:36 +00:00
Robert Vasek
ed3c916771 doc: added notes about --logslowopinterval cmd arg
Signed-off-by: Robert Vasek <robert.vasek@clyso.com>
2024-09-20 08:55:17 +00:00
Madhu Rajanna
bdd4c077ce doc: fix codespell problem
fixed codespell problems found
in the CI run

Signed-off-by: Madhu Rajanna <madhupr007@gmail.com>
2024-09-04 10:13:47 +00:00
Niraj Yadav
91b8efe473 doc: Remove the 400 snapshot limitation
The support for more than 400 snapshots was
added at: https://github.com/ceph/ceph/pull/38553

This patch also removes the note regarding
deletion of PVCs with snapshots.

Closes: #4681

Signed-off-by: Niraj Yadav <niryadav@redhat.com>
2024-08-27 09:24:35 +00:00
Madhu Rajanna
50c202b5f8 doc: update the upgrade doc
updating the upgrade doc to
point to 3.12.0 doc for upgrades.

Signed-off-by: Madhu Rajanna <madhupr007@gmail.com>
2024-08-14 15:11:41 +00:00
Niels de Vos
d06497cf32 doc: add description of Mergify commands for merging a PR
Signed-off-by: Niels de Vos <ndevos@ibm.com>
2024-08-09 10:06:28 +00:00
Andreas
89ccbc8fba cephfs: support omap data store in radosnamespace via cli argument
Signed-off-by: Andreas <zerotens@users.noreply.github.com>
2024-07-30 07:13:48 +00:00
Niels de Vos
dce8561f33 doc: update coding guideline to suggest to place local imports last
It seems very common in other Go based projects to place the local
packages in the import statement last. Currently Ceph-CSI expects the
imports to group the local packages immediately after standard packages.
This exception compared to other projects often requires new
contributors to 'correct' their PR.

Following a more common convention for grouping imports should make it a
little easier to contribute to the project.

Signed-off-by: Niels de Vos <ndevos@ibm.com>
2024-07-23 13:04:46 +00:00
black-dragon74
64c5be5242 doc: Update docs for rbd-pv-key-rotation
This commit updates the key rotation docs with the following changes:

- Do not call LuksVerify
- Mention specifics of RWX volumes
- Rename the file to represent RBD backed volumes

Signed-off-by: black-dragon74 <niryadav@redhat.com>
2024-07-19 07:15:41 +00:00
black-dragon74
4be5e4cbca doc: proposal for providing PV key rotation
The design and implementation details for rotating
the encryption keys for volumes.

Signed-off-by: black-dragon74 <niryadav@redhat.com>
2024-07-19 07:15:41 +00:00
Rakshith R
04670a8b4d doc: add steps for upgrading from 3.10 to 3.11
This commit adds steps for upgrading from 3.10
to 3.11.

Signed-off-by: Rakshith R <rar@redhat.com>
2024-04-02 08:07:30 +00:00
Dmitriy Alekseev
6c43789de4 doc: Update capabilities readme to solve to open permissions
Signed-off-by: Dmytro Alieksieiev <1865999+dragoangel@users.noreply.github.com>
2024-03-13 17:07:28 +00:00
Praveen M
b2087e4517 doc: added docs for Azure KMS
Signed-off-by: Praveen M <m.praveen@ibm.com>
2024-03-13 14:46:41 +00:00
Madhu Rajanna
200fbdbf28 doc: fix fsName details in PV object
fsName is optional and its required
to mount the filesystem incase if we have
multiple filesystem in the cluster.

Signed-off-by: Madhu Rajanna <madhupr007@gmail.com>
2024-01-12 18:27:45 +00:00
Rakshith R
de118b6a8d doc: add steps for upgrading from 3.9 to 3.10
This commit adds steps for upgrading from 3.9
to 3.10.

Signed-off-by: Rakshith R <rar@redhat.com>
2023-11-28 12:27:29 +00:00
Ruslan Khizhnyak
ec29ec1ac2 helm: add extraDeploy option
To deploy additional manifests with the release.

Signed-off-by: Ruslan Khizhnyak <mustdiechik@gmail.com>
2023-11-23 13:50:44 +00:00
Riya Singhal
5e80c6aee0 rebase: install libcephfs-devel
Signed-off-by: Riya Singhal <rsinghal@redhat.com>
2023-11-23 00:55:17 +00:00
Praveen M
00c12b396f doc: add documentation for read affinity
This commit adds documentation about read affinity supported
for CephFS subvolumes.

Signed-off-by: Praveen M <m.praveen@ibm.com>
2023-11-22 13:13:01 +00:00
Praveen M
4ee466b4b4 doc: updated doc for kernel/fuse mount options
Signed-off-by: Praveen M <m.praveen@ibm.com>
2023-11-15 11:43:27 +00:00
Praveen M
5df2a23f43 doc: updated doc for subvolumegroup creation
Signed-off-by: Praveen M <m.praveen@ibm.com>
2023-11-10 11:41:35 +00:00
Praveen M
c4e373c72f deploy: support for read affinity options per cluster
Implemented the capability to include read affinity options
for individual clusters within the ceph-csi-config ConfigMap.
This allows users to configure the crush location for each
cluster separately. The read affinity options specified in
the ConfigMap will supersede those provided via command line arguments.

Signed-off-by: Praveen M <m.praveen@ibm.com>
2023-11-08 21:17:00 +00:00
Niels de Vos
95149642cb doc: Add initial design notes for the Health Checker
Signed-off-by: Niels de Vos <ndevos@ibm.com>
2023-11-03 13:41:44 +00:00
Madhu Rajanna
3ea540bf0f util: remove deprecated grpc metrics
This commit removes the deprecated
grpc related code from cephcsi.

fixes: #4122

Signed-off-by: Madhu Rajanna <madhupr007@gmail.com>
2023-11-03 10:04:50 +00:00
Madhu Rajanna
526412d6fb doc: remove unwanted steps from upgrade
removed pending unwanted steps from the
upgrade doc.

Signed-off-by: Madhu Rajanna <madhupr007@gmail.com>
2023-09-19 06:34:08 +00:00
Praveen M
137914b0b4 doc: add info about csi snapshot deployment
This commit includes reference to CSI snapshot CRDs
deployment guide.

Signed-off-by: Praveen M <m.praveen@ibm.com>
2023-09-14 14:53:48 +00:00
Madhu Rajanna
32a58f4e58 doc: remove storageclass details for shallow volume
As shallow volumes are default for ROX pvc from
snapshot, removing the details from doc for better
clarity.

Signed-off-by: Madhu Rajanna <madhupr007@gmail.com>
2023-09-14 13:54:18 +00:00
Madhu Rajanna
4560ae83a9 doc: remove unwanted PSP and clusterrole
There are few PSP and clusterrole which does
not exists anymore in cephcsi, removing it
from the upgrade doc for the same reason.

Signed-off-by: Madhu Rajanna <madhupr007@gmail.com>
2023-09-14 09:36:48 +00:00
Madhu Rajanna
95df0791f2 doc: remove support matrix for Snapshot
As Beta CRD is not supported and also
mentioned kubernetes versions are also
not supported anymore, Removing the
details from the doc for the same reason.

Signed-off-by: Madhu Rajanna <madhupr007@gmail.com>
2023-09-14 09:36:48 +00:00
Madhu Rajanna
7c0ce53eeb doc: add design doc for QoS
Add design doc for QoS for rbd
devices mapped with both krbd
and rbd-nbd

closes: #521

Signed-off-by: Madhu Rajanna <madhupr007@gmail.com>
2023-09-07 13:28:18 +00:00
rakshith-r
4eb2dbd4f2 doc: adding empty storageClassName in static pvc
we need to add `storageClassName: ""` in cephfs static pvc
similar what was done for rbd static pvc in #4010.

Signed-off-by: Rakshith R <rar@redhat.com>
2023-09-07 06:54:38 +00:00
subhamkrai
1b2e20081f doc: adding empty storageClassName in static pvc
we need to add `storageClassName: ""` in static pvc
yaml other we'll get error
```
Cannot bind to requested volume "fs-static-pv": storageClassName does not match
```

Signed-off-by: subhamkrai <srai@redhat.com>
2023-07-24 11:19:44 +00:00
Niels de Vos
489d0ff1a6 doc: remove /retest all command for Jenkins jobs
`/retest all` causes a spike in resource consumption in Jenkins and the
OpenShift cluster kills the Pod. That means tests are not fully running
yet, and results never arrive back in the PR. Instead of `/retest all`,
the `ok-to-test` label can be used to trigger required tests with a
slight delay between each command.

Signed-off-by: Niels de Vos <ndevos@ibm.com>
2023-07-04 12:38:39 +00:00
Rakshith R
d4fc23ece0 doc: add steps for upgrading from 3.8 to 3.9
This commit adds steps for upgrading from 3.8
to 3.9.

Signed-off-by: Rakshith R <rar@redhat.com>
2023-06-26 14:10:17 +00:00
karthik-us
6ac3a4dabc cleanup: Move common files to deploy folder
Few common files related to deployments were kept
in the examples folder initially. Moving them to
deploy folder and updating the relevant files.

Signed-off-by: karthik-us <ksubrahm@redhat.com>
2023-06-07 12:51:43 +00:00
Niels de Vos
ea3cd2b5e4 doc: use the Ceph Slack instance and not our silo'ed own one
Currently the Ceph-CSI community is on the 'free' Slack instance at
https://cephcsi.slack.com. The Ceph project uses a Slack instance that
we can use for Ceph-CSI as well. In order to integrate more with other
Ceph projects, we should ideally be active on the same Slack instance.

For now, we have `#ceph-csi` as only channel on the
https://ceph-storage-slack.com, we can add more channels if needed.

See-also: https://ceph.io/en/community/connect/
Signed-off-by: Niels de Vos <ndevos@ibm.com>
2023-04-27 07:58:15 +00:00
Madhu Rajanna
5cd2930744 doc: remove reference to imageFormat
we dont support imageFormat anymore in
cephcsi and default is set to 2, removing
its reference from the repo.

Signed-off-by: Madhu Rajanna <madhupr007@gmail.com>
2023-04-25 13:26:11 +00:00
karthik-us
fb930243a8 doc: Correct few doc errors
Fixes the typos in deploy-cephfs and development-guide docs.

Signed-off-by: karthik-us <ksubrahm@redhat.com>
2023-04-21 10:56:26 +00:00
Niels de Vos
a4678200e5 rbd: allow setting mkfsOptions in the StorageClass
Add `mkfsOptions` to the StorageClass and pass them to the `mkfs`
command while creating the filesystem on the RBD device.

Fixes: #374
Signed-off-by: Niels de Vos <ndevos@ibm.com>
2023-03-08 16:26:39 +00:00
Madhu Rajanna
5de4c2a970 doc: upgrade doc from 3.7 to 3.8
updating upgrade document from 3.7
to 3.8.0

Signed-off-by: Madhu Rajanna <madhupr007@gmail.com>
2023-02-22 08:38:25 +00:00
riya-singhal31
b28b5e6c84 cephfs: use shallow volumes for the ROX accessMode
this commit makes shallow volume as default feature for ROX volumes.

Signed-off-by: riya-singhal31 <rsinghal@redhat.com>
2023-02-21 20:09:13 +00:00
Rakshith R
db8320ce51 doc: add documentation regarding read affinity
This commit adds documentation about read affinity supported
for rbd volumes.

Signed-off-by: Rakshith R <rar@redhat.com>
2023-02-14 08:29:46 +00:00
Humble Chirammal
9c509aaaee doc: correct typo in kernel client recovery section
This commit correct a typo in the kernel mount recovery part.

Signed-off-by: Humble Chirammal <hchiramm@redhat.com>
2023-01-16 11:05:39 +00:00
Lennart Jern
e6c97b9593 cleanup: Fix paths and syntax
Minor cleanup of changed paths and deprecated syntax

Signed-off-by: Lennart Jern <lennart.jern@est.tech>
2023-01-10 08:00:39 +00:00
Marcel Lauhoff
82ea8fea93 doc: Briefly document CephFS fscrypt support
Add encrypted, encryptionKMSID to the parameters list. Briefly document
the fscrypt CephFS support.

Signed-off-by: Marcel Lauhoff <marcel.lauhoff@suse.com>
2022-12-12 13:32:59 +00:00
Marcel Lauhoff
6881b3ad3d doc: Add encryptionType to RBD parameters list
Add the new parameter encryptionType and a hint to the encrypted
parameter that RBD now supports fscrypt on ext4 as an alternative
encryption scheme.

Signed-off-by: Marcel Lauhoff <marcel.lauhoff@suse.com>
2022-12-12 13:32:59 +00:00
riya-singhal31
539686329f ci: fix mdl related failures
This commit address the issue-
https://github.com/ceph/ceph-csi/issues/3448.

Signed-off-by: riya-singhal31 <rsinghal@redhat.com>
2022-11-17 08:25:10 +00:00
Humble Chirammal
ea806bfa73 docs: update/correct development guide
the pre-commit version in the developement guide was too outdated
which has been updated and this commit also addressed a typo.

Signed-off-by: Humble Chirammal <hchiramm@redhat.com>
2022-11-14 20:46:41 +00:00
Humble Chirammal
24fb43d30d doc: correct csi configuration references in the deployment
this commit correct the csi configuration documentation in
rbd deployment doc.

Signed-off-by: Humble Chirammal <hchiramm@redhat.com>
2022-11-10 10:16:37 +00:00
Humble Chirammal
0c06233f40 doc: remove uid/gid mgr issue from the deployment doc
this issue has been already fixed long back and available with
ceph backports. We no longer require this mention in the docs.

Signed-off-by: Humble Chirammal <hchiramm@redhat.com>
2022-11-10 10:16:37 +00:00