doc/rrdrados.pod

   1 =head1 NAME
   2
   3 rrdrados - Creating, updating and retrieving RRD files from Ceph
   4
   5 =head1 SYNOPSIS
   6
   7 E<lt>rrdfileE<gt> = B<ceph//E<lt>nameE<gt>>
   8
   9
  10 =head1 DESCRIPTION
  11
  12 This module adds support for creating, updating and retrieving RRD files
  13 directly from a Ceph cluster using librados.
  14
  15 It adds a ceph// prefix to RRD file name which is used to instruct rrdtool to
  16 operate on a file that is stored in Ceph.
  17
  18 Currently the module expects to find the Ceph configuration file in the default
  19 location at /etc/ceph/ceph.conf. By default it uses Ceph client ID "admin" and a
  20 Ceph pool named "rrd".
  21
  22
  23 =head1 ENVIRONMENT VARIABLES
  24
  25 =over 4
  26
  27 =item B<CEPH_ID>
  28
  29 Sets the Ceph Client ID to use when connecting. By default the client ID "admin"
  30 is used.
  31
  32 =item B<CEPH_POOL>
  33
  34 Sets the name of the Ceph Pool to connect to. By default, the pool "rrd" is
  35 used.
  36
  37 =back
  38
  39
  40 =head1 EXAMPLES
  41
  42 B<Creating an RRD file on Ceph>
  43
  44  rrdtool create ceph//temperature.rrd --step 300 \
  45    DS:temp:GAUGE:600:-273:5000 \
  46    RRA:AVERAGE:0.5:1:1200 \
  47    RRA:MIN:0.5:12:2400 \
  48    RRA:MAX:0.5:12:2400 \
  49    RRA:AVERAGE:0.5:12:2400
  50
  51
  52 B<Importing an existing RRD into Ceph>
  53
  54  rrdtool dump existing.rrd | rrdtool restore - ceph//new.rrd
  55
  56 Or you could also copy the RRD file directly into Ceph using the rados command
  57 line utility.
  58
  59
  60 B<Retrieving RRD data from Ceph>
  61
  62  rrdtool fetch ceph//file.rrd AVERAGE
  63
  64
  65 =head1 AUTHOR
  66
  67 Simon Boulet E<lt>simon@nostalgeek.comE<gt>
  68