Commit Graph

125 Commits

Author SHA1 Message Date
Madhu Rajanna
c2cbb25489 doc: remove contacts from Readme
The twitter and google forum is
not maintained and doesnt have
any updates, This is the good
chance to remove the same from
the cephcsi readme as well.

Signed-off-by: Madhu Rajanna <madhupr007@gmail.com>
2024-09-18 07:02:50 +00:00
Madhu Rajanna
2241e8e074 doc: readme update for 3.12
readme update for 3.12.0 release

Signed-off-by: Madhu Rajanna <madhupr007@gmail.com>
2024-08-14 15:11:41 +00:00
Rakshith R
29dde7abc2 doc: update dev standup day to Monday
This commit updates the standup day of the
week to Monday as agreed upon.

Signed-off-by: Rakshith R <rar@redhat.com>
2024-06-26 07:49:15 +00:00
Ben Tullis
8f7a4c43be doc: Fix the Slack invite link
The link on the README file to get an invite to the Ceph Slack was
missing a URL scheme, so it was interpreted as a relative link and
resulted in a 404.

Signed-off-by: Ben Tullis <btullis@wikimedia.org>
2024-05-22 06:24:37 +00:00
Rakshith R
0e4991ac8b doc: update README for v3.11.0 release
This commit updates README to deprecate 3.9.x release,
add 3.10.1/2 release versions and pin latest release
to v3.11.0

Signed-off-by: Rakshith R <rar@redhat.com>
2024-04-02 08:07:30 +00:00
Lucas Melchior
2217d106c4 doc: remove trailing whitespace
remove trailing whitespace

Signed-off-by: Lucas Melchior <switchboard.op@gmail.com>
2024-02-01 13:12:27 +00:00
Lucas Melchior
4c926d2c00 doc: 80 char per line
added shortened bit.ly link

Signed-off-by: Lucas Melchior <switchboard.op@gmail.com>
2024-02-01 13:12:27 +00:00
Lucas Melchior
2efc4c1700 doc: Update README.md with slack invite and channel links
added updated invite link to the ceph slack workspace

Signed-off-by: Lucas Melchior <switchboard.op@gmail.com>
2024-02-01 13:12:27 +00:00
Rakshith R
b37e4d41b5 doc: update README for v3.10.0 release
This commit updates README to deprecate 3.8.x release
and pin latest release to v3.10.0

Signed-off-by: Rakshith R <rar@redhat.com>
2023-11-28 12:27:29 +00:00
karthik-us
5d57fd3f70 doc: Support matrix update
Updating the support matrix to point to the suppotred ceph release.

Fixes: #4168
Signed-off-by: karthik-us <ksubrahm@redhat.com>
2023-11-23 10:59:12 +00:00
Rakshith R
35eb347eac doc: update documentation for v3.8.1 release
This commit updates readme doc for v3.8.1 release.

Signed-off-by: Rakshith R <rar@redhat.com>
2023-07-21 17:23:59 +00:00
Rakshith R
ef8ffb4c57 doc: update README for v3.9.0 release
This commit updates README to deprecate 3.7.x release
and pin latest release to v3.9.0

Signed-off-by: Rakshith R <rar@redhat.com>
2023-06-26 14:10:17 +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
riya-singhal31
c8f6878570 doc: update readme as kubernetes 1.27 is released
Signed-off-by: riya-singhal31 <rsinghal@redhat.com>
2023-04-26 15:13:54 +00:00
riya-singhal31
e8d6dc9fab doc: fix ceph version name in support matrix
Signed-off-by: riya-singhal31 <rsinghal@redhat.com>
2023-04-13 14:14:25 +00:00
riya-singhal31
bd58855002 doc: update the meeting schedule in readme
Signed-off-by: riya-singhal31 <rsinghal@redhat.com>
2023-03-15 12:49:58 +00:00
Madhu Rajanna
ef6aabbfb0 doc: update README for 3.8.0 release
updated README to deprecate 3.6.x release
and pin latest release to 3.8.0

Signed-off-by: Madhu Rajanna <madhupr007@gmail.com>
2023-02-22 08:38:25 +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
6009b7c7cf doc: lift the minimum supported version of ceph to v15.0.0
at present the supported ceph cluster version has been listed with
v14.x.x version of Ceph. However upstream Ceph has dropped its
support for 14.x version and minimum supported release is v15.x

Ref # https://docs.ceph.com/en/quincy/releases/index.html

this commit update the ceph cluster version mention to v15.0.0

Additional Note:
The code should work even for last archived release but we dont
need that mention anymore in the readme.

Signed-off-by: Humble Chirammal <hchiramm@redhat.com>
2022-11-10 10:04:00 +00:00
Madhu Rajanna
53bb28e0d9 doc: update documentation for v3.7.2 release
updated readme and upgrade doc for v3.7.2 release.

Signed-off-by: Madhu Rajanna <madhupr007@gmail.com>
2022-10-19 11:27:05 +00:00
Humble Chirammal
fc89159daf doc: deprecate v3.5 as we are on v3.7
This commit mark v3.5 on deprecated release.

Signed-off-by: Humble Chirammal <hchiramm@redhat.com>
2022-09-14 04:26:03 +00:00
Humble Chirammal
a799075cfc doc: update doc for 3.7.1 release
updated doc for 3.7.1 release is available with this commit.

Signed-off-by: Humble Chirammal <hchiramm@redhat.com>
2022-09-14 04:26:03 +00:00
Humble Chirammal
1e2a777d67 doc: update documentation for release 3.7.0
This commit add upgrade documentation for release 3.7.0
and also update support matrix for v3.7.0.

Signed-off-by: Humble Chirammal <hchiramm@redhat.com>
2022-08-18 15:58:45 +00:00
Anthony D'Atri
56d7d3cd15 doc: minor cleanup
Signed-off-by: Anthony D'Atri <anthonyeleven@users.noreply.github.com>
2022-08-01 04:29:34 +00:00
Rakshith R
d405c924b4 doc: mention support for nfs snapshot, restore & clone
NFS now supports snapshot, restore and pvc-pvc clone.

Signed-off-by: Rakshith R <rar@redhat.com>
2022-05-24 18:13:02 +00:00
Niels de Vos
cbd7220b37 doc: mention ExpandVolume support for NFS in the README
Signed-off-by: Niels de Vos <ndevos@redhat.com>
2022-05-10 17:43:59 +00:00
Niels de Vos
43fe5c34cd doc: add Mergify badge to README
We heavily use the service for Open Source communities from Mergify. It
is probably nice to promote them a little in our README.

Signed-off-by: Niels de Vos <ndevos@redhat.com>
2022-05-04 06:15:16 +00:00
Niels de Vos
b036537e1c doc: add Open Source Security Foundation (OpenSSF) best practices badge
The project is currently at 54% of the best practices. Hopefully this
badge creates some interest in increasing the grade.

See-also: https://bestpractices.coreinfrastructure.org/projects/5940
Signed-off-by: Niels de Vos <ndevos@redhat.com>
2022-04-25 06:17:56 +00:00
Madhu Rajanna
432787fee2 doc: add new hackmd link for meeting minutes
replaced google doc link with new hackmd
link for upstream meetings.

Signed-off-by: Madhu Rajanna <madhupr007@gmail.com>
2022-04-22 12:52:23 +00:00
Madhu Rajanna
5e1a074ea3 doc: update doc for 3.6.1 release
updated doc for 3.6.1 release, this will
be backported to release-v3.6 branch and
we will make deployment changes and do release.

Signed-off-by: Madhu Rajanna <madhupr007@gmail.com>
2022-04-22 09:05:09 +00:00
Humble Chirammal
2bb5ca9dbc doc: move release 3.4.0 to unsupported version
As we have 3.6.0 release available now, moving 3.4.0
to unsupported version.

Signed-off-by: Humble Chirammal <hchiramm@redhat.com>
2022-04-06 09:49:00 +00:00
Humble Chirammal
32ecbdeb71 doc: update documentation for release 3.6.0
This commit add upgrade documentation for release 3.6.0
and also update support matrix for v3.6.0.

Signed-off-by: Humble Chirammal <hchiramm@redhat.com>
2022-04-04 13:29:08 +00:00
Niels de Vos
591cd694ab doc: mark NFS support Alpha state
There is currently no e2e testing, unit-tests or Helm Chart for NFS
support. Until the functionality is confirmed to be working on a regular
basis, support for NFS provisioner volume will be Alpha.

Signed-off-by: Niels de Vos <ndevos@redhat.com>
2022-03-31 14:16:44 +00:00
Madhu Rajanna
6df71410e3 doc: update readme for 3.5.1 release
updated Readme for 3.5.1 release.

Signed-off-by: Madhu Rajanna <madhupr007@gmail.com>
2022-01-24 12:45:31 +00:00
Humble Chirammal
097e339d69 rbd: lift snapshot, clone and metrics to GA version
We have added enough e2e tests and the below functionality is
also proven as working based on the user reports so far. The
support at CO side is also pretty stable for these features.

* snapshot
* clone
* metrics
* RWO/RWX CephFS volumes

This commit lift the support state of above features to GA from next
release onwards.

Signed-off-by: Humble Chirammal <hchiramm@redhat.com>
2022-01-19 04:35:28 +00:00
Humble Chirammal
41c7725c8c doc: move 3.3.0 and 3.3.1 to deprecated release
With the release v3.5, as per support policy we can mark
v3.3.0 and 3.3.1 to be in deprecated release list

Signed-off-by: Humble Chirammal <hchiramm@redhat.com>
2022-01-17 12:53:41 +00:00
Humble Chirammal
f9c368f225 doc: update support matrix for release 3.5
This commit adds release 3.5 to the release support matrix.

Signed-off-by: Humble Chirammal <hchiramm@redhat.com>
2022-01-14 18:18:16 +00:00
Humble Chirammal
d0b846772a doc: add RWOP support matrix to README.md
This commit add RWOP support matrix to README

Signed-off-by: Humble Chirammal <hchiramm@redhat.com>
2022-01-11 19:40:22 +00:00
Madhu Rajanna
2b7fb1bbb1 doc: lift supported ceph version for snapshot/clone
snapshot and clone should be supported from octopus
15.2.4 instead of 15.2.3.

fixes #2732

Signed-off-by: Madhu Rajanna <madhupr007@gmail.com>
2021-12-23 12:28:03 +00:00
Rakshith R
90d246fc55 doc: update dev standup meeting link
Signed-off-by: Rakshith R <rar@redhat.com>
2021-09-30 13:27:11 +00:00
Yati Padia
1cf14cd83c cleanup: rework on naming conventions
This commits replaces cephfs -> cephFS
to maintain consistency throughout the
codebase

Updates: #1465

Signed-off-by: Yati Padia <ypadia@redhat.com>
2021-09-24 06:17:17 +00:00
Humble Chirammal
dda811c195 doc: add 'known to work' CO matrix with versions tested
Signed-off-by: Humble Chirammal <hchiramm@redhat.com>
2021-09-07 04:49:24 +00:00
Humble Chirammal
3417fe86e6 doc: update support matrix for deprecated ceph csi releases
As discussed in https://github.com/ceph/ceph-csi/issues/2438
we are marking ceph csi release support to N.(x-1) release versions.

N = latest major release
x = latest minor release

This address the release version support matrix based on the
same.

Signed-off-by: Humble Chirammal <hchiramm@redhat.com>
2021-08-26 11:39:33 +00:00
Rakshith R
7da796dfc1 doc: add Github release badge to README.md
Signed-off-by: Rakshith R <rar@redhat.com>
2021-08-19 11:48:34 +00:00
Niels de Vos
7d04cf4fe7 doc: add tickgit TODO badge
There are TODO and FIXME comments in the Ceph-CSI source code that need
addressing at one point. Adding this TODO badge and link to tickgit to
the main README makes it obvious that some cleanup is needed.

This might invite new contributors to address reported TODOs.

Signed-off-by: Niels de Vos <ndevos@redhat.com>
2021-08-19 09:37:20 +00:00
Humble Chirammal
7c2cbf473c doc: update readme for 3.4.0 release
Signed-off-by: Humble Chirammal <hchiramm@redhat.com>
2021-08-17 06:57:09 +00:00
Humble Chirammal
d85304c7c2 doc: lift clone feature support to Beta
Since kubernetes 1.16 clone ( create a new volume from exisiing volume)
functionality is at Beta state and kubernetes v1.18, the snapshot functionality
has been lifted to GA. Ceph CSI drivers have been supporting this feature
for last few releases and users are heavily using this feature since then.

We also have good amount of e2e test case which cover volume creation
from PVC backend or iow, PVC as a datasource. With that, this PR
proposes of lifting this feature support to Beta with v3.4.0 version.

Signed-off-by: Humble Chirammal <hchiramm@redhat.com>
2021-07-21 06:57:10 +00:00
Humble Chirammal
69836d7c02 doc: lift snapshot creation/deletion to Beta
Since kubernetes 1.17 snapshot functionality is at Beta state
and external snapshotter 3.0.3. Since v4.0.0 of snapshotter controller
and kubernetes v1.20, the snapshot functionality has been lifted to GA.
Ceph CSI drivers have been supporting this feature for last few releases
and users are heavily using this feature since then.

We also have good amount of e2e test case which cover volume creation
from snapshot backend or iow, snapshot as a datasource. With that, this PR
proposes of lifting this feature support to Beta with v3.4.0 version.

Updates# https://github.com/ceph/ceph-csi/issues/2199

Signed-off-by: Humble Chirammal <hchiramm@redhat.com>
2021-07-21 06:57:10 +00:00
Humble Chirammal
b66f40793f doc: lift snapshot creation/deletion to Beta
Since kubernetes 1.17 snapshot functionality is at Beta state
and external snapshotter 3.0.3. Since v4.0.0 of snapshotter controller
and kubernetes v1.20, the snapshot functionality has been lifted to GA.
Ceph CSI drivers have been supporting this feature for last few releases
and users are heavily using this feature since then.

We also have good amount of e2e test case which cover volume creation
from snapshot backend or iow, snapshot as a datasource. With that, this PR
proposes of lifting this feature support to Beta with v3.4.0 version.

Updates# https://github.com/ceph/ceph-csi/issues/2199

Signed-off-by: Humble Chirammal <hchiramm@redhat.com>
2021-07-21 06:57:10 +00:00
Humble Chirammal
8f3d8f4cfd doc: explicitly mention volume/pv metrics feature
we have volume PV metrics support available in our driver along
with the grpc metrics support (EnableGRPCMetrics) we added in between
for csi operations. The latter is getting deprecated and the current
mention in the support matrix on metrics support confuse many.
This PR explictly mention this support in the docs to volume/PV metrics

This PR also add a seperate row for block mode PV metrics

Signed-off-by: Humble Chirammal <hchiramm@redhat.com>
2021-07-20 16:03:04 +00:00