README.md 8.4 KB
Newer Older
1 2
# Librarian-puppet

PeteMS's avatar
PeteMS committed
3 4
[![Build Status](https://travis-ci.org/rodjek/librarian-puppet.png?branch=master)](https://travis-ci.org/rodjek/librarian-puppet)

5 6
## Introduction

Tim Sharpe's avatar
Tim Sharpe committed
7 8 9 10 11 12 13 14 15
Librarian-puppet is a bundler for your puppet infrastructure.  You can use
librarian-puppet to manage the puppet modules your infrastructure depends on.
It is based on [Librarian](https://github.com/applicationsonline/librarian), a
framework for writing bundlers, which are tools that resolve, fetch, install,
and isolate a project's dependencies.

Librarian-puppet manages your `modules/` directory for you based on your
`Puppetfile`.  Your `Puppetfile` becomes the authoritative source for what
modules you require and at what version, tag or branch.
16

Tim Sharpe's avatar
Tim Sharpe committed
17 18 19
Once using Librarian-puppet you should not modify the contents of your `modules`
directory.  The individual modules' repos should be updated, tagged with a new
release and the version bumped in your Puppetfile.
20 21 22

## The Puppetfile

Tim Sharpe's avatar
Tim Sharpe committed
23 24 25
Every Puppet repository that uses Librarian-puppet will have a file named
`Puppetfile` in the root directory of that repository.  The full specification
for which modules your puppet infrastructure repository  depends goes in here.
26

27 28 29 30 31 32 33 34 35
### Simple Puppetfile

This Puppetfile will download all the dependencies listed in your Modulefile from the Puppet Forge

    forge "http://forge.puppetlabs.com"

    modulefile


36 37
### Example Puppetfile

Tim Sharpe's avatar
Tim Sharpe committed
38 39 40 41 42
    forge "http://forge.puppetlabs.com"

    mod "puppetlabs/razor"
    mod "puppetlabs/ntp", "0.0.3"

43
    mod "puppetlabs/apt",
44 45
      :git => "git://github.com/puppetlabs/puppetlabs-apt.git"

46
    mod "puppetlabs/stdlib",
47 48 49
      :git => "git://github.com/puppetlabs/puppetlabs-stdlib.git"


50 51
### Recursive module dependency resolving

52
When fetching a module all dependencies specified in its
53 54
`Modulefile` and `Puppetfile` will be resolved and installed.

55 56
### Puppetfile Breakdown

Tim Sharpe's avatar
Tim Sharpe committed
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71
    forge "http://forge.puppetlabs.com"

This declares that we want to use the official Puppet Labs Forge as our default
source when pulling down modules.  If you run your own local forge, you may
want to change this.

    mod "puppetlabs/razor"

Pull in the latest version of the Puppet Labs Razor module from the default
source.

    mod "puppetlabs/ntp", "0.0.3"

Pull in version 0.0.3 of the Puppet Labs NTP module from the default source.

72
    mod "puppetlabs/apt",
73 74
      :git => "git://github.com/puppetlabs/puppetlabs-apt.git"

Tim Sharpe's avatar
Tim Sharpe committed
75 76
Our puppet infrastructure repository depends on the `apt` module from the
Puppet Labs GitHub repos and checks out the `master` branch.
77

78
    mod "puppetlabs/apt",
79
      :git => "git://github.com/puppetlabs/puppetlabs-apt.git",
80 81
      :ref => '0.0.3'

Tim Sharpe's avatar
Tim Sharpe committed
82 83
Our puppet infrastructure repository depends on the `apt` module from the
Puppet Labs GitHub repos and checks out a tag of `0.0.3`.
84

85
    mod "puppetlabs/apt",
86
      :git => "git://github.com/puppetlabs/puppetlabs-apt.git",
87 88
      :ref => 'feature/master/dans_refactor'

Tim Sharpe's avatar
Tim Sharpe committed
89 90
Our puppet infrastructure repository depends on the `apt` module from the
Puppet Labs GitHub repos and checks out the `dans_refactor` branch.
91

Tim Sharpe's avatar
Tim Sharpe committed
92 93
When using a Git source, we do not have to use a `:ref =>`.
If we do not, then librarian-puppet will assume we meant the `master` branch.
94

Tim Sharpe's avatar
Tim Sharpe committed
95 96
If we use a `:ref =>`, we can use anything that Git will recognize as a ref.
This includes any branch name, tag name, SHA, or SHA unique prefix. If we use a
Joshua Johnson's avatar
Joshua Johnson committed
97
branch, we can later ask Librarian-puppet to update the module by fetching the
Tim Sharpe's avatar
Tim Sharpe committed
98
most recent version of the module from that same branch.
99

Tim Sharpe's avatar
Tim Sharpe committed
100 101 102 103 104 105
The Git source also supports a `:path =>` option. If we use the path option,
Librarian-puppet will navigate down into the Git repository and only use the
specified subdirectory. Some people have the habit of having a single repository
with many modules in it. If we need a module from such a repository, we can
use the `:path =>` option here to help Librarian-puppet drill down and find the
module subdirectory.
106

107
    mod "puppetlabs/apt",
108
      :git => "git://github.com/fake/puppet-modules.git",
109 110
      :path => "modules/apt"

Tim Sharpe's avatar
Tim Sharpe committed
111 112
Our puppet infrastructure repository depends on the `apt` module, which we have
stored as a directory under our `puppet-modules` git repos.
113 114 115

## How to Use

Tim Sharpe's avatar
Tim Sharpe committed
116
Install librarian-puppet:
117

Tom De Vylder's avatar
Tom De Vylder committed
118
    $ gem install librarian-puppet
119 120 121 122 123

Prepare your puppet infrastructure repository:

    $ cd ~/path/to/puppet-inf-repos
    $ (git) rm -rf modules
Tim Sharpe's avatar
Tim Sharpe committed
124
    $ librarian-puppet init
125

Tim Sharpe's avatar
Tim Sharpe committed
126 127 128 129
Librarian-puppet takes over your `modules/` directory, and will always
reinstall (if missing) the modules listed the `Puppetfile.lock` into your
`modules/` directory, therefore you do not need your `modules/` directory to be
tracked in Git.
130

Tim Sharpe's avatar
Tim Sharpe committed
131 132
Librarian-puppet uses a `.tmp/` directory for tempfiles and caches. You should
not track this directory in Git.
133

Tim Sharpe's avatar
Tim Sharpe committed
134 135
Running `librarian-puppet init` will create a skeleton Puppetfile for you as
well as adding `tmp/` and `modules/` to your `.gitignore`.
136 137 138

    $ librarian-puppet install [--clean] [--verbose]

Tim Sharpe's avatar
Tim Sharpe committed
139 140 141 142
This command looks at each `mod` declaration and fetches the module from the
source specified.  This command writes the complete resolution into
`Puppetfile.lock` and then copies all of the fetched modules into your
`modules/` directory, overwriting whatever was there before.
143

Tim Sharpe's avatar
Tim Sharpe committed
144
Get an overview of your `Puppetfile.lock` with:
145 146 147

    $ librarian-puppet show

Tim Sharpe's avatar
Tim Sharpe committed
148
Inspect the details of specific resolved dependencies with:
149 150 151

    $ librarian-puppet show NAME1 [NAME2, ...]

Tim Sharpe's avatar
Tim Sharpe committed
152
Find out which dependencies are outdated and may be updated:
153 154 155

    $ librarian-puppet outdated [--verbose]

Tim Sharpe's avatar
Tim Sharpe committed
156
Update the version of a dependency:
157 158 159 160 161 162

    $ librarian-puppet update apt [--verbose]
    $ git diff Puppetfile.lock
    $ git add Puppetfile.lock
    $ git commit -m "bumped the version of apt up to 0.0.4."

163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228
## Configuration

Configuration comes from three sources with the following highest-to-lowest
precedence:

* The local config (`./.librarian/puppet/config`)
* The environment
* The global config (`~/.librarian/puppet/config`)

You can inspect the final configuration with:

    $ librarian-puppet config

You can find out where a particular key is set with:

    $ librarian-puppet config KEY

You can set a key at the global level with:

    $ librarian-puppet config KEY VALUE --global

And remove it with:

    $ librarian-puppet config KEY --global --delete

You can set a key at the local level with:

    $ librarian-puppet config KEY VALUE --local

And remove it with:

    $ librarian-puppet config KEY --local --delete

You cannot set or delete environment-level config keys with the CLI.

Configuration set at either the global or local level will affect subsequent
invocations of `librarian-puppet`. Configurations set at the environment level are
not saved and will not affect subsequent invocations of `librarian-puppet`.

You can pass a config at the environment level by taking the original config key
and transforming it: replace hyphens (`-`) with underscores (`_`) and periods
(`.`) with doubled underscores (`__`), uppercase, and finally prefix with
`LIBRARIAN_PUPPET_`. For example, to pass a config in the environment for the key
`part-one.part-two`, set the environment variable
`LIBRARIAN_PUPPET_PART_ONE__PART_TWO`.

Configuration affects how various commands operate.

* The `path` config sets the cookbooks directory to install to. If a relative
  path, it is relative to the directory containing the `Puppetfile`. The
  equivalent environment variable is `LIBRARIAN_PUPPET_PATH`.

* The `tmp` config sets the cache directory for librarian. If a relative
  path, it is relative to the directory containing the `Puppetfile`. The
  equivalent environment variable is `LIBRARIAN_PUPPET_TMP`.

Configuration can be set by passing specific options to other commands.

* The `path` config can be set at the local level by passing the `--path` option
  to the `install` command. It can be unset at the local level by passing the
  `--no-path` option to the `install` command. Note that if this is set at the
  environment or global level then, even if `--no-path` is given as an option,
  the environment or global config will be used.



229 230
## How to Contribute

Tim Sharpe's avatar
Tim Sharpe committed
231 232
 * Pull requests please.
 * Bonus points for feature branches.
233 234 235

## Reporting Issues

Tim Sharpe's avatar
Tim Sharpe committed
236 237
Bug reports to the github issue tracker please.
Please include:
238

Joshua Johnson's avatar
Joshua Johnson committed
239 240
 * Relevant `Puppetfile` and `Puppetfile.lock` files
 * Version of ruby, librarian-puppet
Tim Sharpe's avatar
Tim Sharpe committed
241 242 243
 * What distro
 * Please run the `librarian-puppet` commands in verbose mode by using the
  `--verbose` flag, and include the verbose output in the bug report as well.
244

Tim Sharpe's avatar
Tim Sharpe committed
245

246
## License
Tim Sharpe's avatar
Tim Sharpe committed
247 248
Please see the [LICENSE](https://github.com/rodjek/librarian-puppet/blob/master/LICENSE)
file.