From 780c9acd430a5dc26cda758b1a227230d177dae9 Mon Sep 17 00:00:00 2001 From: Kefu Chai Date: Thu, 20 Jul 2017 13:06:46 +0800 Subject: [PATCH] doc: document "ceph osd set-require-min-compat-client" Signed-off-by: Kefu Chai --- doc/man/8/ceph.rst | 21 ++++++++++++++++++++- doc/release-notes.rst | 4 ++-- 2 files changed, 22 insertions(+), 3 deletions(-) diff --git a/doc/man/8/ceph.rst b/doc/man/8/ceph.rst index a5f3de0faef9d..ec6702a1e0f3a 100644 --- a/doc/man/8/ceph.rst +++ b/doc/man/8/ceph.rst @@ -247,11 +247,18 @@ Usage:: ceph df {detail} +.. _ceph features: 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. +Show the releases and features of all connected daemons and clients connected +to the cluster, along with the numbers of them in each bucket grouped by the +corresponding features/releases. 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 +these new features. As new features or capabilities are enabled after an +upgrade, older clients are prevented from connecting. Usage:: @@ -1084,6 +1091,18 @@ Usage:: ceph osd setmaxosd +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 +would violate the current setting. Please note, This subcommand will fail if +any connected daemon or client is not compatible with the features offered by +the given . To see the features and releases of all clients connected +to cluster, please see `ceph features`_. + +Usage:: + + ceph osd set-require-min-compat-client + Subcommand ``stat`` prints summary of OSD map. Usage:: diff --git a/doc/release-notes.rst b/doc/release-notes.rst index 3e32654e5681e..9ab3f8b4d3a6c 100644 --- a/doc/release-notes.rst +++ b/doc/release-notes.rst @@ -71,11 +71,11 @@ Major Changes from Kraken process IO. * There is a `simplified OSD replacement process`_ that is more robust. * You can query the supported features and (apparent) releases of - all connected daemons and clients with ``ceph features``. + all connected daemons and clients with `ceph features `_. * 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. * Several `sleep` settings, include ``osd_recovery_sleep``, ``osd_snap_trim_sleep``, and ``osd_scrub_sleep`` have been reimplemented to work efficiently. (These are used in some cases -- 2.39.5