vcsdeploy

Table of Contents

• Module Description
• Rationale
• Usage
  • With a simple command to run after fetch/update
  • With additonal resources to realize after fetch/update

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,
}

Reference

Table of Contents

Defined types

• vcsdeploy: Deploy an application using VCS

Defined types

vcsdeploy

This defined type will deploy an application that comes from a repository.

At first fetch and on updates, this will run a custom command.

Examples

vcsdeploy { '/path/to/application':
  ensure              => latest,
  source              => 'https://gitlab.com/corporation/application',
  after_fetch_command => '/path/to/application/bin/deploy',
}

Parameters

The following parameters are available in the vcsdeploy defined type.

source

Data type: String[1]

The source URI for the repository

after_fetch_command

Data type: Stdlib::Absolutepath

The command to execute after VCS fetch

ensure

Data type: Enum[latest, present, absent]

Ensure the version control repository

Default value: latest

target

Data type: Stdlib::Absolutepath

The target path to fetch repository

Default value: $name

revision

Data type: String[1]

The revision of the repository

Default value: 'master'

user

Data type: Optional[String[1]]

The user/uid that owns the repository files and run after fetch command

Default value: undef

group

Data type: Optional[String[1]]

The group/gid that owns the repository files and run after fetch command

Default value: $user

vcsrepo_attributes

Data type: Hash

The additionnal attributes passed to vcsrepo resource

Default value: {}

after_fetch_command_attributes

Data type: Hash

The additionnal attributes passed to exec resource

Default value: {}

after_fetch_resources

Data type: Array[Type[Resource]]

The resources that need to be realized after a fetch

Default value: []

Changelog

All notable changes to this project will be documented in this file.

Release 0.1.0

Features

Bugfixes

Known Issues