]> git-server-git.apps.pok.os.sepia.ceph.com Git - ceph-deploy.git/commitdiff
[fix-remove-ceph-create-keys-dep_cp] docs.source.admin: Add admin documentation
authorOwen Synge <osynge@suse.com>
Fri, 20 May 2016 11:25:13 +0000 (13:25 +0200)
committerOwen Synge <osynge@suse.com>
Fri, 20 May 2016 12:41:08 +0000 (14:41 +0200)
The admin command did not have and documentation.

Signed-off-by: Owen Synge <osynge@suse.com>
docs/source/admin.rst [new file with mode: 0644]

diff --git a/docs/source/admin.rst b/docs/source/admin.rst
new file mode 100644 (file)
index 0000000..8ae7395
--- /dev/null
@@ -0,0 +1,26 @@
+.. _admin:
+
+admin
+=======
+The ``admin`` subcommand provides an interface to add to the cluster's admin
+node.
+
+Example
+-------
+To make a node and admin node run::
+
+  ceph-deploy admin ADMIN [ADMIN..]
+
+This places the the cluster configuration and the admin keyring on the remote
+nodes.
+
+Admin node definition
+---------------------
+
+The definition of an admin node is that both the cluster configuration file
+and the admin keyring. Both of these files are stored in the directory
+/etc/ceph and thier prefix is that of the cluster name.
+
+The default ceph cluster name is "ceph". So with a cluster with a default name
+the admin keyring is named /etc/ceph/ceph.client.admin.keyring while cluster
+configuration file is named /etc/ceph/ceph.conf.