Chocolatey Package Provider for Puppet

Build Status

Travis	AppVeyor

Table of Contents

1. Overview
2. Module Description - What the module does and why it is useful
   • Why Chocolatey
3. Setup - The basics of getting started with Chocolatey
   • What Chocolatey affects
   • Setup requirements
   • Beginning with Chocolatey provider
4. Usage - Configuration options and additional functionality
5. Reference - An under-the-hood peek at what the module is doing and how
6. Limitations - OS compatibility, etc.
7. Development - Guide for contributing to the module
8. Attributions

Overview

This is a Puppet package provider for chocolatey, which is like apt-get, but for Windows. This should be compatible with a wide range of Puppet versions.

Module Description

This is the official module for working with the Chocolatey package manager.

This module will ultimately be able to

• install Chocolatey
• work with custom location installations
• configure Chocolatey
• use Chocolatey as a package provider

Why Chocolatey

Chocolatey is a nicer abstraction because it nearly mimics how package managers on other operating systems work. If you can imagine the built in provider for Windows versus Chocolatey, let's take a look at the use case of installing git:

# Using built-in provider
package { "Git version 1.8.4-preview20130916":
  ensure    => installed,
  source    => 'C:\temp\Git-1.8.4-preview20130916.exe',
  install_options => ['/VERYSILENT']
}

# Using Chocolatey (set as default for Windows)
package { 'git':
  ensure   => latest,
}

The built-in provider has the following needs:

• Package name must match exactly the name from installed programs. See package name must be DisplayName
• Package name has issues with unicode characters
• Source must point to the location of the executable installer. See source is required.
• No ensure => latest - see handling versions and upgrades

Chocolatey's provider on the other hand:

• Package name only has to match the name of the package, which can be whatever you choose.
• The package is a nice abstraction
• Package knows how to install the software silently
• Package knows where to get the executable installer
• Source is free to specify different Chocolatey feeds
• Chocolatey makes package more platform agnostic since it looks exactly like other platforms.

Setup

What Chocolatey affects

Chocolatey affects your system and what software is installed on it, ranging from tools and portable software to natively installed applications.

Setup Requirements

Chocolatey requires the following components

• Powershell v2+
  • intalled on most systems by default
• .NET Framework v4+

NOTE: The module does not yet offer an installation option for Chocolatey, so you will need to install that as well.

Beginning with Chocolatey provider

Install this module via any of these approaches:

• puppet forge
• git-submodule (tutorial)
• librarian-puppet
• r10k

Usage

Set Chocolatey as Default Windows Provider

If you want to set this provider as the site-wide default, add to your site.pp:

if $::kernel == windows {
  # default package provider
  Package { provider => chocolatey, }
}

# OR

case $operatingsystem {
  'windows':
    Package { provider => chocolatey, }
}

With All Options

package { 'notepadplusplus':
  ensure            => installed|latest|'1.0.0'|absent,
  provider          => 'chocolatey',
  install_options   => ['-pre','-params','"','param1','param2','"'],
  uninstall_options => ['-r'],
  source            => 'https://myfeed.example.com/api/v2',
}

• this is versionable so ensure => '1.0' works
• this is upgradeable
• supports latest (checks upstream), absent (uninstall)
• supports install_options for pre-release, other cli
• supports 'pinnable'

Simple install

package { 'notepadplusplus':
  ensure   => installed,
  provider => 'chocolatey',
}

Ensure always the newest version available

package { 'notepadplusplus':
  ensure   => latest,
  provider => 'chocolatey',
}

Ensure specific version

package { 'notepadplusplus':
  ensure   => '6.7.5',
  provider => 'chocolatey',
}

Specify custom source

package { 'notepadplusplus':
  ensure   => '6.7.5',
  provider => 'chocolatey',
  source   => 'C:\local\folder\packages',
}

package { 'notepadplusplus':
  ensure   => '6.7.5',
  provider => 'chocolatey',
  source   => '\\unc\source\packages',
}

package { 'notepadplusplus':
  ensure   => '6.7.5',
  provider => 'chocolatey',
  source   => 'https://custom.nuget.odata.feed/api/v2/',
}

package { 'notepadplusplus':
  ensure   => '6.7.5',
  provider => 'chocolatey',
  source   => 'C:\local\folder\packages;https://chocolatey.org/api/v2/',
}

Install options with spaces

package {'launchy':
  ensure          => installed,
  provider        => 'chocolatey',
  install_options => ['-override', '-installArgs', '"', '/VERYSILENT', '/NORESTART', '"'],
}

Reference

• Chocolatey provider (lib/puppet/provider/package/chocolatey.rb)
• params.pp (manifests/params.pp)
• install.pp (manifests/install.pp)
• config.pp (manifests/config.pp)

Limitations

Works with Windows only.

Development

See CONTRIBUTING.md

Attributions

A special thanks goes out to Rich Siegel who wrote the original provider and continues to contribute to the development of this provider.