Spec-Zone.ru › Ansible 2.9

synchronize – Обертка вокруг rsync для ускорения и упрощения выполнения распространённых задач в ваших playbooks

  • Описание
  • Параметры
  • Примечания
  • См. также
  • Примеры
  • Статус

Описание

  • synchronize является обёрткой вокруг rsync, чтобы ускорить и упростить выполнение распространённых задач в ваших playbooks.
  • Он выполняется и инициализируется на локальном хосте, где запускается Ansible.
  • Конечно, вы можете просто использовать действие command для самостоятельного вызова rsync, но вам также нужно добавить большое количество параметров и фактов хоста.
  • Этот модуль не предназначен для предоставления доступа ко всем возможностям rsync, но упрощает выполнение самых распространённых вызовов. Вам still может потребоваться вызвать rsync напрямую с помощью command или shell, в зависимости от вашего случая использования.

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
archive
boolean
    Варианты:
  • no
  • yes ←
Отражает флаг rsync archive, включает рекурсивный поиск, ссылки, разрешения, временные метки, владельца, группу и флаг -D.
checksum
boolean
    Варианты:
  • no ←
  • yes
Пропуск на основе контрольной суммы вместо времени изменения и размера; обратите внимание, что опция «archive» всё ещё включена по умолчанию — опция «checksum» её не отключит.
compress
boolean
    Варианты:
  • no
  • yes ←
Сжимать данные файла во время передачи.
В большинстве случаев оставляйте включённым, если это не вызывает проблем.
copy_links
boolean
    Варианты:
  • no ←
  • yes
Копировать символические ссылки как элементы, на которые они указывают (ссылочные объекты), а не символические ссылки.
delete
boolean
    Варианты:
  • no ←
  • yes
Удалять файлы в dest, которые отсутствуют (после передачи, а не до) в пути src.
Эта опция требует recursive=yes.
Эта опция игнорирует исключённые файлы и работает как опция rsync --delete-excluded.
dest
string / обязательно
Путь на хосте назначения, который будет синхронизироваться из источника.
Путь может быть абсолютным или относительным.
dest_port
целое число
Порт SSH на хосте назначения.
До Ansible 2.0 переменная инвентаризации ansible_ssh_port имела приоритет над этим значением.
По умолчанию этот параметр принимает значение ansible_ssh_port или ansible_port, параметр конфигурации remote_port или значение из конфигурации SSH-клиента, если ни один из предыдущих параметров не задан.
dirs
boolean
    Варианты:
  • no ←
  • yes
Передавать каталоги без рекурсивного поиска.
existing_only
boolean
    Варианты:
  • no ←
  • yes
Пропускать создание новых файлов на получателе.
group
boolean
    Варианты:
  • no
  • yes
Сохранить группу.
По умолчанию этот параметр принимает значение опции archive.
link_dest
список
добавлено в 2.5
По умолчанию:
null
Добавить назначение для жёстких ссылок во время rsync.
links
boolean
    Варианты:
  • no
  • yes
Копировать символические ссылки как символические ссылки.
По умолчанию этот параметр принимает значение опции archive.
mode
строка
    Варианты:
  • pull
  • push ←
Указывает направление синхронизации.
В режиме push локальный хост или делегат является источником.
В режиме pull удалённый хост в контексте является источником.
owner
boolean
    Варианты:
  • no
  • yes
Сохранить владельца (только для суперпользователя).
По умолчанию этот параметр принимает значение опции archive.
partial
boolean
    Варианты:
  • no ←
  • yes
Указывает rsync сохранить частичный файл, что позволит значительно ускорить последующую передачу остальной части файла.
perms
boolean
    Варианты:
  • no
  • yes
Сохранить права доступа.
По умолчанию этот параметр принимает значение опции archive.
private_key
путь
Укажите используемый закрытый ключ для соединений rsync на основе SSH (например, ~/.ssh/id_rsa).
recursive
boolean
    Варианты:
  • no
  • yes
Рекурсивно искать в каталогах.
По умолчанию этот параметр принимает значение опции 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
    Варианты:
  • no
  • yes ←
Добавить user@ к путям удалённых объектов.
Если у вас есть настройка SSH для определения удалённого пользователя для хоста, не соответствующего пользователю инвентаризации, вы должны установить этот параметр в no.
src
строка / обязательно
Путь на хосте источника, который будет синхронизироваться с назначением.
Путь может быть абсолютным или относительным.
times
boolean
    Варианты:
  • no
  • yes
Сохранить время изменения.
По умолчанию этот параметр принимает значение опции archive.
use_ssh_args
boolean
    Варианты:
  • no ←
  • yes
Использовать параметры ssh, указанные в ansible.cfg.
verify_host
boolean
    Варианты:
  • no ←
  • yes
Проверить ключ хоста назначения.

Примечания

Примечание

  • rsync должен быть установлен как на локальном, так и на удалённом хосте.
  • Для модуля synchronize «локальный хост» — это хост the synchronize task originates on, а «хост назначения» — хост synchronize is connecting to.
  • «Локальный хост» можно изменить на другой, используя delegate_to. Это позволяет копировать файлы между двумя удалёнными хостами или полностью на одной удалённой машине.
  • Пользователь и разрешения для синхронизации src — это пользователь, выполняющий задачу Ansible на локальном хосте (или удалённый пользователь для хоста delegate_to, если используется delegate_to).
  • Пользователь и разрешения для синхронизации dest — это пользователь remote_user на хосте назначения или become_user в случае, если become=yes активен.
  • В Ansible 2.0 в модуле synchronize была ошибка, из-за которой возникали проблемы на «локальном хосте». Эта ошибка была исправлена в Ansible 2.0.1.
  • В настоящее время синхронизация ограничена повышением прав с помощью беспарольного 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.9/modules/synchronize_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API