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

doc/architecture: edit "High Avail. Monitors" #53444

Merged
merged 1 commit into from Sep 14, 2023

Conversation

zdover23
Copy link
Contributor

@zdover23 zdover23 commented Sep 13, 2023

Improve the sentence structure in the "High Availability Monitors" section of doc/architecture.rst.

Contribution Guidelines

Checklist

  • Tracker (select at least one)
    • References tracker ticket
    • Very recent bug; references commit where it was introduced
    • New feature (ticket optional)
    • Doc update (no ticket needed)
    • Code cleanup (no ticket needed)
  • Component impact
    • Affects Dashboard, opened tracker ticket
    • Affects Orchestrator, opened tracker ticket
    • No impact that needs to be tracked
  • Documentation (select at least one)
    • Updates relevant documentation
    • No doc update is appropriate
  • Tests (select at least one)
Show available Jenkins commands
  • jenkins retest this please
  • jenkins test classic perf
  • jenkins test crimson perf
  • jenkins test signed
  • jenkins test make check
  • jenkins test make check arm64
  • jenkins test submodules
  • jenkins test dashboard
  • jenkins test dashboard cephadm
  • jenkins test api
  • jenkins test docs
  • jenkins render docs
  • jenkins test ceph-volume all
  • jenkins test ceph-volume tox
  • jenkins test windows

@zdover23 zdover23 requested a review from a team as a code owner September 13, 2023 14:11

For details on configuring monitors, see the `Monitor Config Reference`_.
A Ceph Client must contact a Ceph Monitor and obtain a current copy of the
cluster map in order to be permitted to read data from or to write data to the
Copy link
Contributor

Choose a reason for hiding this comment

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

s/be permitted to//

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good eye. Accepted.

Ceph cluster.

It is possible for a Ceph cluster to function properly with only a single
monitor in it, but a Ceph cluster that has only a single monitor in it has a
Copy link
Contributor

Choose a reason for hiding this comment

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

s/ in it//g

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good eye here, too. Accepted.

single point of failure: if the monitor goes down, Ceph clients will be unable
to read data from or write data to the cluster.

Ceph supports a cluster of monitors in order to increase reliability and fault
Copy link
Contributor

Choose a reason for hiding this comment

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

s/supports/leverages/

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is that rarest of cases: the time when I think that "leveraged" is, in fact, the right word.

Accepted.

Copy link
Contributor

Choose a reason for hiding this comment

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

Ever since I read that "utilize" doesn't mean what I think it means I've shied away from it.

Improve the sentence structure in the "High Availability Monitors"
section of doc/architecture.rst.

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
@zdover23 zdover23 force-pushed the wip-doc-2023-09-14-architecture-4-of-x branch from 6c82ceb to 57019c3 Compare September 14, 2023 03:12
@zdover23 zdover23 merged commit 2089353 into ceph:main Sep 14, 2023
11 checks passed
@zdover23
Copy link
Contributor Author

#53451 - Reef backport
#53452 - Quincy backport

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants