ceph/doc/man/8/ceph-immutable-object-cache.rst

   1 :orphan:
   2
   3 ======================================================================
   4  ceph-immutable-object-cache -- Ceph daemon for immutable object cache
   5 ======================================================================
   6
   7 .. program:: ceph-immutable-object-cache
   8
   9 Synopsis
  10 ========
  11
  12 | **ceph-immutable-object-cache**
  13
  14
  15 Description
  16 ===========
  17
  18 :program:`ceph-immutable-object-cache` is a daemon for object cache of RADOS
  19 objects among Ceph clusters. It will promote the objects to a local directory
  20 upon promote requests and future reads will be serviced from these cached
  21 objects.
  22
  23 It connects to local clusters via the RADOS protocol, relying on
  24 default search paths to find ceph.conf files, monitor addresses and
  25 authentication information for them, i.e. ``/etc/ceph/$cluster.conf``,
  26 ``/etc/ceph/$cluster.keyring``, and
  27 ``/etc/ceph/$cluster.$name.keyring``, where ``$cluster`` is the
  28 human-friendly name of the cluster, and ``$name`` is the rados user to
  29 connect as, e.g. ``client.ceph-immutable-object-cache``.
  30
  31
  32 Options
  33 =======
  34
  35 .. option:: -c ceph.conf, --conf=ceph.conf
  36
  37    Use ``ceph.conf`` configuration file instead of the default
  38    ``/etc/ceph/ceph.conf`` to determine monitor addresses during startup.
  39
  40 .. option:: -m monaddress[:port]
  41
  42    Connect to specified monitor (instead of looking through ``ceph.conf``).
  43
  44 .. option:: -i ID, --id ID
  45
  46    Set the ID portion of name for ceph-immutable-object-cache
  47
  48 .. option:: -n TYPE.ID, --name TYPE.ID
  49
  50    Set the rados user name for the gateway (eg. client.ceph-immutable-object-cache)
  51
  52 .. option:: --cluster NAME
  53
  54    Set the cluster name (default: ceph)
  55
  56 .. option:: -d
  57
  58    Run in foreground, log to stderr
  59
  60 .. option:: -f
  61
  62    Run in foreground, log to usual location
  63
  64
  65 Availability
  66 ============
  67
  68 :program:`ceph-immutable-object-cache` is part of Ceph, a massively scalable, open-source, distributed
  69 storage system. Please refer to the Ceph documentation at https://docs.ceph.com for
  70 more information.
  71
  72
  73 See also
  74 ========
  75
  76 :doc:`rbd <rbd>`\(8)