Forge Home

Modules

Puppet

Resources

PuppetEcosystemPuppet CommunityUpdates

vcsdeploy

Deploy an application from a repository and run command after fetch or update
Project URLRSS Feed

5,133 downloads

3,599 latest version

5.0 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Version information

  • 1.0.0 (latest)
  • 0.3.0
released Feb 3rd 2022
This version is compatible with:
  • Puppet Enterprise 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x, 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x
  • Puppet >= 6.0.0 < 8.0.0
  • ,

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'opuscodium-vcsdeploy', '1.0.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add opuscodium-vcsdeploy
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install opuscodium-vcsdeploy --version 1.0.0

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download

Documentation

opuscodium/vcsdeploy — version 1.0.0 Feb 3rd 2022

vcsdeploy

Table of Contents

Module Description

The vcsdeploy module lets you use Puppet to deploy an application from a git repository.

This vcsdeploy module is a wrapper around vcsrepo which tracks deployment steps and retries them on failure on subsequent agent runs, until it succeeds.

Rationale

This module allows to escape the usual trap with vcsrepo, where you notify resources on repository update, and these resources fail. On the next puppet run, the repository will be up-to-date and the failed operations are not retried.

Example :

vcsrepo { '/path/to/application':
  [...],
}
~> exec { '/path/to/application/scripts/bootstrap':
  refreshonly => true,
}

If you use this pattern, the exec resource will run on first fetch and on updates… but if /path/to/application/scripts/bootstrap fails during its execution, only the first catalog apply will failed.

Using vcsdeploy:

vcsdeploy {  '/path/to/application':
  [...],
  after_fetch_command => '/path/to/application/scripts/bootstrap',
}

If /path/to/application/scripts/bootstrap fails, it will be retried on each puppet agent run until successful.

Usage

With a simple command to run after fetch/update

vcsdeploy { '/path/to/application',
  source              => 'git://example.com/repo.git',
  user                => 'deploy_user',
  after_fetch_command => '/path/to/application/scripts/after-fetch',
}

With additonal resources to realize after fetch/update

vcsdeploy { '/path/to/application':
  source                => 'git://example.com/repo.git',
  user                  => 'deploy_user',
  after_fetch_command   => '/path/to/application/scripts/after-fetch',
  after_fetch_resources => [
    File['/path/to/application/tmp'],
    Exec['/path/to/application/scripts/apply-db-migrations'],
  ]
}

file { '/path/to/application/tmp':
  ensure => directory,
  user   => 'application_user',
}

exec { '/path/to/application/scripts/apply-db-migrations',
  user        => 'application_user',
  refreshonly => true,
}