From 68020a27f8936e5d2fb2aa70efa572d0c65b55a8 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Tue, 11 Apr 2017 00:07:25 +0200 Subject: Adding upstream version 20170410. Signed-off-by: Daniel Baumann --- share/man/ceph-log.1.txt | 2 +- share/man/cephfs-snap.1.txt | 39 ++++++++++++++++++++++++++++++++++++++- share/man/storage-tools.7.txt | 4 ++++ 3 files changed, 43 insertions(+), 2 deletions(-) (limited to 'share/man') diff --git a/share/man/ceph-log.1.txt b/share/man/ceph-log.1.txt index c3fe237..997db04 100644 --- a/share/man/ceph-log.1.txt +++ b/share/man/ceph-log.1.txt @@ -39,7 +39,7 @@ administrator watch everything that is happening in a ceph cluster, such as the health state of the cluster, any cluster changes and any commands and mounts from clients that are happening. -Unfortunatly the 'ceph -w' command is a tool that a system administrator uses +Unfortunately the 'ceph -w' command is a tool that a system administrator uses for real time information, means there is no history or looking backward what happened at a given time. diff --git a/share/man/cephfs-snap.1.txt b/share/man/cephfs-snap.1.txt index 972bcd0..06b1ab7 100644 --- a/share/man/cephfs-snap.1.txt +++ b/share/man/cephfs-snap.1.txt @@ -29,7 +29,9 @@ cephfs-snap - create CephFS snapshots periodically SYNOPSIS -------- -*cephfs-snap* {hourly|daily|weekly|monthly} +*cephfs-snap* + +*cephfs-snap* [hourly|daily|weekly|monthly] DESCRIPTION @@ -40,13 +42,48 @@ backups. The cephfs-snap program is a simple tool to do this periodically. +CONFIGURATION +------------- +cephfs-snap is configured in /etc/default/storage-tools. The following variables are used: + +*CEPHFS_SNAP*:: + Boolean, either true or false. If set to false (default), cephfs will do nothing. + +*CEPHFS_SNAP_DIRECTORIES*:: + List of one or more space separated directories. If no directory is specified, cephfs-snap will do nothing. + +*CEPHFS_SNAP_HOURLY*:: + Integer, number of how many most recent hourly snapshots are to be kept at any given time. Any older snapshots will be removed. Note: specify one more than you wan to keep, e.g. 25 for one day of hourly snapshots alongside the most current one. + +*CEPHFS_SNAP_DAILY*:: + Integer, number of how many most recent daily snapshots are to be kept at any given time. + +*CEPHFS_SNAP_WEEKLY*:: + Integer, number of how many most recent weekly snapshots are to be kept at any given time. + +*CEPHFS_SNAP_MONTHLY*:: + Integer, number of how many most recent monthly snapshots are to be kept at any given time. + +*CEPHFS_SNAP_YEARLY*:: + Integer, number of how many most recent yearly snapshots are to be kept at any given time. + +*IRK_TARGETS*:: + List of space separated IRC channels to send notifications to, e.g.: irc://irc.oftc.net:6668/open-infrastructure + + FILES ----- The following files are used: +*/etc/cron.d/cephfs-snap*:: + Cron file. + */etc/default/storage-tools*:: Configuration file. +*/var/log/storage-tools/cephfs-snap*:: + Log files. + SEE ALSO -------- diff --git a/share/man/storage-tools.7.txt b/share/man/storage-tools.7.txt index 20bae0b..a5133d1 100644 --- a/share/man/storage-tools.7.txt +++ b/share/man/storage-tools.7.txt @@ -54,6 +54,10 @@ SOURCE 2. git clone https://sources.open-infrastructure.net/software/storage-tools 3. cd storage-tools && sudo make install +DEBIAN 10 (BUSTER) AND NEWER +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + * sudo apt install storage-tools + DEVELOPMENT ----------- -- cgit v1.2.3