dss.ggo

   1 # Copyright (C) 2008 Andre Noll <maan@systemlinux.org>
   2 #
   3 # Licensed under the GPL v2. For licencing details see COPYING.
   4
   5 package "dss"
   6 version "0.1.1"
   7 purpose "the dyadic snapshot scheduler
   8
   9 dss creates hardlink-based snapshots of a given directory on a remote
  10 or local host using rsync's link-dest feature.
  11 "
  12
  13 #########################
  14 section "General options"
  15 #########################
  16
  17 option "config-file" c
  18 #~~~~~~~~~~~~~~~~~~~~~
  19 "(default='~/.dssrc')"
  20 string typestr="filename"
  21 optional
  22 details="
  23         Options may be given at the command line or in the
  24         configuration file. As usual, if an option is given both at
  25         the command line and in the configuration file, the command
  26         line option takes precedence.
  27
  28         However, there is an important exception to this rule:
  29         If the --run option was given (see below) then dss honors
  30         SIGHUP and re-reads its configuration file whenever it
  31         receives this signal. In this case the options in the config
  32         file override any options that were previously given at the
  33         command line. This allows to change the configuration of a
  34         running dss process on the fly by sending SIGHUP.
  35 "
  36
  37 option "daemon" d
  38 #~~~~~~~~~~~~~~~~
  39 "Run as background daemon"
  40 flag off
  41 dependon="logfile"
  42 details="
  43         Note that dss refuses to start in daemon mode if no logfile
  44         was specified. This option is mostly useful in conjuction
  45         with the -R option described below.
  46
  47         Note that it is not possible to change whether dss runs as
  48         background daemon by sending SIGHUP.
  49 "
  50
  51 option "dry-run" D
  52 #~~~~~~~~~~~~~~~~~
  53 "Only print what would be done"
  54 flag off
  55 details="
  56         This flag does not make sense for all commands. The run
  57         command refuses to start if this option was given. The ls
  58         command silently ignores this flag.
  59 "
  60
  61 #################
  62 section "Logging"
  63 #################
  64
  65 option "loglevel" l
  66 #~~~~~~~~~~~~~~~~~~
  67 "Set loglevel (0-6)"
  68 int typestr="level"
  69 default="3"
  70 optional
  71 details="
  72         Lower values mean more verbose logging.
  73 "
  74
  75 option "logfile" -
  76 #~~~~~~~~~~~~~~~~~
  77 "Logfile for the dss daemon process"
  78 string typestr="filename"
  79 optional
  80 details="
  81         This option is mostly useful for the run command if --daemon
  82         is also given.
  83 "
  84
  85 ##################
  86 section "Commands"
  87 ##################
  88
  89 defgroup "command"
  90 #=================
  91 groupdesc="
  92         dss supports a couple of commands each of which corresponds
  93         to a different command line option. Exactly one of these
  94         options must be given.
  95
  96 "
  97 required
  98
  99 groupoption "create" C
 100 #~~~~~~~~~~~~~~~~~~~~~
 101 "Create a new snapshot"
 102 group="command"
 103 details="
 104         Execute the rsync command to create a new snapshot. Note that
 105         this command does not care about free disk space.
 106 "
 107
 108 groupoption "prune" P
 109 #~~~~~~~~~~~~~~~~~~~~
 110 "Remove redundant and outdated snapshots"
 111 group="command"
 112 details="
 113         A snapshot is considered outdated if it belongs to an interval
 114         greater than the maximum number of intervals. It is said to be
 115         redundant if it belongs to an interval that already contains
 116         more than the desired number of snapshots. This command gets
 117         rid of such snapshots.
 118 "
 119
 120 groupoption "ls" L
 121 #~~~~~~~~~~~~~~~~~
 122 "Print a list of all snapshots"
 123 group="command"
 124 details="
 125         The list will contain all snapshots no matter of their state,
 126         i. e. incomplete snapshots and snapshots being deleted will
 127         also be listed.
 128 "
 129
 130 groupoption "run" R
 131 #~~~~~~~~~~~~~~~~~~
 132 "Start creating and pruning snapshots"
 133 group="command"
 134 details="
 135         This is the main mode of operation. Snapshots will be created
 136         in an endless loop as needed and pruned automatically. The loop
 137         only terminates on fatal errors or if a terminating signal was
 138         received. See also the --exit-hook option.
 139 "
 140
 141 ###############################
 142 section "Rsync-related options"
 143 ###############################
 144
 145 option "remote-host" H
 146 #~~~~~~~~~~~~~~~~~~~~~
 147 "Remote host"
 148 string typestr="hostname"
 149 default="localhost"
 150 optional
 151 details="
 152         If this option is given and its value differs from the local
 153         host, then rsync uses ssh. Make sure there is no password
 154         needed for the ssh connection. To achieve that, use public key
 155         authentication for ssh and, if needed, set the remote user name
 156         by using the --remote-user option.
 157 "
 158
 159 option "remote-user" U
 160 #~~~~~~~~~~~~~~~~~~~~~
 161 "Remote user name (default: current user)"
 162 string typestr="username"
 163 optional
 164 details="
 165         Set this if the user running dss is different from the
 166         user at the remote host when using ssh.
 167 "
 168
 169 option "source-dir" -
 170 #~~~~~~~~~~~~~~~~~~~~
 171 "The data directory"
 172 string typestr="dirname"
 173 required
 174 details="
 175         The directory on the remote host from which snapshots are
 176         taken.  Of course, the user specified as --remote-user must
 177         have read access to this directory.
 178 "
 179
 180 option "dest-dir" -
 181 #~~~~~~~~~~~~~~~~~~
 182 "Snapshot dir"
 183 string typestr="dirname"
 184 required
 185 details="
 186         The destination directory on the local host where snapshots
 187         will be written. This must be writable by the user who runs
 188         dss.
 189 "
 190
 191 option "rsync-option" O
 192 #~~~~~~~~~~~~~~~~~~~~~~
 193 "Further rsync options"
 194 string typestr="option"
 195 optional
 196 multiple
 197 details="
 198         These option may be given multiple times. The arguments passed
 199         to that option are passed verbatim to the rsync command.
 200 "
 201
 202 ###################
 203 section "Intervals"
 204 ###################
 205
 206 option "unit-interval" u
 207 #~~~~~~~~~~~~~~~~~~~~~~~
 208 "The duration of a unit interval"
 209 int typestr="days"
 210 default="4"
 211 optional
 212 details="
 213         dss snapshot aging is implemented in terms of intervals. There
 214         are two command line options related to intervals: the
 215         duration u of a \"unit\" interval and the number n of those
 216         unit intervals.
 217
 218         dss removes any snapshots older than n times u and tries to
 219         keep 2^(n - k - 1) snapshots in interval k, where the interval
 220         number k counts from zero, zero being the most recent unit
 221         interval.
 222
 223         In other words, the oldest snapshot will at most be u * n days
 224         (= 20 days if default values are used) old.  Moreover, there
 225         are at most 2^n - 1 snapshots in total (i. e. 31 by default).
 226         Observe that you have to create at least 2^(n - 1) snapshots
 227         each interval for this to work out because that is the number
 228         of snapshots in interval zero.
 229 "
 230
 231 option "num-intervals" n
 232 #~~~~~~~~~~~~~~~~~~~~~~~
 233 "The number of unit intervals"
 234 int typestr="num"
 235 default="5"
 236 optional
 237
 238 ###############
 239 section "Hooks"
 240 ###############
 241
 242 option "pre-create-hook" r
 243 #~~~~~~~~~~~~~~~~~~~~~~~~~~
 244 "Executed before snapshot creation"
 245 string typestr="command"
 246 optional
 247 details="
 248         Execute this command before trying to create a new snapshot.
 249         If this command returns with a non-zero exit status, no
 250         snapshot is being created and the operation is retried later.
 251
 252         For example, one might want to execute a script that checks
 253         whether all snapshot-related file systems are properly mounted.
 254
 255         Another possible application of this is to return non-zero
 256         during office hours in order to not slow down the file systems
 257         by taking snapshots.
 258 "
 259
 260 option "post-create-hook" o
 261 #~~~~~~~~~~~~~~~~~~~~~~~~~~
 262 "Executed after snapshot creation"
 263 string typestr="command"
 264 optional
 265 details="
 266         Execute this after a snapshot has successfully been
 267         created. The full path of the newly created snapshot is
 268         passed to the hook as the first argument.  The exit code of
 269         this hook is ignored.
 270
 271         For instance this hook can be used to count the number of
 272         files per user and/or the disk usage patterns in order to
 273         store them in a database for further analysis.
 274 "
 275
 276 option "exit-hook" e
 277 #~~~~~~~~~~~~~~~~~~~
 278 "Executed if run command exits"
 279 string typestr="command"
 280 optional
 281 details="
 282         This hook is only used if the --run command was given which
 283         instructs dss to run in an endless loop. The exit-hook gets
 284         executed whenever this endless loop terminates. The reason
 285         for terminating the loop is passed as the first argument.
 286
 287         One possible application for this hook is to send email to the
 288         system administrator to let her know that no more snapshots
 289         are going to be created.
 290 "
 291
 292 ###############################
 293 section "Disk space monitoring"
 294 ###############################
 295
 296 option "min-free-mb" m
 297 #~~~~~~~~~~~~~~~~~~~~~
 298 "Minimal amount of free disk space"
 299 int typestr="megabytes"
 300 default="100"
 301 optional
 302 details="
 303         If disk space on the file system containing the destination
 304         directory gets low, \"dss --run\" will suspend the currently
 305         running rsync process and will start to remove snapshots in
 306         order to free disk space. This option specifies the minimal
 307         amount of free disk space. If less than the given number of
 308         megabytes is available, snapshots are being deleted. See also
 309         the --min_free_percent and the min-free-percent-inodes options.
 310
 311         A value of zero deactivates this check.
 312 "
 313
 314 option "min-free-percent" p
 315 #~~~~~~~~~~~~~~~~~~~~~~~~~~
 316 "Minimal percent of free disk space"
 317 int typestr="percent"
 318 default="2"
 319 optional
 320 details="
 321         See --min-free-mb. Note that it is not recommended to set both
 322         --min-free-mb and --min-free-percent to zero as this will
 323         cause your file system to fill up quickly.
 324 "
 325 option "min-free-percent-inodes" i
 326 #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 327 "Minimal percent of free inodes"
 328 int typestr="percent"
 329 default="0"
 330 optional
 331 details="
 332         Specify the minimum amount of free inodes on the file system
 333         containing the destination dir. If less than that many inodes
 334         are free, snapshot removal kicks in just as in case of low
 335         disk space.
 336
 337         Note that not every file system supports the concept of inodes.
 338         Moreover it is not possible to reliably detect whether this is
 339         the case. Therefore this feature is disabled by default. It's
 340         safe to enable it for ext3 file systems on linux though.
 341
 342         A value of zero (the default) deactivates this check.
 343 "
 344
 345 option "keep-redundant" k
 346 #~~~~~~~~~~~~~~~~~~~~~~~~
 347 "Prune by disk space only"
 348 flag off
 349 details="
 350         If this flag is not given dss removes redundant and outdated
 351         snapshots automatically.
 352
 353         Otherwise, this feature is deactivated so that snapshots
 354         are only being removed in case disk space or inode ratio
 355         becomes low. Use this flag if the file system containing the
 356         destination directory is used for snapshots only.
 357 "