Skip to content
Sync script to sync a copy of a GIT branch to your puppet master.
Branch: master
Clone or download
nibalizer Merge pull request #8 from uphillian/master
adding -q (--quiet) option for use in scripts
Latest commit 5f22f69 Mar 28, 2014
Type Name Latest commit message Commit time
Failed to load latest commit information.
extra Renaming executable puppet-sync -> puppetsync Dec 15, 2011
README.textile Update README.textile Jan 14, 2014
post-receive Fix spelling error in example post-receive filename Jan 23, 2013


Puppet Sync

This project provides a script to synchronize your manifests from a GIT
repository to your Puppet master.


Usage: puppet-sync -b BRANCH [options]
    -b, --branch BRANCH              Mandatory, specify the git branch to clone.
    -d, --deploy DIR                 Specify the directory to deploy to.
    -e, --environment DIR            Specify the name of the environment to deploy to, defaults to the branch.
    -D, --delete                     Remove the specified branch from the deployment directory.
    -r, --repository URL             Git url for the repository.
    -s SUBMODULES                    Comma-seperated list of submodule paths to enable.
Common options:
    -V, --version                    Display the script version.
    -v, --verbose                    Be more verbose.
    -h, --help                       Show this message

To sync a specific branch, to specific location, from a specific repository run the
script with the following arguments:

  puppet-sync --branch master \
              --deploy /etc/puppet/environments \
              --repository ssh+git://git/puppet.git

Git Hook

I usually call this script from a GIT hook. If your GIT repository is located
on a different server as your Puppet master, you will need to ensure that
a certain user can login to your Puppet server, without manual interactions.
I use the “puppet” user for this purpose.

  # change to the user and generate a key
  sudo -u puppet ssh-keygen -t rsa -b 4096 -f ~puppet/.ssh/id_rsa

  # copy the public key file to your puppetmaster server (where you have already
  # created the puppet user)
  ssh server 'cat - >> ~puppet/.ssh/authorized_keys' < ~puppet/.ssh/

Now you need to add the following to the Git hook file:

  # File: /git/puppet.git/hooks/post-receive

  SSH_ARGS="-i /path/to/privatekey"

  while read oldrev newrev refname
    BRANCH=`echo $refname | sed -n 's/^refs\/heads\///p'`
    [ "$newrev" -eq 0 ] 2> /dev/null && DELETE='--delete' || DELETE=''

      --branch "$BRANCH" \
      --repository "$REPO" \
      --deploy "$DEPLOY" \

You can’t perform that action at this time.