From: Sage Weil <sage@redhat.com>
Date: Fri, 20 Mar 2020 16:40:56 +0000 (-0500)
Subject: doc/cephadm: notes on status/stability
X-Git-Tag: v16.0.0^2^2
X-Git-Url: http://git.apps.os.sepia.ceph.com/?a=commitdiff_plain;h=cf73c06184e702aa48d76b6de48c3f64966b538e;p=ceph-ci.git

doc/cephadm: notes on status/stability

Signed-off-by: Sage Weil <sage@redhat.com>
---

diff --git a/doc/cephadm/index.rst b/doc/cephadm/index.rst
index 4a0a9230fbd..e1be17e8d2f 100644
--- a/doc/cephadm/index.rst
+++ b/doc/cephadm/index.rst
@@ -9,19 +9,25 @@ manager daemon via SSH to add, remove, or update Ceph daemon containers.  It
 does not rely on external configuration or orchestration tools like Ansible,
 Rook, or Salt.
 
-Cephadm starts by bootstrapping a tiny Ceph cluster on a single node
-(one monitor and one manager) and then uses the orchestration
-interface ("day 2" commands) to expand the cluster to include all
-hosts and to provision all Ceph daemons and services.  This can be
-performed via the Ceph command-line interface (CLI) or dashboard
-(GUI).
+Cephadm manages the full lifecycle of a Ceph cluster.  It starts
+by bootstrapping a tiny Ceph cluster on a single node (one monitor and
+one manager) and then uses the orchestration interface ("day 2"
+commands) to expand the cluster to include all hosts and to provision
+all Ceph daemons and services.  This can be performed via the Ceph
+command-line interface (CLI) or dashboard (GUI).
 
 Cephadm is new in the Octopus v15.2.0 release and does not support older
 versions of Ceph.
 
+.. note::
+
+   Cephadm is new.  Please read about :ref:`cephadm-stability` before
+   using cephadm to deploy a production system.
+
 .. toctree::
-    :maxdepth: 2
+    :maxdepth: 1
 
+    stability
     install
     adoption
     upgrade
diff --git a/doc/cephadm/stability.rst b/doc/cephadm/stability.rst
new file mode 100644
index 00000000000..7054fea5adb
--- /dev/null
+++ b/doc/cephadm/stability.rst
@@ -0,0 +1,41 @@
+.. _cephadm-stability:
+
+Stability
+=========
+
+Cephadm is a new feature in the Octopus release and has seen limited
+use in production and at scale.  We would like users to try cephadm,
+especially for new clusters, but please be aware that some
+functionality is still rough around the edges.  We expect fairly
+frequent updates and improvements over the first several bug fix
+releases of Octopus.
+
+Cephadm management of the following components are currently well-supported:
+
+- Monitors
+- Managers
+- OSDs
+- CephFS file systems
+- rbd-mirror
+
+The following components are working with cephadm, but the
+documentation is not as complete as we would like, and there may be some
+changes in the near future:
+
+- RGW
+- dmcrypt OSDs
+
+Cephadm support for the following features is still under development:
+
+- NFS
+- iSCSI
+
+If you run into problems, you can always pause cephadm with::
+
+  ceph orch pause
+
+Or turn cephadm off completely with::
+
+  ceph orch set backend ''
+  ceph mgr module disable cephadm
+
diff --git a/doc/cephadm/troubleshooting.rst b/doc/cephadm/troubleshooting.rst
index c8208cef5ff..93f42025f7f 100644
--- a/doc/cephadm/troubleshooting.rst
+++ b/doc/cephadm/troubleshooting.rst
@@ -11,8 +11,8 @@ different. Here are a few tools and commands to help investigating issues.
 Pausing or disabling cephadm
 ----------------------------
 
-If thigns go wrong and cephadm is doing something you don't like, you can
-pause most background activity with::
+If something goes wrong and cephadm is doing behaving in a way you do
+not like, you can pause most background activity with::
 
   ceph orch pause
 
@@ -30,7 +30,7 @@ did before.
 Checking cephadm logs
 ---------------------
 
-You can monitor the cephadm log in realtime with::
+You can monitor the cephadm log in real time with::
 
   ceph -W cephadm