333 lines
12 KiB
Python
333 lines
12 KiB
Python
#!/usr/bin/python
|
|
# -*- coding: utf-8 -*-
|
|
|
|
# (c) 2012-2013, Timothy Appnel <tim@appnel.com>
|
|
#
|
|
# Ansible is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# Ansible is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
DOCUMENTATION = '''
|
|
---
|
|
module: synchronize
|
|
version_added: "1.4"
|
|
short_description: Uses rsync to make synchronizing file paths in your playbooks quick and easy.
|
|
description:
|
|
- This is a wrapper around rsync. Of course you could just use the command action to call rsync yourself, but you also have to add a fair number of boilerplate options and host facts. You still may need to call rsync directly via C(command) or C(shell) depending on your use case. The synchronize action is meant to do common things with C(rsync) easily. It does not provide access to the full power of rsync, but does make most invocations easier to follow.
|
|
options:
|
|
src:
|
|
description:
|
|
- Path on the source machine that will be synchronized to the destination; The path can be absolute or relative.
|
|
required: true
|
|
dest:
|
|
description:
|
|
- Path on the destination machine that will be synchronized from the source; The path can be absolute or relative.
|
|
required: true
|
|
dest_port:
|
|
description:
|
|
- Port number for ssh on the destination host. The ansible_ssh_port inventory var takes precedence over this value.
|
|
default: 22
|
|
version_added: "1.5"
|
|
mode:
|
|
description:
|
|
- Specify the direction of the synchroniztion. In push mode the localhost or delegate is the source; In pull mode the remote host in context is the source.
|
|
required: false
|
|
choices: [ 'push', 'pull' ]
|
|
default: 'push'
|
|
archive:
|
|
description:
|
|
- Mirrors the rsync archive flag, enables recursive, links, perms, times, owner, group flags and -D.
|
|
choices: [ 'yes', 'no' ]
|
|
default: 'yes'
|
|
required: false
|
|
checksum:
|
|
description:
|
|
- Skip based on checksum, rather than mod-time & size; Note that that "archive" option is still enabled by default - the "checksum" option will not disable it.
|
|
choices: [ 'yes', 'no' ]
|
|
default: 'no'
|
|
required: false
|
|
version_added: "1.6"
|
|
existing_only:
|
|
description:
|
|
- Skip creating new files on receiver.
|
|
choices: [ 'yes', 'no' ]
|
|
default: 'no'
|
|
required: false
|
|
version_added: "1.5"
|
|
delete:
|
|
description:
|
|
- Delete files that don't exist (after transfer, not before) in the C(src) path. This option requires C(recursive=yes).
|
|
choices: [ 'yes', 'no' ]
|
|
default: 'no'
|
|
required: false
|
|
dirs:
|
|
description:
|
|
- Transfer directories without recursing
|
|
choices: [ 'yes', 'no' ]
|
|
default: 'no'
|
|
required: false
|
|
recursive:
|
|
description:
|
|
- Recurse into directories.
|
|
choices: [ 'yes', 'no' ]
|
|
default: the value of the archive option
|
|
required: false
|
|
links:
|
|
description:
|
|
- Copy symlinks as symlinks.
|
|
choices: [ 'yes', 'no' ]
|
|
default: the value of the archive option
|
|
required: false
|
|
copy_links:
|
|
description:
|
|
- Copy symlinks as the item that they point to (the referent) is copied, rather than the symlink.
|
|
choices: [ 'yes', 'no' ]
|
|
default: 'no'
|
|
required: false
|
|
perms:
|
|
description:
|
|
- Preserve permissions.
|
|
choices: [ 'yes', 'no' ]
|
|
default: the value of the archive option
|
|
required: false
|
|
times:
|
|
description:
|
|
- Preserve modification times
|
|
choices: [ 'yes', 'no' ]
|
|
default: the value of the archive option
|
|
required: false
|
|
owner:
|
|
description:
|
|
- Preserve owner (super user only)
|
|
choices: [ 'yes', 'no' ]
|
|
default: the value of the archive option
|
|
required: false
|
|
group:
|
|
description:
|
|
- Preserve group
|
|
choices: [ 'yes', 'no' ]
|
|
default: the value of the archive option
|
|
required: false
|
|
rsync_path:
|
|
description:
|
|
- Specify the rsync command to run on the remote machine. See C(--rsync-path) on the rsync man page.
|
|
required: false
|
|
rsync_timeout:
|
|
description:
|
|
- Specify a --timeout for the rsync command in seconds.
|
|
default: 0
|
|
required: false
|
|
set_remote_user:
|
|
description:
|
|
- put user@ for the remote paths. If you have a custom ssh config to define the remote user for a host
|
|
that does not match the inventory user, you should set this parameter to "no".
|
|
default: yes
|
|
rsync_opts:
|
|
description:
|
|
- Specify additional rsync options by passing in an array.
|
|
default:
|
|
required: false
|
|
version_added: "1.6"
|
|
notes:
|
|
- Inspect the verbose output to validate the destination user/host/path
|
|
are what was expected.
|
|
- The remote user for the dest path will always be the remote_user, not
|
|
the sudo_user.
|
|
- Expect that dest=~/x will be ~<remote_user>/x even if using sudo.
|
|
- To exclude files and directories from being synchronized, you may add
|
|
C(.rsync-filter) files to the source directory.
|
|
|
|
|
|
author: Timothy Appnel
|
|
'''
|
|
|
|
EXAMPLES = '''
|
|
# Synchronization of src on the control machine to dest on the remote hosts
|
|
synchronize: src=some/relative/path dest=/some/absolute/path
|
|
|
|
# Synchronization without any --archive options enabled
|
|
synchronize: src=some/relative/path dest=/some/absolute/path archive=no
|
|
|
|
# Synchronization with --archive options enabled except for --recursive
|
|
synchronize: src=some/relative/path dest=/some/absolute/path recursive=no
|
|
|
|
# Synchronization with --archive options enabled except for --times, with --checksum option enabled
|
|
synchronize: src=some/relative/path dest=/some/absolute/path checksum=yes times=no
|
|
|
|
# Synchronization without --archive options enabled except use --links
|
|
synchronize: src=some/relative/path dest=/some/absolute/path archive=no links=yes
|
|
|
|
# Synchronization of two paths both on the control machine
|
|
local_action: synchronize src=some/relative/path dest=/some/absolute/path
|
|
|
|
# Synchronization of src on the inventory host to the dest on the localhost in
|
|
pull mode
|
|
synchronize: mode=pull src=some/relative/path dest=/some/absolute/path
|
|
|
|
# Synchronization of src on delegate host to dest on the current inventory host
|
|
synchronize: >
|
|
src=some/relative/path dest=/some/absolute/path
|
|
delegate_to: delegate.host
|
|
|
|
# Synchronize and delete files in dest on the remote host that are not found in src of localhost.
|
|
synchronize: src=some/relative/path dest=/some/absolute/path delete=yes
|
|
|
|
# Synchronize using an alternate rsync command
|
|
synchronize: src=some/relative/path dest=/some/absolute/path rsync_path="sudo rsync"
|
|
|
|
# Example .rsync-filter file in the source directory
|
|
- var # exclude any path whose last part is 'var'
|
|
- /var # exclude any path starting with 'var' starting at the source directory
|
|
+ /var/conf # include /var/conf even though it was previously excluded
|
|
|
|
# Synchronize passing in extra rsync options
|
|
synchronize: src=/tmp/helloworld dest=/var/www/helloword rsync_opts=--no-motd,--exclude=.git
|
|
'''
|
|
|
|
|
|
def main():
|
|
module = AnsibleModule(
|
|
argument_spec = dict(
|
|
src = dict(required=True),
|
|
dest = dict(required=True),
|
|
dest_port = dict(default=22),
|
|
delete = dict(default='no', type='bool'),
|
|
private_key = dict(default=None),
|
|
rsync_path = dict(default=None),
|
|
archive = dict(default='yes', type='bool'),
|
|
checksum = dict(default='no', type='bool'),
|
|
existing_only = dict(default='no', type='bool'),
|
|
dirs = dict(default='no', type='bool'),
|
|
recursive = dict(type='bool'),
|
|
links = dict(type='bool'),
|
|
copy_links = dict(type='bool'),
|
|
perms = dict(type='bool'),
|
|
times = dict(type='bool'),
|
|
owner = dict(type='bool'),
|
|
group = dict(type='bool'),
|
|
set_remote_user = dict(default='yes', type='bool'),
|
|
rsync_timeout = dict(type='int', default=0),
|
|
rsync_opts = dict(type='list')
|
|
),
|
|
supports_check_mode = True
|
|
)
|
|
|
|
source = module.params['src']
|
|
dest = module.params['dest']
|
|
dest_port = module.params['dest_port']
|
|
delete = module.params['delete']
|
|
private_key = module.params['private_key']
|
|
rsync_path = module.params['rsync_path']
|
|
rsync = module.params.get('local_rsync_path', 'rsync')
|
|
rsync_timeout = module.params.get('rsync_timeout', 'rsync_timeout')
|
|
archive = module.params['archive']
|
|
checksum = module.params['checksum']
|
|
existing_only = module.params['existing_only']
|
|
dirs = module.params['dirs']
|
|
# the default of these params depends on the value of archive
|
|
recursive = module.params['recursive']
|
|
links = module.params['links']
|
|
copy_links = module.params['copy_links']
|
|
perms = module.params['perms']
|
|
times = module.params['times']
|
|
owner = module.params['owner']
|
|
group = module.params['group']
|
|
rsync_opts = module.params['rsync_opts']
|
|
|
|
cmd = '%s --delay-updates -FF --compress' % rsync
|
|
if rsync_timeout:
|
|
cmd = cmd + ' --timeout=%s' % rsync_timeout
|
|
if module.check_mode:
|
|
cmd = cmd + ' --dry-run'
|
|
if delete:
|
|
cmd = cmd + ' --delete-after'
|
|
if existing_only:
|
|
cmd = cmd + ' --existing'
|
|
if checksum:
|
|
cmd = cmd + ' --checksum'
|
|
if archive:
|
|
cmd = cmd + ' --archive'
|
|
if recursive is False:
|
|
cmd = cmd + ' --no-recursive'
|
|
if links is False:
|
|
cmd = cmd + ' --no-links'
|
|
if copy_links is True:
|
|
cmd = cmd + ' --copy-links'
|
|
if perms is False:
|
|
cmd = cmd + ' --no-perms'
|
|
if times is False:
|
|
cmd = cmd + ' --no-times'
|
|
if owner is False:
|
|
cmd = cmd + ' --no-owner'
|
|
if group is False:
|
|
cmd = cmd + ' --no-group'
|
|
else:
|
|
if recursive is True:
|
|
cmd = cmd + ' --recursive'
|
|
if links is True:
|
|
cmd = cmd + ' --links'
|
|
if copy_links is True:
|
|
cmd = cmd + ' --copy-links'
|
|
if perms is True:
|
|
cmd = cmd + ' --perms'
|
|
if times is True:
|
|
cmd = cmd + ' --times'
|
|
if owner is True:
|
|
cmd = cmd + ' --owner'
|
|
if group is True:
|
|
cmd = cmd + ' --group'
|
|
if dirs:
|
|
cmd = cmd + ' --dirs'
|
|
if private_key is None:
|
|
private_key = ''
|
|
else:
|
|
private_key = '-i '+ private_key
|
|
|
|
if dest_port != 22:
|
|
cmd += " --rsh '%s %s -o %s -o Port=%s'" % ('ssh', private_key,
|
|
'StrictHostKeyChecking=no', dest_port)
|
|
else:
|
|
cmd += " --rsh '%s %s -o %s'" % ('ssh', private_key,
|
|
'StrictHostKeyChecking=no') # need ssh param
|
|
|
|
if rsync_path:
|
|
cmd = cmd + " --rsync-path=%s" % (rsync_path)
|
|
if rsync_opts:
|
|
cmd = cmd + " " + " ".join(rsync_opts)
|
|
changed_marker = '<<CHANGED>>'
|
|
cmd = cmd + " --out-format='" + changed_marker + "%i %n%L'"
|
|
|
|
# expand the paths
|
|
if '@' not in source:
|
|
source = os.path.expanduser(source)
|
|
if '@' not in dest:
|
|
dest = os.path.expanduser(dest)
|
|
|
|
cmd = ' '.join([cmd, source, dest])
|
|
cmdstr = cmd
|
|
(rc, out, err) = module.run_command(cmd)
|
|
if rc:
|
|
return module.fail_json(msg=err, rc=rc, cmd=cmdstr)
|
|
else:
|
|
changed = changed_marker in out
|
|
out_clean=out.replace(changed_marker,'')
|
|
out_lines=out_clean.split('\n')
|
|
while '' in out_lines:
|
|
out_lines.remove('')
|
|
return module.exit_json(changed=changed, msg=out_clean,
|
|
rc=rc, cmd=cmdstr, stdout_lines=out_lines)
|
|
|
|
# import module snippets
|
|
from ansible.module_utils.basic import *
|
|
|
|
main()
|
|
|