synchronize – Обёртка вокруг rsync для ускорения и упрощения выполнения общих задач в ваших playbooks
Описание
-
synchronizeэто обёртка вокруг rsync, которая позволяет быстро и легко выполнять общие задачи в ваших playbooks. - Она выполняется и инициализируется на локальном хосте, где выполняется 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. |
| dest string / обязательно | Путь на хосте назначения, который будет синхронизироваться с исходного. Путь может быть абсолютным или относительным. | |
| dest_port целое число | Номер порта для 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 список добавлено в 2.5 | По умолчанию: null | Добавить место назначения для жёсткой ссылки во время rsync. |
| links boolean |
| Копировать символические ссылки как символические ссылки. Этот параметр по умолчанию принимает значение параметра archive. |
| mode строка |
| Указать направление синхронизации. В режиме push локальный хост или делегат является источником. В режиме pull удалённый хост в контексте является источником. |
| owner boolean |
| Сохранить владельца (только для суперпользователя). Этот параметр по умолчанию принимает значение параметра archive. |
| partial boolean добавлено в 2.0 |
| Указывает rsync сохранить частичный файл, что сделает последующую передачу оставшейся части файла значительно быстрее. |
| perms boolean |
| Сохранить разрешения. Этот параметр по умолчанию принимает значение параметра archive. |
| private_key путь | Указать закрытый ключ для использования в rsync-соединениях на основе SSH (например, ~/.ssh/id_rsa). | |
| recursive boolean |
| Рекурсивно войти в каталоги. Этот параметр по умолчанию принимает значение параметра archive. |
| rsync_opts список | По умолчанию: null | Указать дополнительные параметры rsync, передав массив. Обратите внимание, что пустая строка в rsync_opts приведет к передаче текущего каталога. |
| rsync_path строка | Указать команду rsync для выполнения на удалённом хосте. См. --rsync-path в справке rsync.Чтобы указать команду rsync для выполнения на локальном хосте, необходимо установить эту переменную задачи ansible_rsync_path. | |
| rsync_timeout целое число | По умолчанию: 0 | Указать --timeout для команды rsync в секундах. |
| set_remote_user boolean |
| Добавить user@ к удалённым путям. Если у вас есть настройка ssh, которая определяет удалённого пользователя для хоста, который не совпадает с пользователем инвентаризации, вы должны установить этот параметр в no. |
| src строка / обязательно | Путь на хосте источника, который будет синхронизироваться с местом назначения. Путь может быть абсолютным или относительным. | |
| times boolean |
| Сохранить время изменения. Этот параметр по умолчанию принимает значение параметра archive. |
| use_ssh_args boolean добавлено в 2.0 |
| Использовать ssh_args, указанные в ansible.cfg. |
| verify_host boolean добавлено в 2.0 |
| Проверить ключ хоста назначения. |
Примечания
Примечание
- 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.
- win_robocopy – Синхронизирует содержимое двух каталогов с помощью Robocopy
- Официальная документация модуля win_robocopy.
Примеры
- name: Synchronization of src on the control machine to dest on the remote hosts
synchronize:
src: some/relative/path
dest: /some/absolute/path
- name: Synchronization using rsync protocol (push)
synchronize:
src: some/relative/path/
dest: rsync://somehost.com/path/
- name: Synchronization using rsync protocol (pull)
synchronize:
mode: pull
src: rsync://somehost.com/path/
dest: /some/absolute/path/
- name: Synchronization using rsync protocol on delegate host (push)
synchronize:
src: /some/absolute/path/
dest: rsync://somehost.com/path/
delegate_to: delegate.host
- name: Synchronization using rsync protocol on delegate host (pull)
synchronize:
mode: pull
src: rsync://somehost.com/path/
dest: /some/absolute/path/
delegate_to: delegate.host
- name: Synchronization without any --archive options enabled
synchronize:
src: some/relative/path
dest: /some/absolute/path
archive: no
- name: Synchronization with --archive options enabled except for --recursive
synchronize:
src: some/relative/path
dest: /some/absolute/path
recursive: no
- name: 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
- name: Synchronization without --archive options enabled except use --links
synchronize:
src: some/relative/path
dest: /some/absolute/path
archive: no
links: yes
- name: Synchronization of two paths both on the control machine
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
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.
synchronize:
src: /first/absolute/path
dest: /second/absolute/path
delegate_to: delegate.host
- name: Synchronize two directories on one remote host.
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.
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
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
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
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
synchronize:
src: /tmp/localpath/
dest: /tmp/remotepath
rsync_path: /usr/gnu/bin/rsync
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается командой Ansible Core. [core]
Поддержка Red Hat
Дополнительную информацию о поддержке этого модуля Red Hat можно найти в этой статье базы знаний Red Hat.
Авторы
- Timothy Appnel (@tima)
Подсказка
Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/synchronize_module.html