doc: add a basic client configuration document

Signed-off-by: Jeff Layton <jlayton@redhat.com>
This commit is contained in:
Jeff Layton 2019-11-25 13:38:49 -05:00
parent 6cb39e4aa8
commit 85df3a5fb2
2 changed files with 37 additions and 0 deletions

View File

@ -0,0 +1,36 @@
=======================
Basic Ceph Client Setup
=======================
Client machines need some basic configuration in order to interact with
a cluster. This document describes how to configure a client machine
for cluster interaction.
.. note:: Most client machines only need the `ceph-common` package and
its dependencies installed. That will supply the basic `ceph`
and `rados` commands, as well as other commands like
`mount.ceph` and `rbd`.
Config File Setup
=================
Client machines can generally get away with a smaller config file than
a full-fledged cluster member. To generate a minimal config file, log
into a host that is already configured as a client or running a cluster
daemon, and then run::
ceph config generate-minimal-conf
This will generate a minimal config file that will tell the client how to
reach the Ceph Monitors. The contents of this file should typically be
installed in `/etc/ceph/ceph.conf`.
Keyring Setup
=============
Most Ceph clusters are run with authentication enabled, and the client will
need keys in order to communicate with cluster machines. To generate a
keyring file with credentials for `client.fs`, log into an extant cluster
member and run::
ceph auth get-or-create client.fs
The resulting output should be put into a keyring file, typically
`/etc/ceph/ceph.keyring`.

View File

@ -28,5 +28,6 @@ versions of Ceph.
Cephadm operations <operations> Cephadm operations <operations>
Cephadm monitoring <monitoring> Cephadm monitoring <monitoring>
Cephadm CLI <../mgr/orchestrator> Cephadm CLI <../mgr/orchestrator>
Client Setup <client-setup>
DriveGroups <drivegroups> DriveGroups <drivegroups>
troubleshooting troubleshooting