inotify-tools + rsync 实现Linux服务器之间目录实时同步

rsync介绍

Rsync是一款开源的、快速的、多功能的、可实现全量及增量的本地或远程数据同步备份的优秀工具。并且可以不进行改变原有数据的属性信息，实现数据的备份迁移特性。
Rsync是一个快速和非常通用的文件复制工具。它能本地复制，远程复制，或者远程守护进程方式复制。它提供了大量的参数来控制其行为的各个方面，并且允许非常灵活的方式来实现文件的传输复制。它以其delta-transfer算法闻名。

inotify-tools介绍

inotify-tools, 是一款google出的用于监控文件系统的软件。
inotify-tools提供两种工具：
一是inotifywait，它是用来监控文件或目录的变化，二是inotifywatch，它是用来统计文件系统访问的次数。

文件实时同步的思路

服务端：被动的接收传输过来的数据
客户端：主动提供数据给服务端
安装思路：服务端和客户端都需要安装rsync软件。因为我这里理解的客户端是提供数据给服务端，所以客户端需要实时监测文件的变动，这里的客户端需要安装inotify软件。

安装并配置rsync

• 两种安装方式：

  • 直接使用yum命令安装(本人采用)

   yum -y install rsync
  

  • 使用编译安装

  [root@www ~]# cd /usr/local/src/
  [root@www src]# wget http://rsync.samba.org/ftp/rsync/src/rsync-3.0.9.tar.gz 
  [root@www src]# tar zxvf rsync-3.0.9.tar.gz 
  [root@www src]# cd rsync-3.0.9
  [root@www rsync-3.0.9]# ./configure --prefix=/usr/local/rsync
  [root@www rsync-3.0.9]# make
  [root@www rsync-3.0.9]# make install
  

• 设置密码认证文件和配置文件

  • 创建密码认证文件(服务端)

  [root@www ~]# mkdir -p /usr/local/rsync
  [root@www ~]# echo "web:123" > /usr/local/rsync/rsyncd.passwd
  [root@www ~]# cd /usr/local/rsync
  [root@www ~]# chmod 600 rsyncd.passwd
  

  • 创建密码认证文件(客户端)

  [root@www ~]# mkdir -p /usr/local/rsync
  [root@www ~]# echo "123" > /usr/local/rsync/rsync.passwd
  [root@www ~]# cd /usr/local/rsync
  [root@www ~]# chmod 600 rsync.passwd
  

  • 修改服务端的rsync配置文件
    安装方式不同引发的配置文件区别：
    1.直接使用yum命令安装时

  [root@www ~]# vi /etc/rsyncd.conf
  uid = root
  gid = root
  use chroot = no
  max connections = 200
  timeout = 1000
  transfer logging = yes
  pid file = /var/run/rsyncd.pid
  lock file = /var/run/rsyncd.lock
  log file = /var/log/rsyncd.log
  log format = %t %a %m %f %b
  port = 873
  ignore errors
  #read only = yes
  #address = 192.168.248.136
  
  [web]
  path = /home
  read only = false
  write only = yes
  hosts allow = 192.168.248.138 192.168.248.136
  hosts deny = *
  list = false
  auth users = web
  secrets file = /usr/local/rsync/rsyncd.passwd
  #read only = yes
  #exclude = test/ #不同步的目录
  

  2.使用编译安装(举例)

  [root@www rsync]# vi /usr/local/rsync/rsyncd.conf
  uid = root
  gid = root
  use chroot = no
  max connections = 4
  strict modes = yes
  hosts allow = 192.168.1.101 #可以空格，允许多个
  port = 873
  pid file = /var/run/rsyncd.pid
  lock file = /var/run/rsync.lock
  log file = /var/log/rsyncd.log
  
  [test]
  path = /home/test
  ignore errors
  read only = false
  list = false
  auth users = backup
  secrets file = /usr/local/rsync/rsyncd.passwd
  

  PS：注意这里要将read only 修改为 false, 因为是要将文件同步到该模块的，必须可写
  rsync服务端配置文件分全局定义和模块定义：
  全局定义：

  #可以在全局定义中，定义模块参数。
  #rsync的yes/no和true/false都是通用的，建议用一种写法。
  
  port = 873
  #指定端口号（默认是873），可省略不写
  
  motd file = /etc/rsyncd/rsyncd.motd
  #motd file 指定一个消息提示的文件，要自己写文件内容，一般都不写，不影响运行，看个人喜好。
  
  #举例：你在服务端定义了这个文件，文件内容为This is motd file!，你在客户端使用rsync进行同步服务端时，首先会提示This is motd file!然后再进行同步。
  
  pid file = /var/run/rsyncd.pid
  
  #将rsync守护进程的PID写入指定的文件，防止多个守护进程运行（当kill杀死PID后，也要同时删除你定义的rsyncd.pid，否则是无法启动的，我这里是以独立运行rsync服务的截图）
  
  socket options 定义TCP选项，默认关闭
  address 关闭即可
  
  模块定义：
  
  [demo]
  #定义模块的名字，rsync将通过这个名字来确定同步那个文件夹，这个模块是必须的
  
  path = /opt/www
  #指定需要同步的目录所在位置
  
  comment = whsir
  #注释
  
  ignore errors
  #忽略IO错误
  
  exclude = test1/ test2/
  #排除目录，排除不需要同步的目录，多个之间使用空格隔开
  
  --exclude-from=FILE
  #从文件读取排除模式（将排除的文件或目录写在一个文件中，一行一个文件或目录）
  
  --include-from=FILE
  #从文件读取包含模式（将排除的文件或目录写在一个文件中，一行一个文件或目录）
  
  include = test3/ test4/
  #指定目录，要和exclude一同使用
  
  charset = GBK
  #指定编码格式，一般是在windows和linux之间同步时用到（Windows和Linux端rsync推拉同步https://blog.whsir.com/post-527.html）
  
  auth users = user
  #指定用来同步的用户，可使用空格或者逗号隔开多个用户名，如果不使用此选项，默认匿名，结合secrets file来使用
  
  secrets file = /etc/rsyncd/rsyncd.secrets
  #指定密码文件的路径，其实文件后缀不一定非是.secrets，可以写在全局配置里。/etc/rsyncd/rsyncd.secrets文件内容格式为，用户名:密码，注意中间用冒号，结合auth users来使用
  
  uid = nobody
  gid = nobody
  #指定用户和用户组来执行，默认nobody
  
  use chroot = false
  #用chroot，在传输文件之前，服务器守护程序在将chroot 到文件系统中的目录中，这样做的好处是可能保护系统被安装漏洞侵袭的可能。缺点是需要超级用户权限。另外对符号链接（软链接）文件，将会排除在外。建议false，当然你也可以写成no。
  #chroot为true时必须使用root权限，且不能备份path路径外的链接文件
  
  write only = false
  #是否禁止客户端下载（客户端用rsync拉服务端的文件就相当于下载），如果为true，则客户端不能使用rsync拉服务端的文件，会报出一下错误，不写这个参数的话，默认是disabled；若为false并且服务器目录也具有读权限则允许下载。
  
  ERROR: module is write only
  rsync error: syntax or usage error (code 1) at main.c(692) [sender=3.0.6]
  rsync: connection unexpectedly closed (5 bytes received so far) [receiver]
  rsync error: error in rsync protocol data stream (code 12) at io.c(600) [receiver=3.0.6]
  
  read only = false
  #指定是否允许客户上传文件。若为 true 则不允许上传（也就是客户端用rsync推）；若为false并且服务器目录也具有读写权限则允许上传。
  
  hosts allow=192.168.1.0/255.255.255.0 123.0.0.0/8 123.123.123.123
  #指定哪些客户端允许连接该模块，可以是单个IP，也可以指定整个网段，格式是ip与ip之间、ip和网段之间、网段和网段之间要用空格隔开 ，如果写*则是所有
  
  hosts deny = *
  #指定哪些客户端不允许连接该模块，*是所有（hosts allow定义了客户端的IP并写在了hosts deny的前面，则只允许hosts allow定义的IP进行连接，这里需要注意hosts allow和hosts deny的先后顺序）
  
  max connections = 3
  #并发连接的最大数，在达到最大值时，如果再有客户端使用同步会提示如下信息：
  @ERROR: max connections (1) reached -- try again later
  rsync error: error starting client-server protocol (code 5) at main.c(1503) [receiver=3.0.6]
  提示客户端达到最大连接数，稍后尝试，如果写成0则不限制，负值禁用模块，配合lock file锁文件使用。
  如果将max connections和/var/log/rsync.lock定义在[模块]下，则只对当前模块生效。
  如果将max connections和/var/log/rsync.lock定义在全局下，则对下面所有的模块生效，如果设置全局max connections=1那么如果你定义多个模块，则同时只能连接一个，根据使用情况进行设置！！！
  
  lock file = /var/run/rsyncd.lock
  #rsync守护进程对此文件使用记录锁定，确保服务端[模块]不超过最大连接数，配合max connections使用。
  
  timeout = 600
  #超时时间，超过这个时间将会断开连接，确保rsync服务器不会一直等待一个崩溃的客户端，建议设置600秒，如果设置为0，则表示没有超时。
  
  transfer logging = false
  #是否记录传输日志，建议false
  
  log file = /var/log/rsync.log
  #指定rsync守护进程的日志文件
  
  log format = %t %a %m %f %b
  #日志文件格式，根据自身情况选择是否使用
  
  list = false
  #是否显示数据目录，从安全的角度出发，这里应该要false
  

• 以守护进程方式启动rsync服务器(只启动服务端,客户端不需要启动）
  • 使用yum命令安装时

  rsync --daemon
  

  • 使用编译安装时

  rsync --daemon --config=/usr/local/rsync/rsyncd.conf
  

  • 加入开机自启动

  echo "/usr/local/rsync/bin/rsync --daemon --config=/usr/local/rsync/rsyncd.conf" >> /etc/rc.local
  

• 验证rsync是否安装成功

  #客户端上执行，将客户端的文件同步给服务端
  /usr/bin/rsync -vzrtopg --progress --password-file=/usr/local/rsync/rsync.passwd /opt/webstatic web@192.168.1.9::web
  #客户端上执行，将服务端的文件同步给客户端
  rsync -vzrtopg --delete --progress --password-file=/usr/local/rsync/rsync.passwd backup@192.168.1.102::test /opt/webstatic
  

  • rsync操作命令

  -v, --verbose 详细模式输出 
  -q, --quiet 精简输出模式 
  -c, --checksum 打开校验开关，强制对文件传输进行校验 
  -a, --archive 归档模式，表示以递归方式传输文件，并保持所有文件属性，等于-rlptgoD 
  -r, --recursive 对子目录以递归模式处理 
  -R, --relative 使用相对路径信息 
  -b, --backup 创建备份，也就是对于目的已经存在有同样的文件名时，将老的文件重新命名为~filename。可以使用--suffix选项来指定不同的备份文件前缀。 
  --backup-dir 将备份文件(如~filename)存放在在目录下。 
  -suffix=SUFFIX 定义备份文件前缀 
  -u, --update 仅仅进行更新，也就是跳过所有已经存在于DST，并且文件时间晚于要备份的文件。(不覆盖更新的文件) 
  -l, --links 保留软链结 
  -L, --copy-links 想对待常规文件一样处理软链结 
  --copy-unsafe-links 仅仅拷贝指向SRC路径目录树以外的链结 
  --safe-links 忽略指向SRC路径目录树以外的链结 
  -H, --hard-links 保留硬链结 
  -p, --perms 保持文件权限 
  -o, --owner 保持文件属主信息 
  -g, --group 保持文件属组信息 
  -D, --devices 保持设备文件信息 
  -t, --times 保持文件时间信息 
  -S, --sparse 对稀疏文件进行特殊处理以节省DST的空间 
  -n, --dry-run现实哪些文件将被传输 
  -W, --whole-file 拷贝文件，不进行增量检测 
  -x, --one-file-system 不要跨越文件系统边界 
  -B, --block-size=SIZE 检验算法使用的块尺寸，默认是700字节 
  -e, --rsh=COMMAND 指定使用rsh、ssh方式进行数据同步 
  --rsync-path=PATH 指定远程服务器上的rsync命令所在路径信息 
  -C, --cvs-exclude 使用和CVS一样的方法自动忽略文件，用来排除那些不希望传输的文件 
  --existing 仅仅更新那些已经存在于DST的文件，而不备份那些新创建的文件 
  --delete 删除那些DST中SRC没有的文件 
  --delete-excluded 同样删除接收端那些被该选项指定排除的文件 
  --delete-after 传输结束以后再删除 
  --ignore-errors 及时出现IO错误也进行删除 
  --max-delete=NUM 最多删除NUM个文件 
  --partial 保留那些因故没有完全传输的文件，以是加快随后的再次传输 
  --force 强制删除目录，即使不为空 
  --numeric-ids 不将数字的用户和组ID匹配为用户名和组名 
  --timeout=TIME IP超时时间，单位为秒 
  -I, --ignore-times 不跳过那些有同样的时间和长度的文件 
  --size-only 当决定是否要备份文件时，仅仅察看文件大小而不考虑文件时间 
  --modify-window=NUM 决定文件是否时间相同时使用的时间戳窗口，默认为0 
  -T --temp-dir=DIR 在DIR中创建临时文件 
  --compare-dest=DIR 同样比较DIR中的文件来决定是否需要备份 
  -P 等同于 --partial 
  --progress 显示备份过程 
  -z, --compress 对备份的文件在传输时进行压缩处理 
  --exclude=PATTERN 指定排除不需要传输的文件模式 
  --include=PATTERN 指定不排除而需要传输的文件模式 
  --exclude-from=FILE 排除FILE中指定模式的文件 
  --include-from=FILE 不排除FILE指定模式匹配的文件 
  --version 打印版本信息 
  --address 绑定到特定的地址 
  --config=FILE 指定其他的配置文件，不使用默认的rsyncd.conf文件 
  --port=PORT 指定其他的rsync服务端口
  --blocking-io 对远程shell使用阻塞IO 
  -stats 给出某些文件的传输状态 
  --progress 在传输时现实传输过程 
  --log-format=formAT 指定日志文件格式 
  --password-file=FILE 从FILE中得到密码 
  --bwlimit=KBPS 限制I/O带宽，KBytes per second 
  -h, --help 显示帮助信息 
  一般同步传输目录都使用azv选项. 
  

安装并配置inotify

• 安装inotify
  ps:在客户端(就是要监测文件变化的那端)安装inotify。

  [root@www rsync]# cd /usr/local/src/
  [root@www src]# wget --no-check-certificate https://github.com/downloads/rvoicilas/inotify-tools/inotify-tools-3.14.tar.gz 
  [root@www src]# tar zxvf inotify-tools-3.14.tar.gz 
  [root@www src]# cd inotify-tools-3.14 
  [root@www inotify-tools-3.14]# ./configure --prefix=/usr/local/inotify 
  [root@www inotify-tools-3.14]# make 
  [root@www inotify-tools-3.14]# make install 
  

• 创建rsync复制脚本
  此项功能主要是将客户端的目录/home/fan/里的内容，如果修改了（无论是添加、修改、删除文件）能够通过inotify监控到，并通过rsync实时的同步给服务端的/home里，下面是通过shell脚本实现的。

  [root@www rsync]# vi rsync.sh
  #!/bin/bash
  host=172.19.72.21
  src=/opt/web-static/static/upload
  des=web
  user=web
  
  /usr/local/inotify/bin/inotifywait -mrqs --timefmt '%d/%m/%y %H:%M' --format '%T %w%f%e' -e 'modify,create,attrib,moved_to' $src | while read files
  do
  /usr/bin/rsync -vzrtopg --progress --password-file=/usr/local/rsync/rsync.passwd $src $user@$host::$des
  echo "${files} was rsynced" >>/data/logs/rsync.log 2>&1
  done
  

• 参数说明

  inotifywait
  
  语法：
  inotifywait [-hcmrq] [-e ] [-t ] [--format ] [--timefmt ] [ ... ]
  参数：
  -h,–help
  输出帮助信息
  @
  排除不需要监视的文件，可以是相对路径，也可以是绝对路径。
  –fromfile 
  从文件读取需要监视的文件或排除的文件，一个文件一行，排除的文件以@开头。
  -m, –monitor
  接收到一个事情而不退出，无限期地执行。默认的行为是接收到一个事情后立即退出。
  -d, –daemon
  跟–monitor一样，除了是在后台运行，需要指定–outfile把事情输出到一个文件。也意味着使用了–syslog。
  -o, –outfile 
  输出事情到一个文件而不是标准输出。
  -s, –syslog
  输出错误信息到系统日志
  -r, –recursive
  监视一个目录下的所有子目录。
  -q, –quiet
  指定一次，不会输出详细信息，指定二次，除了致命错误，不会输出任何信息。
  –exclude 
  正则匹配需要排除的文件，大小写敏感。
  –excludei 
  正则匹配需要排除的文件，忽略大小写。
  -t , –timeout 
  设置超时时间，如果为0，则无限期地执行下去。
  -e , –event 
  指定监视的事件。
  -c, –csv
  输出csv格式。
  –timefmt 
  指定时间格式，用于–format选项中的%T格式。
  –format 
  指定输出格式。
  %w 表示发生事件的目录
  %f 表示发生事件的文件
  %e 表示发生的事件
  %Xe 事件以“X”分隔
  %T 使用由–timefmt定义的时间格式
  
  inotifywatch
  
  语法：
  inotifywatch [-hvzrqf] [-e ] [-t ] [-a ] [-d ] [ ... ]
  参数：
  -h, –help
  输出帮助信息
  -v, –verbose
  输出详细信息
  @
  排除不需要监视的文件，可以是相对路径，也可以是绝对路径。
  –fromfile 
  从文件读取需要监视的文件或排除的文件，一个文件一行，排除的文件以@开头。
  -z, –zero
  输出表格的行和列，即使元素为空
  –exclude 
  正则匹配需要排除的文件，大小写敏感。
  –excludei 
  正则匹配需要排除的文件，忽略大小写。
  -r, –recursive
  监视一个目录下的所有子目录。
  -t , –timeout 
  设置超时时间
  -e , –event 
  只监听指定的事件。
  -a , –ascending 
  以指定事件升序排列。
  -d , –descending 
  以指定事件降序排列。
  

  • 可监听事件

  命令	说明
  access	文件读取
  modify	文件更改
  attrib	文件属性更改，如权限，时间戳等。
  close_write	以可写模式打开的文件被关闭，不代表此文件一定已经写入数据。
  close_nowrite	以只读模式打开的文件被关闭。
  close	文件被关闭，不管它是如何打开的。
  open	文件打开。
  moved_to	一个文件或目录移动到监听的目录，即使是在同一目录内移动，此事件也触发。
  moved_from	一个文件或目录移出监听的目录，即使是在同一目录内移动，此事件也触发。
  move	包括moved_to和 moved_from
  move_self	文件或目录被移除，之后不再监听此文件或目录。
  create	文件或目录创建
  delete	文件或目录删除
  delete_self	文件或目录移除，之后不再监听此文件或目录
  unmount	文件系统取消挂载，之后不再监听此文件系统。

• 运行脚本

  [root@www rsync]# nohup sh /usr/local/rsync/rsync.sh >> /usr/local/rsync/nohup.out 2>&1 &
  

• 把rsync.sh脚本加入到开机启动项里

  [root@www rsync]# echo "setsid /usr/local/rsync/rsync.sh &" >> /etc/rc.local