r10k 1.1.2 → 1.1.3

data/.gitignore

@@ -0,0 +1,5 @@
+/r10k*.gem
+Gemfile.local
+Gemfile.lock
+.bundle
+bundle

data/.travis.yml

@@ -0,0 +1,10 @@
+---
+language: ruby
+script: "bundle exec rspec --color --format documentation"
+notifications:
+  email: false
+rvm:
+  - "2.1.0"
+  - "2.0.0"
+  - "1.9.3"
+  - "1.8.7"

data/CHANGELOG

@@ -0,0 +1,162 @@
+CHANGELOG
+=========
+
+1.1.3
+-----
+
+2014-01-26
+
+This is a backwards compatible maintenance release.
+
+### Notes
+
+  * (GH-82) Added all git managed files, including README.markdown, CHANGELOG,
+    and LICENSE to the gemspec for better compatibility with non-gem packages.
+
+1.1.2
+-----
+
+2014-01-06
+
+This is a backwards compatible maintenance release.
+
+### Developer notes
+
+  * If Puppet and r10k are required in the same namespace, it's possible for
+    the vendored copy of SemVer to conflict with the Puppet version. This was
+    fixed by renaming the copy vendored in r10k and putting it under a namespace.
+
+1.1.1
+-----
+
+2013-12-11
+
+This is a backwards compatible bugfix release.
+
+### User notes
+
+  * (GH-48) Environment prefixing always defaults to off. Users were already
+    using r10k with multiple sources but in different directories, and
+    prefixing breaks this behavior. Since this was a backwards incompatible
+    change this has to be rolled back.
+  * (GH-64) Multiple sources in a single directory no longer purge each other.
+
+### Thanks
+
+Thanks to the following contributors for their help in 1.1.1:
+
+  * Stig Sandbeck Mathisen
+  * Gabriel M Schuyler
+
+1.1.0
+-----
+
+2013-09-30
+
+This is a backwards compatible bugfix and feature release.
+
+### User notes
+
+(GH-35) Puppetfiles can now specify a path to the moduledir, instead of assuming
+'/modules'. It can be set with the Puppetfile `moduledir` directive. Note that
+this is not compatible with librarian-puppet.
+
+(GH-53) Multiple environment sources can now be specified in a single
+directory. When multiple sources are specified, each environment will be
+prefixed with the source name. This can be enabled and disabled with the
+source `prefix` option.
+
+(GH-45) Documentation has been greatly expanded.
+
+(GH-56) New subcommand: `r10k puppetfile check` allows you to validate the
+syntax of a Puppetfile.
+
+(GH-66) Initial clones use `git checkout` when switching to a new branch
+instead of just `git reset`; without this change it would look like the wrong
+branch was checked out.
+
+(GH-59) r10k can now pull from Pulp repositories for Forge based modules.
+
+(GH-70) Handle unset HOME - in case that HOME is unset, assume that the current
+user is root. This mainly occurs when r10k is being run as the `prerun` command
+under Puppet.
+
+### Developer notes
+
+The method mocking framework has been switched from mocha to rspec-mocks. Mocha
+is notoriously bad about breaking changes between versions and rspec-mocks is
+very robust, so Mocha has been ripped out and dropped as a dependency.
+
+Rspec expectations now use the `expect(thing).to` syntax instead `thing.should`
+
+A quasi settings framework has been extracted to make application settings less
+bad. In the long term a general application framework will be extracted from
+r10k to handle generic 'application' problems like this, but for now the settings
+framework is the way to handle singleton data.
+
+R10K:Git::Cache object memoization has been extracted into a standalone class
+instead of being grafted onto the class. All hail the single responsibility
+principle!
+
+R10K::Module code has been refactored. There's now a real base class instead of
+a hacky mixin with some metadata magic on top.
+
+### Thanks
+
+Thanks to the following contributors for their help in 1.1.0:
+
+  * Alex Linden Levy
+  * Abhay Chrungoo
+  * Adam Vessey
+  * Chuck Schweizer
+  * Elias Probst
+  * Greg Baker
+  * Jochen Schalanda
+  * Theo Chatzimichos
+
+1.0.0
+-----
+
+2013-05-30
+
+This is a backwards incompatible bugfix and feature release.
+
+### Configuration
+
+The configuration file format of 0.0.9 should be compatible with 1.0.0, and any
+issues with that should be considered a bug.
+
+A longstanding issue was confusion between symbols and strings in r10k.yaml
+(GH-18). To resolve this, symbols and strings will be treated equally and
+should produce the same behavior. In the long run, symbols will probably be
+deprecated for the sake of conformity.
+
+### Command line invocation
+
+A number of commands have been renamed. They still but will emit a deprecation
+warning and will redirect to the new command implementation. The only
+exceptions is the are the `r10k environment cache` and `r10k environment stale`
+commands, but they were pretty much useless anyways.
+
+Log level verbosity can now be specified by level name instead of level number.
+If --verbose is passed without a level, it will set the log level to `info`.
+
+### Puppetfile support
+
+r10k can be used to deploy modules from a standalone Puppetfile. See
+`r10k puppetfile` for more information.
+
+Modules without a version in the format of 'foo/bar' will be assumed. (GH-21)
+
+### API
+
+r10k handles versioning according to SemVer; since this is a major release this
+is a backwards incompatible API change. It's unlikely that this has had any
+extensions written on top of it, but if you have, then heads up. However, all
+versions of 1.x should be backwards compatible.
+
+### Bugfixes
+
+A number of bugs were due to underlying architecture flaws. Part of 1.0.0 has
+been a significant architectural overhaul, so on top of all of the above
+changes there should be a lot of other bugs that have been fixed.

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+if File.exists? "#{__FILE__}.local"
+  eval(File.read("#{__FILE__}.local"), binding)
+end

data/LICENSE

@@ -0,0 +1,14 @@
+Copyright 2013, 2014 Adrien Thebo
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+

data/README.markdown

@@ -0,0 +1,270 @@
+r10k
+====
+
+Puppet environment and module deployment
+
+[![Build Status](https://travis-ci.org/adrienthebo/r10k.png?branch=master)](https://travis-ci.org/adrienthebo/r10k)
+
+Description
+-----------
+
+[librarian-puppet]: https://github.com/rodjek/librarian-puppet
+[workflow]: http://puppetlabs.com/blog/git-workflow-and-puppet-environments/
+
+r10k provides a general purpose toolset for deploying Puppet environments and
+modules. It implements the [Puppetfile][librarian-puppet] format and provides a native
+implementation of Puppet [dynamic environments][workflow].
+
+Installation
+------------
+
+r10k should be compatible with Ruby 1.8.7, 1.9.3, and 2.0.0. Any issue with
+those versions should be considered a bug.
+
+### Rubygems
+
+For general use, you should install r10k from Ruby gems:
+
+    gem install r10k
+    r10k --help
+
+### Bundler
+
+If you have more specific needs or plan on modifying r10k you can run it out of
+a git repository using Bundler for dependencies:
+
+    git clone git://github.com/adrienthebo/r10k
+    cd r10k
+    bundle install
+    bundle exec r10k --help
+
+### Puppet Enterprise
+
+Puppet Enterprise uses its own Ruby, so you need to use the correct version of gem when installing r10k.
+
+    /opt/puppet/bin/gem install r10k
+    r10k --help
+
+Common Commands
+---------------
+
+### Deploy all environments and Puppetfile specified modules
+
+    r10k deploy environment -p
+
+### Deploy all environments but don't update/install modules
+
+    r10k deploy environment
+
+### Deploy a specific environment, and its Puppetfile specified modules
+
+    r10k deploy environment your_env -p
+
+### Deploy a specific environment, but not its modules
+
+    r10k deploy environment your_env
+
+### Display all environments being managed by r10k
+
+    r10k deploy display
+
+### Display all environments being managed by r10k, and their modules.
+
+    r10k deploy display -p
+
+Puppetfile support
+------------------
+
+r10k can operate on a Puppetfile as a drop-in replacement for librarian-puppet.
+Puppetfiles are a simple Ruby based DSL that specifies a list of modules to
+install, what version to install, and where to fetch them from.
+
+Puppetfile based commands are under the `r10k puppetfile` subcommand.
+
+### Installing modules from git
+
+Puppet modules can be installed from any valid git repository:
+
+    mod 'rsyslog', :git => 'git://github.com/puppetlabs-operations/puppet-rsyslog.git'
+
+You can deploy a module from a specific branch, tag, or git ref. By default r10k
+will track `master` and will assume that you want to keep the module up to date.
+If you want to track a specific branch, then
+
+Examples:
+
+    # track master
+    mod 'filemapper',
+      :git => 'git://github.com/adrienthebo/puppet-filemapper.git'
+
+    # Install the filemapper module and track the 1.1.x branch
+    mod 'filemapper',
+      :git => 'git://github.com/adrienthebo/puppet-filemapper.git',
+      :ref => '1.1.x'
+
+    # Install filemapper and use the 1.1.1 tag
+    mod 'filemapper',
+      :git => 'git://github.com/adrienthebo/puppet-filemapper.git',
+      :ref => '1.1.1'
+
+    # Install filemapper and use a specific git commit
+    mod 'filemapper',
+      :git => 'git://github.com/adrienthebo/puppet-filemapper.git',
+      :ref => 'ec2a06d287f744e324cca4e4c8dd65c38bc996e2'
+
+### Installing modules from the Puppet forge
+
+Puppet modules can be installed from the forge using the Puppet module tool.
+
+    # This is currently a noop but will be supported in the future.
+    forge 'forge.puppetlabs.com'
+
+    # Install puppetlabs-stdlib from the Forge
+    mod 'puppetlabs/stdlib', '2.5.1'
+
+Basic Environment Structure
+---------------------------
+
+r10k supports Dynamic Environments (see below), but simple environment structures
+are also supported.
+
+The basic structure of an environment that uses a Puppetfile to install modules is
+
+    .
+    |-- manifests
+      |-- site.pp
+    |-- Puppetfile
+    |-- .gitignore
+
+site.pp would contain your node definitions, and the Puppetfile would specify the modules
+to be installed.  r10k automatically creates the 'modules' directory when it applies the
+Puppetfile.
+
+It's important to put the modules directory in .gitignore so that git doesn't accidentally
+put it into the repo.
+
+    modules/
+
+Dynamic environment support
+---------------------------
+
+r10k implements the dynamic environment workflow. Given a git repository with
+multiple branches r10k can create an environment for each branch. This means
+that you can use git with the normal branch-develop-merge workflow, and easily
+test your changes as you work.
+
+Deployment commands are implemented under the `r10k deploy` subcommand.
+
+### Git repository layout
+
+[modulepath]: http://docs.puppetlabs.com/references/stable/configuration.html#modulepath
+
+r10k makes the assumption that Puppet modules are stored in subdirectories of
+the Git repository. These directories are all loaded into the Puppet master with
+the [modulepath][modulepath] directive.
+
+For example, your Git repository would have a structure something like this:
+
+    .
+    ├── Puppetfile   # An optional Puppetfile
+    ├── dist         # Internally developed generic modules
+    └── site         # Modules for deploying custom services
+
+### Puppet master configuration
+
+In order to use dynamic environments, your Puppet masters will need to be
+configured to load manifests and modules relative to the requested environment:
+
+    [master]
+        modulepath = /etc/puppet/environments/$environment/modules:/etc/puppet/environments/$environment/dist
+
+        # If you use a top level manifest dir
+        manifestdir = /etc/puppet/environments/$environment/manifests
+        # If you use a specific site wide manifest
+        manifest = /etc/puppet/environments/$environment/manifests/nodes.pp
+
+Note that these settings go into the `[master]` section; you don't need to
+explicitly configure an environment section for each environment you want to
+use. (But you can if you want.)
+
+### Using dynamic environments with a Puppetfile
+
+
+r10k can implement a hybrid workflow with dynamic environments and Puppetfiles.
+If a Puppetfile is available at the root of a deployed environment, r10k can
+create and manage the `modules` directory within your Git repository.
+
+It's recommended that you add `/modules` to your project .gitignore.
+
+A deployed environment with a Puppetfile will look something like this:
+
+    .
+    ├── Puppetfile   # An optional Puppetfile
+    ├── dist         # Internally developed generic modules
+    ├── modules      # Puppet modules deployed by r10k
+    └── site         # Modules for deploying custom services
+
+It is also possible to set an alternate name/location for your `Puppetfile` and
+`modules` directory. This is useful if you want to control multiple environments
+and have a single location for your `Puppetfile`.
+
+Example:
+
+    PUPPETFILE=/etc/r10k.d/Puppetfile.production \
+    PUPPETFILE_DIR=/etc/puppet/modules/production \
+    /usr/bin/r10k puppetfile install
+
+### Dynamic environment configuration
+
+r10k uses a yaml based configuration file when handling deployments. The default
+location is in /etc/r10k.yaml and can be specified on the command line.
+
+### Example
+
+    # The location to use for storing cached Git repos
+    :cachedir: '/var/cache/r10k'
+
+    # A list of git repositories to create
+    :sources:
+      # This will clone the git repository and instantiate an environment per
+      # branch in /etc/puppet/environments
+      :plops:
+        remote: 'git@github.com:my-org/org-shared-modules'
+        basedir: '/etc/puppet/environments'
+
+Multiple git repositories can be specified, which is handy if environments are broken up by application.
+Application 1 could have its own environment repository with app1_dev, app1_tst, and app1_prd branches while
+Application 2 could have its own environment repository with app2_dev, app2_tst, app2_prd branches.
+
+You might want to take this approach if your environments vary greatly.  If you often find yourself making
+changes to your Application 1 environments that don't belong in your Application 2 environments, merging changes
+can become difficult if all of your environment branches are in a single repository.
+
+This approach also makes security easier as teams can be given access to control their application's environments
+without being able to accidentally impact other groups.
+
+### Multiple Environment Repositories Example
+
+    # The location to use for storing cached Git repos
+    :cachedir: '/var/cache/r10k'
+
+    # A list of git repositories to create
+    :sources:
+      # This will clone the git repository and instantiate an environment per
+      # branch in /etc/puppet/environments
+      :app1:
+        remote: 'git@github.com:my-org/app1-environments'
+        basedir: '/etc/puppet/environments'
+      :app2:
+        remote: 'git@github.com:my-org/app2-environments'
+        basedir: '/etc/puppet/environments'
+
+More information
+----------------
+
+The original impetus for r10k is explained at http://somethingsinistral.net/blog/rethinking-puppet-deployment/
+
+Contributors
+------------
+
+Please see the CHANGELOG for a listing of the (very awesome) contributors.

data/lib/r10k/cli.rb

@@ -16,7 +16,7 @@ module R10K::CLI
         complex environments.
       EOD
 
-      flag :h, :help, 'show help for this command'
+      flag :h, :help, 'Show help for this command'
       flag :t, :trace, 'Display stack traces on application crash'
 
       optional :v, :verbose, 'Set verbosity level' do |value, cmd|

data/lib/r10k/cli/deploy.rb

@@ -34,7 +34,7 @@ module R10K::CLI
         @cmd ||= Cri::Command.define do
           name    'environment'
           usage   'environment <options> <environment> <...>'
-          summary 'deploy environments and their dependent modules'
+          summary 'Deploy environments and their dependent modules'
 
           description <<-DESCRIPTION
 `r10k deploy environment` creates and updates Puppet environments based on Git
@@ -78,7 +78,7 @@ scheduled. On subsequent deployments, Puppetfile deployment will default to off.
         @cmd ||= Cri::Command.define do
           name  'module'
           usage 'module [module] <module ...>'
-          summary 'deploy modules in all environments'
+          summary 'Deploy modules in all environments'
 
           description <<-DESCRIPTION
 `r10k deploy module` Deploys and updates modules inside of Puppet environments.

data/lib/r10k/version.rb

@@ -1,3 +1,3 @@
 module R10K
-  VERSION = '1.1.2'
+  VERSION = '1.1.3'
 end

data/r10k.gemspec

@@ -0,0 +1,59 @@
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+require 'r10k/version'
+
+Gem::Specification.new do |s|
+  s.name        = "r10k"
+  s.version     = R10K::VERSION
+  s.platform    = Gem::Platform::RUBY
+
+  s.authors     = "Adrien Thebo"
+  s.email       = "adrien@somethingsinistral.net"
+  s.homepage    = "http://github.com/adrienthebo/r10k"
+  s.summary     = "Puppet environment and module deployment"
+  s.description = <<-DESCRIPTION
+    R10K provides a general purpose toolset for deploying Puppet environments and modules.
+    It implements the Puppetfile format and provides a native implementation of Puppet
+    dynamic environments.
+  DESCRIPTION
+
+  s.license  = 'Apache 2.0'
+
+  s.add_dependency 'colored',   '>= 1.2'
+  s.add_dependency 'cri',       '~> 2.4.0'
+  s.add_dependency 'systemu',   '~> 2.5.2'
+  s.add_dependency 'log4r',     '>= 1.1.10'
+  s.add_dependency 'json_pure'
+
+  s.add_development_dependency 'rspec', '~> 2.14.0'
+
+  s.files        = %x[git ls-files].split($/)
+  s.require_path = 'lib'
+  s.bindir       = 'bin'
+  s.executables  = 'r10k'
+
+  s.test_files   = Dir.glob("spec/**/*_spec.rb")
+
+  s.post_install_message = <<-EOD.gsub(/^ {4}/, '')
+    NOTICE
+    ======
+
+    If you are upgrading from 1.1.0 and are using multiple sources, please read
+    this. (If not, feel free to continue with your regularly scheduled day.)
+
+    GH-48 (https://github.com/adrienthebo/r10k/issues/48) introduced the ability
+    for environments to be prefixed with the source name so that multiple sources
+    installed into the same directory would not overwrite each other. However
+    prefixing was automatically enabled and would break existing setups where
+    multiple sources were cloned into different directories.
+
+    Because this introduced a breaking change, SemVer dictates that the automatic
+    prefixing has to be rolled back. Prefixing can be enabled but always defaults
+    to off. If you are relying on this behavior you will need to update your r10k.yaml
+    to enable prefixing on a per-source basis.
+
+    Please see the issue (https://github.com/adrienthebo/r10k/issues/48) for more
+    information.
+  EOD
+end

data/r10k.yaml.example

@@ -0,0 +1,5 @@
+:cachedir: '/var/cache/r10k'
+:sources:
+  :plops:
+    remote: 'git@github.com:my-org/org-shared-modules'
+    basedir: '/etc/puppet/environments'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: r10k
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-06 00:00:00.000000000 Z
+date: 2014-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colored
@@ -116,62 +116,71 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
+- .travis.yml
+- CHANGELOG
+- Gemfile
+- LICENSE
+- README.markdown
 - bin/r10k
 - lib/r10k.rb
-- lib/r10k/errors.rb
-- lib/r10k/logging.rb
-- lib/r10k/semver.rb
-- lib/r10k/registry.rb
-- lib/r10k/deployment.rb
-- lib/r10k/settings.rb
-- lib/r10k/git/errors.rb
-- lib/r10k/git/cache.rb
-- lib/r10k/git/working_dir.rb
-- lib/r10k/git/repository.rb
 - lib/r10k/cli.rb
-- lib/r10k/module.rb
-- lib/r10k/task_runner.rb
-- lib/r10k/execution.rb
-- lib/r10k/puppetfile.rb
-- lib/r10k/deployment/environment.rb
-- lib/r10k/deployment/config/loader.rb
-- lib/r10k/deployment/config.rb
-- lib/r10k/deployment/basedir.rb
-- lib/r10k/deployment/source.rb
-- lib/r10k/util/purgeable.rb
+- lib/r10k/cli/deploy.rb
 - lib/r10k/cli/environment.rb
-- lib/r10k/cli/environment/list.rb
 - lib/r10k/cli/environment/deploy.rb
+- lib/r10k/cli/environment/list.rb
 - lib/r10k/cli/environment/stale.rb
-- lib/r10k/cli/module.rb
-- lib/r10k/cli/synchronize.rb
-- lib/r10k/cli/puppetfile.rb
-- lib/r10k/cli/deploy.rb
 - lib/r10k/cli/ext/logging.rb
-- lib/r10k/cli/module/list.rb
+- lib/r10k/cli/module.rb
 - lib/r10k/cli/module/deploy.rb
+- lib/r10k/cli/module/list.rb
+- lib/r10k/cli/puppetfile.rb
+- lib/r10k/cli/synchronize.rb
 - lib/r10k/cli/version.rb
+- lib/r10k/deployment.rb
+- lib/r10k/deployment/basedir.rb
+- lib/r10k/deployment/config.rb
+- lib/r10k/deployment/config/loader.rb
+- lib/r10k/deployment/environment.rb
+- lib/r10k/deployment/source.rb
+- lib/r10k/errors.rb
+- lib/r10k/execution.rb
+- lib/r10k/git/cache.rb
+- lib/r10k/git/errors.rb
+- lib/r10k/git/repository.rb
+- lib/r10k/git/working_dir.rb
+- lib/r10k/logging.rb
+- lib/r10k/module.rb
+- lib/r10k/module/base.rb
+- lib/r10k/module/forge.rb
+- lib/r10k/module/git.rb
+- lib/r10k/puppetfile.rb
+- lib/r10k/registry.rb
+- lib/r10k/semver.rb
+- lib/r10k/settings.rb
 - lib/r10k/settings/container.rb
 - lib/r10k/settings/mixin.rb
-- lib/r10k/task/environment.rb
+- lib/r10k/task.rb
 - lib/r10k/task/deployment.rb
+- lib/r10k/task/environment.rb
 - lib/r10k/task/module.rb
 - lib/r10k/task/puppetfile.rb
-- lib/r10k/task.rb
-- lib/r10k/module/base.rb
-- lib/r10k/module/forge.rb
-- lib/r10k/module/git.rb
+- lib/r10k/task_runner.rb
+- lib/r10k/util/purgeable.rb
 - lib/r10k/version.rb
-- spec/spec_helper.rb
-- spec/fixtures/module/forge/eight_hundred/metadata.json
+- r10k.gemspec
+- r10k.yaml.example
+- spec/fixtures/empty/.empty
 - spec/fixtures/module/forge/eight_hundred/Modulefile
-- spec/unit/registry_spec.rb
-- spec/unit/module_spec.rb
-- spec/unit/git/working_dir_spec.rb
+- spec/fixtures/module/forge/eight_hundred/metadata.json
+- spec/spec_helper.rb
 - spec/unit/deployment/environment_spec.rb
 - spec/unit/deployment/source_spec.rb
-- spec/unit/settings/container_spec.rb
+- spec/unit/git/working_dir_spec.rb
 - spec/unit/module/forge_spec.rb
+- spec/unit/module_spec.rb
+- spec/unit/registry_spec.rb
+- spec/unit/settings/container_spec.rb
 homepage: http://github.com/adrienthebo/r10k
 licenses:
 - Apache 2.0