Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: modify README and upgrade docs #3933

Merged
merged 2 commits into from
Jun 26, 2023
Merged

doc: modify README and upgrade docs #3933

merged 2 commits into from
Jun 26, 2023

Conversation

Rakshith-R
Copy link
Contributor

  • 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

  • doc: add steps for upgrading from 3.8 to 3.9

This commit adds steps for upgrading from 3.8
to 3.9.

@Rakshith-R Rakshith-R added component/docs Issues and PRs related to documentation ci/skip/e2e skip running e2e CI jobs ci/skip/multi-arch-build skip building on multiple architectures labels Jun 26, 2023
@Rakshith-R Rakshith-R requested review from nixpanic, humblec, Madhu-1 and a team June 26, 2023 05:52
karthik-us
karthik-us reviewed Jun 26, 2023
View reviewed changes
docs/ceph-csi-upgrade.md Outdated
- [Upgrading from v3.4 to v3.5](#upgrading-from-v34-to-v35)
- [Upgrading from v3.5 to v3.6](#upgrading-from-v35-to-v36)
- [Upgrading from v3.6 to v3.7](#upgrading-from-v36-to-v37)
- [Upgrading from v3.7 to v3.8](#upgrading-from-v37-to-v38)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A small suggestion:
Instead of having seperate bullet points or headings for each of these older releases, I thik it is better to have it under one heading like Upgrading from deprecated versions. It will make the doc look cleaner, instead of having seperate headings for each release verion which has just a single line to refer to another section. With this, all the older release upgrade steps can be listed under one heading with a list of references to the relevant sections. Otherwise in the future, this doc would be filled with such a long list of upgrade headings and their reference links. I feel the current number of such headings itself is already long.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

@Madhu-1
Copy link
Collaborator

Madhu-1 commented Jun 26, 2023

CI is failing

@Rakshith-R Rakshith-R force-pushed the release-3.9-docs branch 3 times, most recently from 4c6f0af to a9f2c91 Compare June 26, 2023 07:14
@Rakshith-R
Copy link
Contributor Author

CI is finally green 😮‍💨
ptal

karthik-us
karthik-us reviewed Jun 26, 2023
View reviewed changes
docs/ceph-csi-upgrade.md Outdated
StorageClass's `MountOptions` during both `NodeStage` (kernel cephfs or
ceph-fuse mount operation) and `NodePublish` (bind mount) operations.
Therefore, only common options that is acceptable during both the above
described operation needs to be set in StorageClass's `MountOptions`.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/operation/operations

karthik-us
karthik-us reviewed Jun 26, 2023
View reviewed changes
README.md Outdated
@@ -56,10 +56,8 @@ environments.

| Ceph CSI Version | Container Orchestrator Name | Version Tested|
| -----------------| --------------------------- | --------------|
| v3.8.0 | Kubernetes | v1.25, v1.26, v1.27|
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/v3.8.0/v3.9.0

karthik-us
karthik-us suggested changes Jun 26, 2023
View reviewed changes
Copy link
Collaborator

@karthik-us karthik-us left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small nits.

@Rakshith-R Rakshith-R force-pushed the release-3.9-docs branch 2 times, most recently from f7619c9 to af1f3a7 Compare June 26, 2023 08:54
@Rakshith-R Rakshith-R requested review from karthik-us and a team and removed request for karthik-us June 26, 2023 08:55
yati1998
yati1998 previously approved these changes Jun 26, 2023
View reviewed changes
riya-singhal31
riya-singhal31 previously approved these changes Jun 26, 2023
View reviewed changes
Madhu-1
Madhu-1 requested changes Jun 26, 2023
View reviewed changes
Copy link
Collaborator

@Madhu-1 Madhu-1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you possibly create a tracker to eliminate any outdated steps in the upgrade document that are no longer applicable to the latest releases?

README.md Outdated
For example, if the Ceph CSI latest major version is `3.8.0` today, support is
provided for the versions above `3.7.0`. If users are running an unsupported
For example, if the Ceph CSI latest major version is `3.9.0` today, support is
provided for the versions above `3.9.0`. If users are running an unsupported
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
provided for the versions above `3.9.0`. If users are running an unsupported
provided for the versions above `3.8.0`. If users are running an unsupported

docs/ceph-csi-upgrade.md Outdated
Comment on lines 236 to 237
StorageClass's `MountOptions` during both `NodeStage` (kernel cephfs or
ceph-fuse mount operation) and `NodePublish` (bind mount) operations.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
StorageClass's `MountOptions` during both `NodeStage` (kernel cephfs or
ceph-fuse mount operation) and `NodePublish` (bind mount) operations.
StorageClass's `MountOptions` during both `NodeStageVolume` (kernel cephfs or
ceph-fuse mount operation) and `NodePublishVolume` (bind mount) operations.

docs/ceph-csi-upgrade.md Outdated

Follow the below steps to update the PersistentVolume's `MountOptions`:

- Identify cephfs PersistentVolumes using
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Identify cephfs PersistentVolumes using
Identify cephFS PersistentVolumes using

docs/ceph-csi-upgrade.md Outdated
Therefore, only common options that is acceptable during both the above
described operations needs to be set in StorageClass's `MountOptions`.
If invalid mount options are set in StorageClass's `MountOptions`
such as `"debug"`, the mounting of cephfs PVCs will fail.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
such as `"debug"`, the mounting of cephfs PVCs will fail.
such as `"debug"`, the mounting of cephFS PVCs will fail.

@Rakshith-R Rakshith-R mentioned this pull request Jun 26, 2023
Closed
@Rakshith-R
doc: update README for v3.9.0 release
2586156 
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>
@Rakshith-R
doc: add steps for upgrading from 3.8 to 3.9
bd11fc7 
This commit adds steps for upgrading from 3.8
to 3.9.

Signed-off-by: Rakshith R <rar@redhat.com>
@mergify mergify bot dismissed stale reviews from riya-singhal31 and yati1998 June 26, 2023 09:34

Pull request has been modified.

@Rakshith-R Rakshith-R requested a review from Madhu-1 June 26, 2023 09:45
@Rakshith-R
Copy link
Contributor Author

Could you possibly create a tracker to eliminate any outdated steps in the upgrade document that are no longer applicable to the latest releases?

@Madhu-1 , I've created a tracker #3934 .
I'll add the section link after this pr is merged.

Madhu-1
Madhu-1 approved these changes Jun 26, 2023
View reviewed changes
Copy link
Collaborator

@Madhu-1 Madhu-1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, Can you please also send a follow-up PR for mergify changes?

@Madhu-1 Madhu-1 added the ok-to-test Label to trigger E2E tests label Jun 26, 2023
@ceph-csi-bot
Copy link
Collaborator

/test ci/centos/k8s-e2e-external-storage/1.25

@ceph-csi-bot
Copy link
Collaborator

/test ci/centos/k8s-e2e-external-storage/1.26

@ceph-csi-bot
Copy link
Collaborator

/test ci/centos/k8s-e2e-external-storage/1.27

@ceph-csi-bot
Copy link
Collaborator

/test ci/centos/mini-e2e-helm/k8s-1.25

@ceph-csi-bot
Copy link
Collaborator

/test ci/centos/mini-e2e-helm/k8s-1.26

@ceph-csi-bot
Copy link
Collaborator

/test ci/centos/mini-e2e-helm/k8s-1.27

@ceph-csi-bot
Copy link
Collaborator

/test ci/centos/mini-e2e/k8s-1.25

@ceph-csi-bot
Copy link
Collaborator

/test ci/centos/mini-e2e/k8s-1.26

@ceph-csi-bot
Copy link
Collaborator

/test ci/centos/mini-e2e/k8s-1.27

@ceph-csi-bot
Copy link
Collaborator

/test ci/centos/upgrade-tests-cephfs

@ceph-csi-bot
Copy link
Collaborator

/test ci/centos/upgrade-tests-rbd

@ceph-csi-bot ceph-csi-bot removed the ok-to-test Label to trigger E2E tests label Jun 26, 2023
@mergify mergify bot merged commit d4fc23e into ceph:devel Jun 26, 2023
14 checks passed
@Rakshith-R
Copy link
Contributor Author

@Mergifyio backport release-v3.9

@mergify
Copy link
Contributor

mergify bot commented Jun 26, 2023 •
edited
Loading

backport release-v3.9

✅ Backports have been created

This was referenced Jun 26, 2023
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@karthik-us karthik-us karthik-us approved these changes

@Madhu-1 Madhu-1 Madhu-1 approved these changes

@riya-singhal31 riya-singhal31 riya-singhal31 approved these changes

@nixpanic nixpanic Awaiting requested review from nixpanic

@humblec humblec Awaiting requested review from humblec

@yati1998 yati1998 Awaiting requested review from yati1998

Assignees
No one assigned
Labels
ci/skip/e2e skip running e2e CI jobs ci/skip/multi-arch-build skip building on multiple architectures component/docs Issues and PRs related to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@Rakshith-R @Madhu-1 @ceph-csi-bot @karthik-us @yati1998 @riya-singhal31