update sources to v12.1.1

[ceph.git] / ceph / doc / mgr / administrator.rst

diff --git a/ceph/doc/mgr/administrator.rst b/ceph/doc/mgr/administrator.rst
index 8db733c1c4ee4c30f285b9f6695473151878e313..d78a30a4d558fde1e1761822142729830a451212 100644 (file)
--- a/ceph/doc/mgr/administrator.rst
+++ b/ceph/doc/mgr/administrator.rst
@@ -2,12 +2,16 @@
 ceph-mgr administrator's guide
 ==============================
 
-Setup
------
+Manual setup
+------------
 
-Create an authentication key for your daemon::
+Usually, you would set up a ceph-mgr daemon using a tool such
+as ceph-ansible.  These instructions describe how to set up
+a ceph-mgr daemon manually.
 
-    ceph auth get-or-create mgr.$name mon 'allow *'
+First, create an authentication key for your daemon::
+
+    ceph auth get-or-create mgr.$name mon 'allow profile mgr' osd 'allow *' mds 'allow *'
 
 Place that key into ``mgr data`` path, which for a cluster "ceph"
 and mgr $name "foo" would be ``/var/lib/ceph/mgr/ceph-foo``.
@@ -21,6 +25,16 @@ of ``ceph status``, which should now include a mgr status line::
 
     mgr active: $name
 
+Client authentication
+---------------------
+
+The manager is a new daemon which requires new CephX capabilities. If you upgrade
+a cluster from an old version of Ceph, or use the default install/deploy tools,
+your admin client should get this capability automatically. If you use tooling from
+elsewhere, you may get EACCES errors when invoking certain ceph cluster commands.
+To fix that, add a "mgr allow \*" stanza to your client's cephx capabilities by
+`Modifying User Capabilities`_.
+
 High availability
 -----------------
 
@@ -63,21 +77,16 @@ OPTION(mgr_module_path, OPT_STR, CEPH_PKGLIBDIR "/mgr") // where to load python
 :Type: String
 :Default: ``"<library dir>/mgr"``
 
-``mgr modules``
-
-:Description: List of python modules to load
-:Type: String
-:Default: ``"rest"`` (Load the REST API module only)
-
 ``mgr data``
 
 :Description: Path to load daemon data (such as keyring)
 :Type: String
 :Default: ``"/var/lib/ceph/mgr/$cluster-$id"``
 
-``mgr beacon period``
+``mgr tick period``
 
-:Description: How many seconds between mgr beacons to monitors
+:Description: How many seconds between mgr beacons to monitors, and other
+              periodic checks.
 :Type: Integer
 :Default: ``5``
 
@@ -87,3 +96,4 @@ OPTION(mgr_module_path, OPT_STR, CEPH_PKGLIBDIR "/mgr") // where to load python
 :Type: Integer
 :Default: ``30``
 
+.. _Modifying User Capabilities: ../../rados/operations/user-management/#modify-user-capabilities