ceph/doc/cephadm/client-setup.rst

   1 =======================
   2 Basic Ceph Client Setup
   3 =======================
   4 Client machines require some basic configuration to interact with
   5 Ceph clusters. This section describes how to configure a client machine
   6 so that it can interact with a Ceph cluster.
   7
   8 .. note::
   9    Most client machines need to install only the `ceph-common` package
  10    and its dependencies. Such a setup supplies the basic `ceph` and
  11    `rados` commands, as well as other commands including `mount.ceph`
  12    and `rbd`.
  13
  14 Config File Setup
  15 =================
  16 Client machines usually require smaller configuration files (here
  17 sometimes called "config files") than do full-fledged cluster members.
  18 To generate a minimal config file, log into a host that has been
  19 configured as a client or that is running a cluster daemon, and then run the following command:
  20
  21 .. prompt:: bash #
  22
  23   ceph config generate-minimal-conf
  24
  25 This command generates a minimal config file that tells the client how
  26 to reach the Ceph monitors. The contents of this file should usually
  27 be installed in ``/etc/ceph/ceph.conf``.
  28
  29 Keyring Setup
  30 =============
  31 Most Ceph clusters run with authentication enabled. This means that
  32 the client needs keys in order to communicate with the machines in the
  33 cluster. To generate a keyring file with credentials for `client.fs`,
  34 log into an running cluster member and run the following command:
  35
  36 .. prompt:: bash $
  37
  38   ceph auth get-or-create client.fs
  39
  40 The resulting output is directed into a keyring file, typically
  41 ``/etc/ceph/ceph.keyring``.
  42
  43 To gain a broader understanding of client keyring distribution and administration, you should read :ref:`client_keyrings_and_configs`.
  44
  45 To see an example that explains how to distribute ``ceph.conf`` configuration files to hosts that are tagged with the ``bare_config`` label, you should read the section called "Distributing ceph.conf to hosts tagged with bare_config" in the section called :ref:`etc_ceph_conf_distribution`.