diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 18:45:59 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 18:45:59 +0000 |
commit | 19fcec84d8d7d21e796c7624e521b60d28ee21ed (patch) | |
tree | 42d26aa27d1e3f7c0b8bd3fd14e7d7082f5008dc /doc/man/8/ceph-immutable-object-cache.rst | |
parent | Initial commit. (diff) | |
download | ceph-upstream.tar.xz ceph-upstream.zip |
Adding upstream version 16.2.11+ds.upstream/16.2.11+dsupstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/man/8/ceph-immutable-object-cache.rst')
-rw-r--r-- | doc/man/8/ceph-immutable-object-cache.rst | 76 |
1 files changed, 76 insertions, 0 deletions
diff --git a/doc/man/8/ceph-immutable-object-cache.rst b/doc/man/8/ceph-immutable-object-cache.rst new file mode 100644 index 000000000..2e971abdc --- /dev/null +++ b/doc/man/8/ceph-immutable-object-cache.rst @@ -0,0 +1,76 @@ +:orphan: + +====================================================================== + ceph-immutable-object-cache -- Ceph daemon for immutable object cache +====================================================================== + +.. program:: ceph-immutable-object-cache + +Synopsis +======== + +| **ceph-immutable-object-cache** + + +Description +=========== + +:program:`ceph-immutable-object-cache` is a daemon for object cache of RADOS +objects among Ceph clusters. It will promote the objects to a local directory +upon promote requests and future reads will be serviced from these cached +objects. + +It connects to local clusters via the RADOS protocol, relying on +default search paths to find ceph.conf files, monitor addresses and +authentication information for them, i.e. ``/etc/ceph/$cluster.conf``, +``/etc/ceph/$cluster.keyring``, and +``/etc/ceph/$cluster.$name.keyring``, where ``$cluster`` is the +human-friendly name of the cluster, and ``$name`` is the rados user to +connect as, e.g. ``client.ceph-immutable-object-cache``. + + +Options +======= + +.. option:: -c ceph.conf, --conf=ceph.conf + + Use ``ceph.conf`` configuration file instead of the default + ``/etc/ceph/ceph.conf`` to determine monitor addresses during startup. + +.. option:: -m monaddress[:port] + + Connect to specified monitor (instead of looking through ``ceph.conf``). + +.. option:: -i ID, --id ID + + Set the ID portion of name for ceph-immutable-object-cache + +.. option:: -n TYPE.ID, --name TYPE.ID + + Set the rados user name for the gateway (eg. client.ceph-immutable-object-cache) + +.. option:: --cluster NAME + + Set the cluster name (default: ceph) + +.. option:: -d + + Run in foreground, log to stderr + +.. option:: -f + + Run in foreground, log to usual location + + +Availability +============ + +:program:`ceph-immutable-object-cache` is part of Ceph, a massively scalable, open-source, distributed +storage system. Please refer to the Ceph documentation at http://ceph.com/docs for +more information. + + +See also +======== + +:doc:`rbd <rbd>`\(8) |