Skip to content

doc/rbd: refine "Create a Block Device Pool"#49282

Merged
zdover23 merged 1 commit intoceph:mainfrom
zdover23:wip-doc-2022-12-06-rbd-rados-rbd-cmds-create-a-block-device-pool-semantics
Dec 7, 2022
Merged

doc/rbd: refine "Create a Block Device Pool"#49282
zdover23 merged 1 commit intoceph:mainfrom
zdover23:wip-doc-2022-12-06-rbd-rados-rbd-cmds-create-a-block-device-pool-semantics

Conversation

@zdover23
Copy link
Contributor

@zdover23 zdover23 commented Dec 6, 2022 •
edited
Loading

Refine the "Create a Block Device Pool" section of doc/rbd/rados-rbd-cmds.rst.

https://tracker.ceph.com/issues/57001

Signed-off-by: Zac Dover zac.dover@gmail.com

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 December 6, 2022 13:17
@zdover23 zdover23 requested a review from a team as a code owner December 6, 2022 13:17
idryomov
idryomov reviewed Dec 6, 2022
View reviewed changes
doc/rbd/rados-rbd-cmds.rst Outdated
RBD:

rbd pool init <pool-name>
.. prompt:: bash #
Copy link
Contributor

@idryomov idryomov Dec 6, 2022

Choose a reason for hiding this comment

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

# has the "needs to be run as root" connotation:

Suggested change
.. prompt:: bash #
.. prompt:: bash $

Copy link
Contributor Author

@zdover23 zdover23 Dec 7, 2022

Choose a reason for hiding this comment

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

Thanks for that, Ilya. I've changed this to the $ prompt.

@zdover23 zdover23 force-pushed the wip-doc-2022-12-06-rbd-rados-rbd-cmds-create-a-block-device-pool-semantics branch from 538603f to 2bc133f Compare December 7, 2022 04:16
anthonyeleven
anthonyeleven approved these changes Dec 7, 2022
View reviewed changes
Copy link
Contributor

@anthonyeleven anthonyeleven left a comment

Choose a reason for hiding this comment

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

Non-blocking suggestion:

#. On the admin node / toolbox, use

@idryomov
Copy link
Contributor

idryomov commented Dec 7, 2022

Non-blocking suggestion:

#. On the admin node / toolbox, use

I'd drop this bit altogether. "toolbox" isn't mentioned anywhere in the Ceph documentation at all and "admin node" is only mentioned in a couple of places, inconsistently. In reality it could be pretty much any node or container.

Just as an example, "admin node" isn't mentioned in the below "Create a Block Device User" section. However all steps/commands on this page could be executed from the same place -- rbd pool init isn't any different from ceph auth get-or-create or rbd create.

doc/rbd: refine "Create a Block Device Pool"
987d316 
Refine the "Create a Block Device Pool" section of
doc/rbd/rados-rbd-cmds.rst.

https://tracker.ceph.com/issues/57001

Signed-off-by: Zac Dover <zac.dover@gmail.com>
@zdover23 zdover23 force-pushed the wip-doc-2022-12-06-rbd-rados-rbd-cmds-create-a-block-device-pool-semantics branch from 2bc133f to 987d316 Compare December 7, 2022 13:14
@zdover23
Copy link
Contributor Author

zdover23 commented Dec 7, 2022

Non-blocking suggestion:
#. On the admin node / toolbox, use

I'd drop this bit altogether. "toolbox" isn't mentioned anywhere in the Ceph documentation at all and "admin node" is only mentioned in a couple of places, inconsistently. In reality it could be pretty much any node or container.

Just as an example, "admin node" isn't mentioned in the below "Create a Block Device User" section. However all steps/commands on this page could be executed from the same place -- rbd pool init isn't any different from ceph auth get-or-create or rbd create.

@idryomov: I've removed references to "admin node". Check out the text as it stands now and let me know if it looks right to you.

@anthonyeleven
Copy link
Contributor

anthonyeleven commented Dec 7, 2022

Fair enough. The toolbox is the Rook equivalent. We might say something like "a node with the Ceph admin key" but really that's the case for hundreds of commands throughout the docs.

@zdover23 zdover23 merged commit 91bef11 into ceph:main Dec 7, 2022
@zdover23
Copy link
Contributor Author

zdover23 commented Dec 7, 2022

#49307 - Quincy backport
#49308 - Pacific backport

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@idryomov idryomov idryomov approved these changes

@anthonyeleven anthonyeleven anthonyeleven approved these changes

Assignees

No one assigned

Labels

documentation rbd

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@zdover23 @idryomov @anthonyeleven