doc/usage.muse

   1 #title Monikop (and Pokinom)
   2 #subtitle rsync between unconnected hosts
   3 #author Bert Burgemeister
   4
   5 * Usage
   6
   7 Both Monikop and Pokinom will create automatically any directories they need.
   8
   9 ** Monikop
  10
  11 Put removable disks into Monikop's host on Rover and switch it on. Immediately,
  12 Monikop starts pulling data from Sources it can reach. Monikop will
  13 notice additional Sources that become reachable later and will start
  14 pulling data there as well.
  15
  16 For each Source, Monikop keeps starting over to see if there is new
  17 data. Only Monikop's shutdown or the disappearance of the data Source
  18 will end this cycle.
  19
  20 One removable disk is sufficient for Monikop's correct
  21 operation; but if speed is important, putting in as many disks as
  22 there are data Sources may be beneficial as Monikop uses them in parallel.
  23
  24 To end a session, press [F3] to shut down Monikop, and remove the
  25 disks. Monikop's display shows which disks are not yet used so you
  26 can avoid carrying empty disks around.
  27
  28
  29
  30 ** Pokinom
  31
  32 Put removable disks into Pokinom's host in office and switch it
  33 on. Immediately, Pokinom starts pushing data to Destination.
  34 Interrupting this by shutting down Pokinom early is not a problem as
  35 long as it is later given the opportunity to finish. Otherwise files,
  36 even those already copied to
  37 Destination, won't be deleted by Monikop from their removable disks
  38 during the next cycle.
  39
  40 Press [F9] to toggle whether or not you want Pokinom to shut down
  41 when finished.
  42
  43 File permissions in Destination's receiving directory must not be
  44 changed in a way that prevents the rsync server from modifying.
  45 Best practice is to move anything out of this directory prior to any
  46 processing.
  47
  48 Pokinom needs a sufficient amount of free disk space on Destination; it
  49 must be rebooted once this temporarily hasn't been the case.
  50
  51
  52 ;   TODO: data transferred, but to ignore (probably none)
  53
  54
  55 ; TODO:
  56 ; ** fsck-pokinom
  57 ;    - fsck-pokinom: to be run by root
  58
  59
  60 ** Data Recovery
  61
  62 *** Data Loss on Destination: Recovery from Removable Disks
  63
  64 Data on removable disks are deleted not until the disk is
  65 finished by Pokinom and re-inserted in
  66 Monikop. (Non-)deletability is expressed by directory names defined
  67 in both [[installation#monikop.config][monikop.config]] and
  68 [[installation#pokinom.config][pokinom.config]]:
  69  - =$path_under_mount_point= sets the name of a directory fresh data
  70    reside in on each removable disk. Once finished by Pokinom, it
  71    is renamed into the name set by
  72  - =$path_under_mount_point_backed_up=. You can simply rename it
  73    back and Pokinom will push its content to Destination again.
  74    If you don't, Monikop will rename it into the name set by
  75  - =$path_under_mount_point_being_deleted= as soon as it sees it,
  76    and start deleting it while a new =$path_under_mount_point= is
  77    created and filled with fresh data.
  78
  79 *** Recovery from Source(s) on Rover
  80
  81 On Monikop's host, stop Monikop and delete the log files whose directories and name
  82 prefixes are set in [[installation#monikop.config][monikop.config]] by
  83 =$rsync_log_prefix= and =$finished_prefix=, and whose names resemble
  84 the Source they belong to.
  85
  86 On next startup, Monikop will pull all data from this Source again.
  87
  88
  89 * Bugs
  90
  91   - Monikop and Pokinom allow files on Sources to change at any time
  92     and will reflect such changes in Destination. As a downside,
  93     Monikop and Pokinom are unable to tell whether a file is transferred
  94     completely. You should be able to assert completeness of your
  95     files by other means.
  96   - Payload data must not contain any directories with the names set
  97     by =$rsync_partial_dir_name= in
  98     [[installation#monikop][monikop.config]]/[[installation#pokinom.config][pokinom.config]]
  99   - Deletions on Sources won't propagate to Destination.
 100   - May ignore empty directories on Sources.
 101 ; (TODO: really?)
 102   - During copying, occasionally obsolete versions of a file may
 103     temporarily appear on Destination. This can happen with files that
 104     have grown bigger after having been copied already.
 105   - Frequent power cuts (as opposed to normal shutdown operations) may
 106     compromise efficiency in terms of disk usage.
 107   - By running multiple instances of Rsync, Monikop puts considerable strain
 108     on the system, which may reveal previously unnoticed hardware faults.
 109
 110 ; System reports disk error on (say) /dev/sdb1. What is it's label?
 111 ; ls -l /dev/disk/by-label
 112