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 ** Crash Recovery
  61
  62 Removable disks may get lost before they reach Destination, or
  63 Destination may crash shortly after receiving fresh data. The
  64 following may help in these cases.
  65
  66 *** Data Recovery from Source(s) on Rover
  67
  68 On Monikop's host, stop Monikop and delete the log files whose
  69 directory and name prefix is set in [[installation#monikop.config][monikop.config]] by
  70 =$rsync_log_prefix= and =$finished_prefix=, and whose names resemble the
  71 Source they belong to.
  72
  73 On next startup, Monikop will pull all data from this Source again.
  74
  75 *** Data Loss on Destination: Recovery from Removable Disks
  76
  77 Data on removable disks are deleted not until the disk is
  78 finished by Pokinom and re-inserted in
  79 Monikop. (Non-)deletability is expressed by directory names defined
  80 in both [[installation#monikop.config][monikop.config]] and
  81 [[installation#pokinom.config][pokinom.config]]:
  82  - =$path_under_mount_point= sets the name of a directory fresh data
  83    reside in on each removable disk. Once finished by Pokinom, it
  84    is renamed into the name set by
  85  - =$path_under_mount_point_backed_up=. You can simply rename it
  86    back and Pokinom will push its content to Destination again.
  87    If you don't, Monikop will rename it into the name set by
  88  - =$path_under_mount_point_being_deleted= as soon as it sees it,
  89    and start deleting it while a new =$path_under_mount_point= is
  90    created and filled with fresh data.
  91
  92 *** Disk Failure
  93
  94 Suppose the system reports disk error on (say) /dev/sdb1. What is it's
  95 label?
  96
  97 =ls -l /dev/disk/by-label=
  98
  99 shows the mapping.
 100
 101
 102 * Bugs
 103
 104   - Monikop and Pokinom allow files on Sources to change at any time
 105     and will reflect such changes in Destination. As a downside,
 106     Monikop and Pokinom are unable to tell whether a file is transferred
 107     completely. You should be able to assert completeness of your
 108     files by other means.
 109   - Empty directories on Sources are being ignored.
 110   - Any directories on Sources whose names conflict with the setting
 111     =$rsync_partial_dir_name= in [[installation#monikop][monikop.config]] are being ignored.
 112   - Deletions on Sources won't propagate to Destination.
 113   - For user information on progress, both Monikop and Pokinom rely on
 114     Rsync's output which is not always reliable as to the total number
 115     of files.
 116   - During copying, occasionally obsolete versions of a file may
 117     temporarily appear on Destination. This can happen with files that
 118     have grown bigger after having been copied already.
 119   - Frequent power cuts (as opposed to normal shutdown operations) may
 120     compromise efficiency in terms of disk usage.
 121   - By running multiple instances of Rsync, Monikop puts considerable
 122     strain on the system. This may reveal previously unnoticed
 123     hardware faults.