cdist-type__rsync(7)

Overview

The purpose of this type is to bring power of rsync into cdist.

Required parameters

source: Source directory in local machine. If source is directory, slash (/) will be added to source and destination paths.

Optional parameters

destination: Destination directory. Defaults to $__object_id.

owner: Will be passed to rsync as --chown=OWNER. Read rsync(1) for more details.

group: Will be passed to rsync as --chown=:GROUP. Read rsync(1) for more details.

mode: Will be passed to rsync as --chmod=MODE. Read rsync(1) for more details.

options

Defaults to --recursive --links --perms --times. Due to

`bug in Python's argparse<https://bugs.python.org/issue9334>`_

, value must be prefixed with \.

remote-user: Defaults to root.

Optional multiple parameters

option

Pass additional options to rsync. See rsync(1) for all possible options. Due to

`bug in Python's argparse<https://bugs.python.org/issue9334>`_

, value must be prefixed with \.

Examples

__rsync /var/www/example.com \
    --owner root \
    --group www-data \
    --mode 'D750,F640' \
    --source "$__files/example.com/www"

Copying

Copyright (C) 2021 Ander Punnar. 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.

History

Debian 13 (Trixie): the text shown here
Debian 12 (Bookworm)
Debian 11 (Bullseye)
Debian 10 (Buster)
Debian 9 (Stretch)