r10k 3.5.2

data/doc/git/providers.mkd

@@ -0,0 +1,111 @@
+Git Providers
+=============
+
+As of 1.5.0, r10k can interact with Git repositories using multiple Git
+providers.
+
+Shellgit
+--------
+
+The shellgit provider is the original Git provider that is based on shelling out
+to the `git` binary. It relies on the standard set of Git userland executables
+in order to work.
+
+The shellgit provider is the default Git provider in order to maintain
+compatibility with existing r10k installations.
+
+### Requirements
+
+The shellgit provider requires that `git` can be found on the `PATH` environment
+variable. This can be done by installing the git package via the system package
+manager.
+
+### SSH Configuration
+
+Because the shellgit provider relies on the `git` command which in turn uses the
+`ssh` binary as the SSH transport layer, configuring access to Git repositories
+over SSH is done by configuring the underlying `ssh` command.
+
+Rugged
+------
+
+The rugged provider is based on the [libgit2](https://github.com/libgit2/libgit2)
+library and the Ruby [rugged gem](https://github.com/libgit2/rugged).
+
+### SSH Configuration
+
+Since the rugged provider does not read ~/.ssh if using SSH based Git
+repositories, the 'private_key' option must be provided. An optional 'username'
+field can be provided when the Git remote URL does not provide a username.
+
+```yaml
+git:
+  private_key: '/root/.ssh/id_rsa'
+  username: 'git'
+```
+
+If you have per repository private keys you can add them with the repositories list.
+
+```yaml
+git:
+  # default private key
+  private_key: '/root/.ssh/id_rsa'
+  repositories:
+    - remote: "git@github.com:my_org/private_repo"
+      # private key for this repo only
+      private_key: '/root/.ssh/private_repo_id'
+```
+
+#### Supported transports with Rugged
+
+Rugged compiles libgit2 and and the Ruby bindings when the gem is installed. You
+may need libraries installed before you install the gem to use certain protocols
+to access git remote repositories.
+
+For ssh support, you need to have libssh2 installed (along with the relevant dev
+package/headers) before you install the Rugged gem.
+
+For https support on Linux, you need to have OpenSSL installed (along with the
+relevant dev package/headers) before you install the Rugged gem. OS X and
+Windows support should automatically include https support.
+
+You can check whether https or ssh support is included in your Rugged
+installation by using the following in irb and making sure the required feature
+is listed:
+
+```ruby
+irb(main):001:0> require('rugged')
+=> true
+irb(main):002:0> Rugged.features
+=> [:threads, :https, :ssh]
+irb(main):003:0>
+```
+You will require the ':https' or ':ssh' features to use the respective protocols
+in your Puppetfile module references or in r10k.yaml. R10K 2.0.0 and later will
+automatically issue a warning if either feature is missing.
+
+libssh2 on Debian and Ubuntu is compiled against libgcrypto instead of OpenSSL
+[due to licensing reasons](https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=668271), and
+unfortunately libgcrypto does not support a number of required operations,
+including reading from a private key file. You will need to either use shellgit
+or recompile your own libssh2-1 package to use OpenSSL on these distributions.
+If you see the following error message, this is the likely cause:
+
+    Failed to authenticate SSH session: Unable to extract public key from private key file: Method unimplemented in libgcrypt backend at /var/cache/r10k/ssh---git@git.example.com-sys-puppet.git
+
+Configuration
+-------------
+
+R10K will attempt to use the shellgit provider, then fall back to the rugged
+provider, and then hard fail if no Git provider is available.
+
+The Git provider in use can be manually specified by specifying the desired
+provider in r10k.yaml.
+
+```yaml
+git:
+  provider: 'rugged'
+```
+
+Valid values are 'rugged' and 'shellgit'. If an invalid value is used r10k will
+raise an error.

data/doc/puppetfile.mkd

@@ -0,0 +1,309 @@
+Puppetfile
+==========
+
+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. r10k can use a
+Puppetfile to install a set of Puppet modules for local development, or they can
+be used with r10k environment deployments to install additional modules into a
+given environment.
+
+Unlike librarian-puppet, the r10k implementation of Puppetfiles does not include
+dependency resolution, but it is on the roadmap.
+
+When directly working with Puppetfiles, you can use the `r10k puppetfile`
+subcommand to interact with a Puppetfile.
+
+When using r10k's deploy functionality, interacting with Puppetfiles is handled
+on a case by case basis.
+
+Because the Puppetfile format is actually implemented using a Ruby DSL any valid
+Ruby expression can be used. That being said, being a bit too creative in the
+DSL can lead to surprising (read: bad) things happening, so consider keeping it
+simple.
+
+Commands
+--------
+
+Puppetfile subcommands assume that the Puppetfile to operate on is in the
+current working directory and modules should be installed in the 'modules'
+directory relative to the current working directory.
+
+Install or update all modules in a given Puppetfile
+into ./modules)
+
+    r10k puppetfile install
+
+Verify the Puppetfile syntax
+
+    r10k puppetfile check
+
+Remove any modules in the 'modules' directory that are not specified in the
+Puppetfile:
+
+    r10k puppetfile purge
+
+Global settings
+---------------
+
+The following settings can be used to control how the Puppetfile installs and
+handles modules.
+
+### forge
+
+The `forge` setting specifies which server that Forge based modules are fetched
+from. This is currently a noop and is provided for compatibility with
+librarian-puppet.
+
+R10k supports setting the Forge to use _globally_ in `r10k.yaml`. see [Configuration](/doc/dynamic-environments/configuration.mkd#baseurl) for details.
+
+### moduledir
+
+The `moduledir` setting specifies where modules from the Puppetfile will be
+installed. This defaults to the `modules` directory relative to the Puppetfile.
+If the path is absolute then the modules will be installed to that absolute
+path, otherwise it's assumed that the `moduledir` setting should be relative and
+the modules will be installed in that directory relative to the Puppetfile.
+
+The moduledir setting should be placed before any modules are declared.
+
+Install modules to an absolute path:
+
+```ruby
+moduledir '/etc/puppet/modules'
+
+mod 'branan/eight_hundred' # will be installed into '/etc/puppet/modules/eight_hundred'
+```
+
+Install modules to a relative path:
+
+```ruby
+moduledir 'thirdparty'
+
+mod 'branan/eight_hundred' # will be installed into `dirname /path/to/Puppetfile`/thirdparty/eight_hundred
+```
+
+**Note**: support for a relative moduledir was added in r10k 1.4.0; the behavior
+of a relative moduledir path is undefined on earlier versions of r10k.
+
+Module types
+------------
+
+r10k can install Puppet modules from a number of different sources. Right now
+modules can be installed from the Puppet Forge, Git, or SVN.
+
+### Puppet Forge
+
+Modules can be installed from the Puppet Forge.
+
+If no version is specified the latest version available at the time will be
+installed, and will be kept at that version.
+
+    mod 'puppetlabs/apache'
+
+If a version is specified then that version will be installed.
+
+    mod 'puppetlabs/apache', '0.10.0'
+
+If the version is set to :latest then the module will be always updated to the
+latest version available.
+
+    mod 'puppetlabs/apache', :latest
+
+### Git
+
+Git repositories that contain a Puppet module can be cloned and used as modules.
+When Git is used, the module version can be specified by using `:ref`, `:tag`,
+`:commit`, and `:branch`.
+
+When a module is installed using `:ref`, r10k uses some simple heuristics to
+determine the type of Git object that should be checked out. This can be used
+with a git commit, branch reference, or a tag.
+
+When a module is installed using `:tag` or `:commit`, r10k assumes that the
+given object is a tag or commit and can do some optimizations around fetching
+the object. If the tag or commit is already available r10k will skip network
+operations when updating the repo, which can speed up install times.
+
+Module versions can also be specified using `:branch` to track a specific
+branch reference.
+
+#### Examples
+
+```ruby
+# Install puppetlabs/apache and keep it up to date with 'master'
+mod 'apache',
+  :git => 'https://github.com/puppetlabs/puppetlabs-apache'
+
+# Install puppetlabs/apache and track the 'docs_experiment' branch
+mod 'apache',
+  :git => 'https://github.com/puppetlabs/puppetlabs-apache',
+  :ref => 'docs_experiment'
+
+# Install puppetlabs/apache and pin to the '0.9.0' tag
+mod 'apache',
+  :git => 'https://github.com/puppetlabs/puppetlabs-apache',
+  :tag => '0.9.0'
+
+# Install puppetlabs/apache and pin to the '83401079' commit
+mod 'apache',
+  :git    => 'https://github.com/puppetlabs/puppetlabs-apache',
+  :commit => '83401079053dca11d61945bd9beef9ecf7576cbf'
+
+# Install puppetlabs/apache and track the 'docs_experiment' branch
+mod 'apache',
+  :git    => 'https://github.com/puppetlabs/puppetlabs-apache',
+  :branch => 'docs_experiment'
+```
+
+#### Control Repo Branch Tracking
+
+Since r10k 2.4.0, the `:branch` option can be set to the special value
+`:control_branch` to indicate that the content should track a branch
+reference matching the containing control repo branch. For example, if a
+Puppetfile containing a Git content declaration is in the "testing" branch
+of a control repo, a setting of `:control_branch` will attempt to deploy that
+content from a "testing" branch of the content repo.
+
+Additionally, you can specify a `:default_branch` option which is the branch
+reference that content will be deployed from if the the given `:ref`, `:tag`,
+`:commit`, or `:branch` option cannot be resolved and deployed. If the desired
+content cannot be resolved and no default branch is given, or if the default
+branch can also not be resolved, an error will be logged and the content will
+not be deployed or updated.
+
+#### :control\_branch Examples
+
+```ruby
+# Deploy content from branch matching control repo branch.
+mod 'hieradata',
+  :git => 'git@git.example.com:organization/hieradata.git',
+  :branch => :control_branch
+
+# Track control branch and fall-back to master if no matching branch.
+mod 'hieradata',
+  :git => 'git@git.example.com:organization/hieradata.git',
+  :branch => :control_branch,
+  :default_branch => 'master'
+```
+
+
+### SVN
+
+Modules can be installed via SVN. If no version is given, the module will track
+the latest version available in the main SVN repository.
+
+    mod 'apache',
+      :svn => 'https://github.com/puppetlabs/puppetlabs-apache/trunk'
+
+If an SVN revision number is specified with `:rev` (or `:revision`), that
+SVN revision will be kept checked out.
+
+    mod 'apache',
+      :svn => 'https://github.com/puppetlabs/puppetlabs-apache/trunk',
+      :rev => '154'
+
+    mod 'apache',
+      :svn      => 'https://github.com/puppetlabs/puppetlabs-apache/trunk',
+      :revision => '154'
+
+If the SVN repository requires credentials, you can supply the `:username` and
+`:password` options.
+
+    mod 'apache',
+      :svn      => 'https://github.com/puppetlabs/puppetlabs-apache/trunk',
+      :username => 'azurediamond',
+      :password => 'hunter2'
+
+**Note**: SVN credentials are passed as command line options, so the SVN
+credentials may be visible in the process table when r10k is running. If you
+choose to supply SVN credentials make sure that the system running r10k is
+appropriately secured.
+
+### Local
+
+In the event you want to store locally written modules in your r10k-managed
+repository in the Puppetfile managed path, you can use the `:local` type.
+
+For instance, if you have a Git repository with the following structure:
+
+```
+# tree -L 2
+.
+├── environment.conf
+├── modules
+│   └── local_module
+└── Puppetfile
+
+4 directories, 2 files
+```
+
+And you want to prevent `local_module` from being removed, you can add a 'local'
+module in your Puppetfile:
+
+```
+mod 'local_module', :local => true
+
+# Include your other modules as normal
+mod 'branan/eight_hundred'
+mod 'puppetlabs/apache'
+```
+
+If you run r10k against this Git branch, you'll get the following:
+
+```
+# tree -L 2
+.
+├── environment.conf
+├── modules
+│   ├── apache
+│   ├── eight_hundred
+│   └── local_module
+└── Puppetfile
+
+4 directories, 2 files
+```
+
+#### Caveats
+
+This is a workaround for r10k not being able to determine that modules
+created via VCS should not be purged, but is not meant to be a long term
+solution. The general practice around having local and remote modules in the
+same Git repository is to move modules versioned into a separate directory, like
+so:
+
+```
+# tree -L 2
+.
+├── environment.conf
+├── site-modules
+│   └── local_module
+├── modules
+│   ├── apache
+│   └── eight_hundred
+└── Puppetfile
+
+4 directories, 2 files
+```
+
+Moving modules stored in the Git repository into a separate directory will
+remove the need to have Puppetfile entries for every locally versioned Puppet
+module.
+
+For more information see the [FAQ entry](faq.mkd#how-do-i-prevent-r10k-from-removing-modules-in-the-modules-directory-of-my-git-repository)
+on managing internal and external modules in the same directory.
+
+### Per-Item Install Path
+
+Git and SVN content types support installing into an alternate path without changing
+the value of moduledir by specifying an 'install\_path' option:
+
+```
+# This will install the 'apache' module into 'external/apache'.
+mod 'apache',
+  :git => 'git@github.com:puppetlabs/puppetlabs-apache.git',
+  :install_path => 'external'
+```
+
+The given 'install\_path' can be an absolute path or a path relative to the base of
+the environment. Note that r10k will exit with an error if you attempt to set the
+'path' option to a directory outside of the environment.

data/doc/updating-your-puppetfile.mkd

@@ -0,0 +1,38 @@
+Updating Your Puppetfile
+========================
+
+Over time, your Puppetfile may become stale and reference older versions of modules or miss dependencies for the modules. Your Puppetfile will require maintenance to keep it up to date.
+
+Manual Updates
+--------------
+
+You can manually update your Puppetfile very easily. By visiting the module's homepage on the [Puppet Forge](https://forge.puppetlabs.com/), you can determine the new version of a module and update it:
+
+    # Original
+    mod 'puppetlabs/apache', '0.10.0'
+    
+    # New
+    mod 'puppetlabs/apache', '1.0.0'
+
+When using a module directly from a git/svn repo, the `:tag` or `:ref` should be updated:
+
+    # Original
+    mod 'apache',
+      :git => 'https://github.com/puppetlabs/puppetlabs-apache',
+      :tag => '0.10.0'
+      
+    # Original
+    mod 'apache',
+      :git => 'https://github.com/puppetlabs/puppetlabs-apache',
+      :tag => '1.0.0'
+
+Dependency tracking can be done on the Puppet Forge as well by looking at the Dependency tab (Ex: [puppetlabs/apache](https://forge.puppetlabs.com/puppetlabs/apache/dependencies) and visiting each module in turn, or examining `metadata.json` in non-forge modules.
+
+Automatic Updates
+-----------------
+
+The manual update process is sufficient when updating a small number of modules for a specific effort. Automatic tooling is helpful when updating a lengthier number of modules and for scheduled updates. A number of tools have been provided by the Puppet user community to assist with this. You are encouraged to review each tool before using them, and use of these tools is at your own risk.
+
+* [ra10ke](https://rubygems.org/gems/ra10ke) ([project page](https://github.com/tampakrap/ra10ke/)) - A set of rake tasks to scan the Puppetfile for out of date modules
+* [puppetfile-updater](https://rubygems.org/gems/puppetfile-updater/) ([project page](https://github.com/camptocamp/puppetfile-updater)) - A set of rake tasks to scan the Puppetfile, find newer versions, update the Puppetfile, and commit the changes.
+* [generate-puppetfile](https://rubygems.org/gems/generate-puppetfile) ([project page](https://github.com/rnelson0/puppet-generate-puppetfile)) - A command line tool to generate raw Puppetfiles, update existing Puppetfiles, and optionally generate a `.fixtures.yml` file.