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.

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

docs: add note in upgrade guide about cephfs driver's breaking change #12615

Merged
merged 1 commit into from
Aug 1, 2023

Conversation

Rakshith-R
Copy link
Member

Description of your changes:

CephCSI CephFS introduced a breaking change in v3.9.0. This commit adds a note in upgrade guide regarding the same.

refer: https://github.com/ceph/ceph-csi/blob/v3.9.0/docs/ceph-csi-upgrade.md/#upgrading-cephfs

Checklist:

  • Commit Message Formatting: Commit titles and messages follow guidelines in the developer guide.
  • Skip Tests for Docs: If this is only a documentation change, add the label skip-ci on the PR.
  • Reviewed the developer guide on Submitting a Pull Request
  • Pending release notes updated with breaking and/or notable changes for the next minor release.
  • Documentation has been updated, if necessary.
  • Unit tests have been added, if necessary.
  • Integration tests have been added, if necessary.

@@ -49,6 +49,9 @@ those releases.
## Breaking changes in v1.12

* The minimum supported version of Kubernetes is v1.22.
* CephCSI CephFS driver introduced a breaking change in v3.9.0. Please follow the steps mentioned in the
Copy link
Member

Choose a reason for hiding this comment

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

Can you summarize the breaking change in one or two sentences here? In this Rook upgrade guide, they should understand if they are affected, and if it's common. By default, users won't be affected, right? I don't expect it's common to use the mount options. For example, say that if they are setting the mountOptions in a CephFS storage class, they need to follow those instructions in the CSI upgrade guide.

Copy link
Member Author

Choose a reason for hiding this comment

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

👍 yes
Updated mentioning the above suggested details,
Ptal

CephCSI CephFS introduced a breaking change in v3.9.0.
This commit adds a note in upgrade guide regarding the same.

refer: https://github.com/ceph/ceph-csi/blob/v3.9.0/docs/ \
       ceph-csi-upgrade.md/#upgrading-cephfs

Signed-off-by: Rakshith R <rar@redhat.com>
@travisn travisn merged commit c86fce8 into rook:master Aug 1, 2023
17 checks passed
travisn added a commit that referenced this pull request Aug 1, 2023
docs: add note in upgrade guide about cephfs driver's breaking change (backport #12615)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants