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

Jump to bottom

docs: ceph: add peer spec migration to upgrade doc #8435

Merged
merged 2 commits into from Sep 15, 2021
Merged

docs: ceph: add peer spec migration to upgrade doc #8435

merged 2 commits into from Sep 15, 2021

Conversation

BlaineEXE
Copy link
Member

Add a section to the upgrade doc instructing users to (and how to)
migrate CephRBDMirror peers spec to individual CephBlockPools.
Adjust the pending release notes to refer to the upgrade section now,
and clean up a few references in related docs to make sure users don't
miss important documentation.

Signed-off-by: Blaine Gardner blaine.gardner@redhat.com

Description of your changes:

Which issue is resolved by this Pull Request:
Resolves #

Checklist:

  • Commit Message Formatting: Commit titles and messages follow guidelines in the developer guide.
  • Skip Tests for Docs: Add the flag for skipping the build if this is only a documentation change. See here for the flag.
  • Skip Unrelated Tests: Add a flag to run tests for a specific storage provider. See test options.
  • Reviewed the developer guide on Submitting a Pull Request
  • Documentation has been updated, if necessary.
  • Unit tests have been added, if necessary.
  • Integration tests have been added, if necessary.
  • Pending release notes updated with breaking and/or notable changes, if necessary.
  • Upgrade from previous release is tested and upgrade user guide is updated, if necessary.
  • Code generation (make codegen) has been run to update object specifications, if necessary.

@BlaineEXE BlaineEXE requested review from leseb, travisn and sp98 July 29, 2021 16:58
BlaineEXE
BlaineEXE commented Jul 29, 2021
View reviewed changes
Documentation/ceph-pool-crd.md
* `interval`: frequency of the snapshots. The interval can be specified in days, hours, or minutes using d, h, m suffix respectively.
* `startTime`: optional, determines at what time the snapshot process starts, specified using the ISO 8601 time format.
* `peers`: to configure mirroring peers
* `secretNames`: a list of peers to connect to. Currently (Ceph Octopus release) **only a single** peer is supported where a peer represents a Ceph cluster.
Copy link
Member Author

@BlaineEXE BlaineEXE Jul 29, 2021 •
edited

Choose a reason for hiding this comment

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

I don't think the (Ceph Octopus release) sidebar here is particularly useful for users. This only becomes relevant once a Ceph version does support multiple peers.

@BlaineEXE BlaineEXE added this to In progress in v1.7 via automation Jul 29, 2021
v1.7 automation moved this from In progress to Review in progress Jul 30, 2021
sp98
sp98 requested changes Jul 30, 2021
View reviewed changes
PendingReleaseNotes.md Outdated
@@ -40,7 +40,9 @@ So the CephCLuster spec field `image` must be updated to point to quay, like `im
- Add support for Kubernetes TLS secret for referring TLS certs needed for ceph RGW server.
- Stretch clusters are considered stable
- Ceph v16.2.5 or greater is required for stretch clusters
- The use of peer secret names in CephRBDMirror is deprecated. Please use CephBlockPool CR to configure peer secret names and import peers. Checkout the `mirroring` section in the CephBlockPool [spec](Documentation/ceph-pool-crd.md#spec) for more details.
- The use of `peer.secretNames` in `CephRBDMirror` is deprecated. Please use `CephBlockPool`s to
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- The use of `peer.secretNames` in `CephRBDMirror` is deprecated. Please use `CephBlockPool`s to
- The use of `peer.secretNames` in `CephRBDMirror` is deprecated. Please use `CephBlockPool` to

?

Documentation/ceph-upgrade.md Outdated

The pre-existing config location in `CephRBDMirror` `spec.peers` will continue to be supported for
this release. Users are required to migrate this setting from `CephRBDMirror` to
relevant `CephBlockPool` resources but may do so any time before upgrading to Rook v1.8.
Copy link
Contributor

Choose a reason for hiding this comment

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

@leseb I thought we won't be removing the spec.peers in CephRBDMirror. Is that not the case now? (asking because we are suggesting it would be removed in the upgrade doc)

Copy link
Member

Choose a reason for hiding this comment

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

Yes, there is no plan to remove it concretely yet. So let's remove that statement for now :) .

@mergify
Copy link

mergify bot commented Aug 2, 2021

This pull request has merge conflicts that must be resolved before it can be merged. @BlaineEXE please rebase it. https://rook.io/docs/rook/master/development-flow.html#updating-your-fork

@leseb
Copy link
Member

leseb commented Sep 9, 2021

@BlaineEXE can we resume this? Thanks

@BlaineEXE
docs: ceph: add peer spec migration to upgrade doc
91ec1ac 
Add a section to the upgrade doc instructing users to (and how to)
migrate `CephRBDMirror` `peers` spec to individual `CephBlockPools`.
Adjust the pending release notes to refer to the upgrade section now,
and clean up a few references in related docs to make sure users don't
miss important documentation.

Signed-off-by: Blaine Gardner <blaine.gardner@redhat.com>
@BlaineEXE BlaineEXE force-pushed the upgrade-doc-add-mirroring-changes branch from d848df8 to 91ec1ac Compare September 9, 2021 17:47
BlaineEXE
BlaineEXE commented Sep 9, 2021
View reviewed changes
Documentation/ceph-upgrade.md
Comment on lines +387 to +389
The pre-existing config location in `CephRBDMirror` `spec.peers` will continue to be supported, but
users are still encouraged to migrate this setting from `CephRBDMirror` to relevant `CephBlockPool`
resources.
Copy link
Member Author

Choose a reason for hiding this comment

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

@sp98 @leseb is this still a good statement to make in the upgrade guide for 1.7?

Copy link
Member

Choose a reason for hiding this comment

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

Yes it is.

@leseb leseb requested a review from sp98 September 14, 2021 09:40
@sp98
Copy link
Contributor

sp98 commented Sep 14, 2021

ceph rbd mirror doc still suggesting to configure mirror peers. Should we remove that or add a not over there to use ceph block pools instead ? @BlaineEXE

@BlaineEXE
docs: update rbd mirror docs for block pool config
7c51132 
Remove legacy documentation for configuring RBD mirroring. While we
still support legacy mirroring configs, we want to encourage new users
to use the CephBlockPool configuration for mirroring.

Signed-off-by: Blaine Gardner <blaine.gardner@redhat.com>
@BlaineEXE
Copy link
Member Author

@sp98 (and @leseb) I also added a new commit per your recent question/suggestion. If it doesn't sound right, I can easily remove the commit.

Remove legacy documentation for configuring RBD mirroring. While we
still support legacy mirroring configs, we want to encourage new users
to use the CephBlockPool configuration for mirroring.

@leseb leseb merged commit c4a6473 into rook:master Sep 15, 2021
v1.7 automation moved this from Review in progress to Done Sep 15, 2021
@mergify mergify bot mentioned this pull request Sep 15, 2021
Merged
mergify bot added a commit that referenced this pull request Sep 15, 2021
@mergify
Merge pull request #8717 from rook/mergify/bp/release-1.7/pr-8435
65a9db4 
docs: ceph: add peer spec migration to upgrade doc (backport #8435)
@BlaineEXE BlaineEXE deleted the upgrade-doc-add-mirroring-changes branch September 15, 2021 21:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@leseb leseb leseb approved these changes

@sp98 sp98 sp98 approved these changes

@travisn travisn Awaiting requested review from travisn

Assignees
No one assigned
Labels
ceph main ceph tag docs skip-ci upgrade
Projects
No open projects
v1.7
Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@BlaineEXE @leseb @sp98