ansible.posix.synchronize – Обёртка вокруг rsync для быстрого и простого выполнения распространённых задач в плейбуках
Примечание
Этот плагин входит в коллекцию ansible.posix (версия 1.1.1).
Для его установки используйте: ansible-galaxy collection install ansible.posix.
Для использования в плейбуке укажите: ansible.posix.synchronize.
Новое в версии 1.0.0: модуля ansible.posix
Описание
-
synchronize— это обёртка вокруг rsync для быстрого и простого выполнения распространённых задач в ваших плейбуках. - Она выполняется и инициализируется на локальном хосте, где запущен Ansible.
- Конечно, вы можете просто использовать действие
command, чтобы вызвать rsync самостоятельно, но вам также придётся добавить значительное количество служебных опций и фактов хоста. - Этот модуль не предназначен для предоставления доступа ко всем возможностям rsync, но делает наиболее распространённые вызовы проще для реализации. Вам
stillможет потребоваться вызвать rsync напрямую с помощьюcommandилиshell, в зависимости от вашего случая использования.
Примечание
Данный модуль имеет соответствующий плагин действия.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| archive boolean |
| Отражает флаг rsync archive, включает рекурсивный, ссылки, права, время, владельца, группу и флаги -D. |
| checksum boolean |
| Пропустить на основе контрольной суммы, а не времени изменения и размера; обратите внимание, что опция «archive» по-прежнему включена по умолчанию — опция «checksum» не выключит её. |
| compress boolean |
| Сжимать данные файла во время передачи. В большинстве случаев оставьте это включённым, если это не вызывает проблем. |
| copy_links boolean |
| Копировать символические ссылки как элемент, на который они указывают (ссылка), а не саму символическую ссылку. |
| delete boolean |
| Удалять файлы в dest, которых нет (после передачи, а не до неё) в пути src.Эта опция требует recursive=yes.Эта опция игнорирует исключённые файлы и ведёт себя как опция rsync --delete-excluded. |
| dest string / required | Путь на целевом хосте, который будет синхронизирован из исходного. Путь может быть абсолютным или относительным. | |
| dest_port integer | Номер порта для ssh на целевом хосте. До Ansible 2.0 переменная инвентаризации ansible_ssh_port имела приоритет над этим значением. Этот параметр по умолчанию имеет значение ansible_ssh_port или ansible_port, настройки конфигурации remote_port или значения из конфигурации ssh-клиента, если ни одно из предыдущих значений не было задано. | |
| dirs boolean |
| Передавать директории без рекурсии. |
| existing_only boolean |
| Пропустить создание новых файлов на получателе. |
| group boolean |
| Сохранить группу. Этот параметр по умолчанию имеет значение archive. |
| link_dest list / elements=string | Добавить пункт назначения для жёсткой ссылки при rsync. | |
| links boolean |
| Копировать символические ссылки как символические ссылки. Этот параметр по умолчанию имеет значение archive. |
| mode string |
| Указать направление синхронизации. В режиме push локальный хост или делегат является источником. В режиме pull удалённый хост в контексте является источником. |
| owner boolean |
| Сохранить владельца (только для суперпользователя). Этот параметр по умолчанию имеет значение archive. |
| partial boolean |
| Указывает rsync сохранить частичный файл, что сделает последующую передачу оставшейся части файла намного быстрее. |
| perms boolean |
| Сохранить права доступа. Этот параметр по умолчанию имеет значение archive. |
| private_key path | Указать закрытый ключ для использования в подключениях rsync на основе SSH (например, ~/.ssh/id_rsa). | |
| recursive boolean |
| Рекурсивно переходить в директории. Этот параметр по умолчанию имеет значение archive. |
| rsync_opts list / elements=string | Указать дополнительные опции rsync, передав массив. Обратите внимание, что пустая строка в rsync_opts приведёт к передаче текущей рабочей директории. | |
| rsync_path string | Указать команду rsync для запуска на удалённом хосте. См. --rsync-path в справке rsync.Чтобы указать команду rsync для запуска на локальном хосте, вам нужно установить эту переменную задачи ansible_rsync_path. | |
| rsync_timeout integer | По умолчанию: 0 | Указать --timeout для команды rsync в секундах. |
| set_remote_user boolean |
| Добавить user@ к удалённым путям. Если у вас есть настройка ssh для определения удалённого пользователя для хоста, которая не соответствует пользователю инвентаризации, вы должны установить этот параметр в no. |
| src string / required | Путь на исходном хосте, который будет синхронизирован с целевым. Путь может быть абсолютным или относительным. | |
| times boolean |
| Сохранить время изменения. Этот параметр по умолчанию имеет значение archive. |
| use_ssh_args boolean |
| Использовать ssh_args, заданные в ansible.cfg. |
| verify_host boolean |
| Проверить ключ целевого хоста. |
Примечания
Примечание
- rsync должен быть установлен как на локальном, так и на удалённом хосте.
- Для модуля
synchronize«локальный хост» — это хостthe synchronize task originates on, а «хост назначения» — хостsynchronize is connecting to. - «Локальный хост» можно изменить на другой хост, используя
delegate_to. Это позволяет копировать файлы между двумя удалёнными хостами или целиком на одном удалённом компьютере. - Пользователь и права для синхронизации
src— это пользователь, выполняющий задачу Ansible на локальном хосте (или remote_user для хоста delegate_to, если используется delegate_to). - Пользователь и права для синхронизации
dest— это пользовательremote_userна хосте назначения илиbecome_userпри активномbecome=yes. - В Ansible 2.0 ошибка в модуле synchronize приводила к проблемам на «локальном хосте». Эта ошибка была исправлена в Ansible 2.0.1.
- В настоящее время synchronize ограничен повышением прав с помощью безпарольного sudo. Это связано с тем, что сам rsync подключается к удалённой машине, и rsync не предоставляет способ передачи учетных данных sudo.
- В настоящее время существует лишь несколько типов подключений, поддерживающих synchronize (ssh, paramiko, local и docker), поскольку для этих типов подключений определена стратегия синхронизации. Обратите внимание, что для этих подключений не должно потребоваться пароль, так как rsync сам выполняет подключение, а rsync не предоставляет способ передачи пароля для подключения.
- Ожидайте, что dest=~/x будет ~<remote_user>/x даже при использовании sudo.
- Проверьте вывод в подробном режиме, чтобы убедиться, что пользователь, хост и путь назначения соответствуют ожидаемым.
- Для исключения файлов и каталогов из синхронизации можно добавить файлы
.rsync-filterв исходный каталог. - Дэмон rsync должен быть запущен и иметь соответствующие разрешения при использовании протокола rsync в исходном или целевом пути.
- Модуль
synchronizeпринудительно–delay-updates, чтобы избежать оставления назначения в нерабочем состоянии, если процесс rsync обнаружит ошибку. Те, кто синхронизирует большое количество файлов и готовы пожертвовать безопасностью ради производительности, должны вызывать rsync напрямую. - link_destination подчиняется тем же ограничениям, что и сам дэмон rsync. Жёсткие ссылки сохраняются только в том случае, если относительные поддеревья источника и назначения одинаковы. Попытки создать жёсткую ссылку в каталог, являющийся подкаталогом источника, будут предотвращены.
См. также
См. также
- copy
-
Официальная документация модуля copy.
- community.windows.win_robocopy
-
Официальная документация модуля community.windows.win_robocopy.
Примеры
- name: Synchronization of src on the control machine to dest on the remote hosts
ansible.posix.synchronize:
src: some/relative/path
dest: /some/absolute/path
- name: Synchronization using rsync protocol (push)
ansible.posix.synchronize:
src: some/relative/path/
dest: rsync://somehost.com/path/
- name: Synchronization using rsync protocol (pull)
ansible.posix.synchronize:
mode: pull
src: rsync://somehost.com/path/
dest: /some/absolute/path/
- name: Synchronization using rsync protocol on delegate host (push)
ansible.posix.synchronize:
src: /some/absolute/path/
dest: rsync://somehost.com/path/
delegate_to: delegate.host
- name: Synchronization using rsync protocol on delegate host (pull)
ansible.posix.synchronize:
mode: pull
src: rsync://somehost.com/path/
dest: /some/absolute/path/
delegate_to: delegate.host
- name: Synchronization without any --archive options enabled
ansible.posix.synchronize:
src: some/relative/path
dest: /some/absolute/path
archive: no
- name: Synchronization with --archive options enabled except for --recursive
ansible.posix.synchronize:
src: some/relative/path
dest: /some/absolute/path
recursive: no
- name: Synchronization with --archive options enabled except for --times, with --checksum option enabled
ansible.posix.synchronize:
src: some/relative/path
dest: /some/absolute/path
checksum: yes
times: no
- name: Synchronization without --archive options enabled except use --links
ansible.posix.synchronize:
src: some/relative/path
dest: /some/absolute/path
archive: no
links: yes
- name: Synchronization of two paths both on the control machine
ansible.posix.synchronize:
src: some/relative/path
dest: /some/absolute/path
delegate_to: localhost
- name: Synchronization of src on the inventory host to the dest on the localhost in pull mode
ansible.posix.synchronize:
mode: pull
src: some/relative/path
dest: /some/absolute/path
- name: Synchronization of src on delegate host to dest on the current inventory host.
ansible.posix.synchronize:
src: /first/absolute/path
dest: /second/absolute/path
delegate_to: delegate.host
- name: Synchronize two directories on one remote host.
ansible.posix.synchronize:
src: /first/absolute/path
dest: /second/absolute/path
delegate_to: "{{ inventory_hostname }}"
- name: Synchronize and delete files in dest on the remote host that are not found in src of localhost.
ansible.posix.synchronize:
src: some/relative/path
dest: /some/absolute/path
delete: yes
recursive: yes
# This specific command is granted su privileges on the destination
- name: Synchronize using an alternate rsync command
ansible.posix.synchronize:
src: some/relative/path
dest: /some/absolute/path
rsync_path: su -c 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
- name: Synchronize passing in extra rsync options
ansible.posix.synchronize:
src: /tmp/helloworld
dest: /var/www/helloworld
rsync_opts:
- "--no-motd"
- "--exclude=.git"
# Hardlink files if they didn't change
- name: Use hardlinks when synchronizing filesystems
ansible.posix.synchronize:
src: /tmp/path_a/foo.txt
dest: /tmp/path_b/foo.txt
link_dest: /tmp/path_a/
# Specify the rsync binary to use on remote host and on local host
- hosts: groupofhosts
vars:
ansible_rsync_path: /usr/gnu/bin/rsync
tasks:
- name: copy /tmp/localpath/ to remote location /tmp/remotepath
ansible.posix.synchronize:
src: /tmp/localpath/
dest: /tmp/remotepath
rsync_path: /usr/gnu/bin/rsync
Авторы
- Timothy Appnel (@tima)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/ansible/posix/synchronize_module.html