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: update ceph(8) man page with new sub-commands #16437

Merged
merged 3 commits into from Jul 24, 2017

Conversation

Projects
None yet
2 participants
@tchaikov
Contributor

tchaikov commented Jul 20, 2017

No description provided.

@tchaikov tchaikov added this to the luminous milestone Jul 20, 2017

@tchaikov tchaikov requested a review from liewegas Jul 20, 2017

tchaikov referenced this pull request Jul 20, 2017

doc: add instructions for replacing an OSD
* 8/ceph.rst: `rm` subcommand removes osd from osdmap, not the cluster.
  the latter is more ambiguous in different contexts.
* rados/operations/add-or-rm-osds.rst: add a subsection of "Replacing an
  OSD". update the subsection of "Removing the OSD" with "ceph osd
  purge" command
* release-notes.rst: link from it to the new subsection in add-or-rm-osds.rst

Signed-off-by: Kefu Chai <kchai@redhat.com>
@tchaikov

This comment has been minimized.

Contributor

tchaikov commented Jul 20, 2017

retest this please

@@ -248,6 +248,15 @@ Usage::
ceph df {detail}
features

This comment has been minimized.

@liewegas

liewegas Jul 20, 2017

Member

Features (capitalized)

This comment has been minimized.

@tchaikov

tchaikov Jul 20, 2017

Contributor

this is the command's name. like df and fs. so it should be lowercased, i think.

This comment has been minimized.

@liewegas

liewegas Jul 20, 2017

Member

Oh i see. In that case I wonder if we need a section elsewhere in the docs describing these two commands along with the background and how they work together. And then link to that. ANd keep a more concise description here.

This comment has been minimized.

@tchaikov

tchaikov Jul 20, 2017

Contributor

makes sense! but we organize the commands using underlined subsections, and use double underline for the man pages' standard sections, like "Synopsis", "Options", etc . let me think about how to group these two commands in a more consistent way.

Subcommand ``set-require-min-compat-client`` configures the oldest Ceph client
version allowed to connect to the cluster. Once set, Ceph will prevent you from
enabling features that will break compatibility with those clients. Please note,
This subcommand requires that all connected daemons and clients support the

This comment has been minimized.

@liewegas

liewegas Jul 20, 2017

Member

s/This/this/

This comment has been minimized.

@liewegas

liewegas Jul 20, 2017

Member

It might be worth clarifying that this command doesn't actually change which clients can connect. However, it does prevent you from making any other changes (e.g., crush tunables, or using new features) that would violate the current setting.

Usage::
ceph osd set-require-min-compat-client <version> {--yes-i-really-mean-it}

This comment has been minimized.

@liewegas

liewegas Jul 20, 2017

Member

I would leave off the force argument; the CLI will prompt the user for it only if there are older connected clients.

* You can configure the oldest Ceph client version you wish to allow to
connect to the cluster via ``ceph osd set-require-min-compat-client`` and
Ceph will prevent you from enabling features that will break compatibility
with those clients. FIXME DOCS
with those clients.

This comment has been minimized.

@liewegas

liewegas Jul 20, 2017

Member

I think these should link to the sectino describing these settings in more detail.

features
--------
Show the releases and supported features of all connected daemons and clients, along with the numbers of them in each bucket grouped by the corresponding features/releases.

This comment has been minimized.

@liewegas

liewegas Jul 20, 2017

Member

We should add a bit of background here. Each release of ceph supports a different set of features, expressed by the features bitmask. New cluster features require that clients support the feature or else they are not allowed to connect to the features. As new features or capabilities are enabled after an upgrade, older clients are prevented from connecting.

The features and releases of all clients connected to the cluster can be seen with::

ceph features

Note that this only described clients that are currently connected. Operators should take care to ensure there aren't other client hosts that are currently offline; they may also need to be upgraded.

@tchaikov tchaikov self-assigned this Jul 21, 2017

tchaikov added some commits Jul 20, 2017

doc: document "ceph features"
Signed-off-by: Kefu Chai <kchai@redhat.com>
doc: document "ceph osd set-require-min-compat-client"
Signed-off-by: Kefu Chai <kchai@redhat.com>
doc/rados/operations/add-or-rm-osds: fix dead hyper link
Signed-off-by: Kefu Chai <kchai@redhat.com>
@tchaikov

This comment has been minimized.

Contributor

tchaikov commented Jul 24, 2017

@liewegas fixed and repushed. w.r.t. grouping these two new commands, because set-require-min-compat-client is a subcommand of osd, and features is not, so instead, i added a hyper link, linking from set-require-min-compat-client to ceph features, HTH.

@tchaikov tchaikov removed their assignment Jul 24, 2017

@tchaikov tchaikov requested a review from liewegas Jul 24, 2017

@liewegas liewegas merged commit 126cf70 into ceph:master Jul 24, 2017

3 of 4 checks passed

make check make check failed
Details
Signed-off-by all commits in this PR are signed
Details
Unmodified Submodules submodules for project are unmodified
Details
make check (arm64) make check succeeded
Details

@tchaikov tchaikov deleted the tchaikov:wip-doc-fixes branch Jul 24, 2017

@tchaikov

i will fix these errors in the next PR which addressing yet another FIXME.

@@ -1075,6 +1091,18 @@ Usage::
ceph osd setmaxosd <int[0-]>
Subcommand ``set-require-min-compat-client`` enforces the cluster to be backward
compatible with the specified client version. This subcommand prevent you from

This comment has been minimized.

@tchaikov

tchaikov Jul 24, 2017

Contributor

prevents

@@ -1075,6 +1091,18 @@ Usage::
ceph osd setmaxosd <int[0-]>
Subcommand ``set-require-min-compat-client`` enforces the cluster to be backward
compatible with the specified client version. This subcommand prevent you from
makeing making any changes (e.g., crush tunables, or using new features) that

This comment has been minimized.

@tchaikov

tchaikov Jul 24, 2017

Contributor

s/makeing//

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