Merge pull request #5 from jantman/newnew

Major layout change

Author: jantman

.fixtures.yml

@@ -41,5 +41,5 @@ fixtures:
       repo: "https://github.com/puppetlabs/puppetlabs-apt.git"
       ref: "2.3.0"
   symlinks:
-    workstation_bootstrap: "#{source_dir}/puppet/modules/workstation_bootstrap"
+    workstation_bootstrap: "#{source_dir}/modules/local/workstation_bootstrap"
     privatepuppet: "#{source_dir}/spec/fixtures/privatepuppet"

.gitignore

@@ -20,3 +20,5 @@ spec/fixtures/modules/
 spec/fixtures/hiera.yaml
 tmp/
 vendor/
+/hiera.yaml
+modules/r10k

CHANGELOG.md

@@ -1,3 +1,7 @@
+## [3.0.0] Released 2018-05-21
+
+- Completely rework from previous system-wide installation to be run directly from git clone
+
 ## [2.0.0] Released 2018-02-04
 
 - Update all dependencies and layout via modulesync, to modern Puppet5 version.

Gemfile

@@ -56,11 +56,11 @@ group :system_tests do
   gem "beaker-docker", '>= 0.3.0',                                               :require => false
   gem "puppet-module-posix-system-r#{minor_version}",                            :require => false, :platforms => "ruby"
   gem "puppet-module-win-system-r#{minor_version}",                              :require => false, :platforms => ["mswin", "mingw", "x64_mingw"]
-  gem "beaker", *location_for(ENV['BEAKER_VERSION'] || '>= 3')                  
+  gem "beaker", *location_for(ENV['BEAKER_VERSION'] || '>= 3')
   gem "beaker-pe",                                                               :require => false
-  gem "beaker-rspec", *location_for(ENV['BEAKER_RSPEC_VERSION'])                
+  gem "beaker-rspec", *location_for(ENV['BEAKER_RSPEC_VERSION'])
   gem "beaker-hostgenerator", *location_for(ENV['BEAKER_HOSTGENERATOR_VERSION'])
-  gem "beaker-abs", *location_for(ENV['BEAKER_ABS_VERSION'] || '~> 0.1')        
+  gem "beaker-abs", *location_for(ENV['BEAKER_ABS_VERSION'] || '~> 0.1')
   gem "puppet-blacksmith", '>= 4.1.1',                                           :require => false
   gem "vandamme",                                                                :require => false
   gem "octokit", '~> 4.0',                                                       :require => false
@@ -75,6 +75,8 @@ gem 'puppet', *location_for(ENV['PUPPET_GEM_VERSION'])
 gem 'facter', *location_for(ENV['FACTER_GEM_VERSION']) if ENV['FACTER_GEM_VERSION']
 gem 'hiera', *location_for(ENV['HIERA_GEM_VERSION']) if ENV['HIERA_GEM_VERSION']
 
+gem 'r10k'
+
 # Evaluate Gemfile.local if it exists
 if File.exists? "#{__FILE__}.local"
   eval(File.read("#{__FILE__}.local"), binding)

puppet/Puppetfile renamed to Puppetfile

@@ -4,33 +4,38 @@
 
 #### Table of Contents
 
-1. [Overview](#overview)
+1. [Important Notice About Version 3.0.0](#important-notice-about-version-300)
+2. [Overview](#overview)
     * [Warning](#warning)
-2. [Prerequisites](#prerequisites)
+3. [Prerequisites](#prerequisites)
     * [General](#general)
 	* [Arch Linux](#arch-linux)
-3. [Customization](#customization)
+4. [Customization](#customization)
     * [Hiera Data](#hiera-data)
     * [Sensitive Information](#sensitive-information)
-4. [Setup](#setup)
-5. [Usage](#usage)
-6. [Reference](#reference)
+5. [Setup](#setup)
+6. [Usage](#usage)
+7. [Reference](#reference)
     * [site.pp manifests](#site.pp-manifest)
     * [Puppetfile](#puppetfile)
     * [workstation_bootstrap module](#workstation_bootstrap-module)
     * [Hiera](#hiera)
     * [Hiera Ordering](#hiera-ordering)
-7. [Testing](#testing)
+8. [Testing](#testing)
+
+## Important Notice About Version 3.0.0
+
+Versions 2.0.0 and earlier of this repository were a full [control repository](https://puppet.com/docs/pe/latest/code_management/control_repo.html) setup for environments and intended to be checked out into the distribution default Puppet config directories (i.e. ``/etc/puppet/code``). I've found this to be cumbersome, unusual, and difficult to maintain. As a result, Version 3.0.0 changes this repository to run directly from the git clone in the way that masterless Puppet provisioners are typically used. Hopefully this will make it easier for others to use as an example.
 
 ## Overview
 
-This is an example of a puppet/[r10k](https://github.com/puppetlabs/r10k) [control repository](https://puppet.com/docs/pe/latest/code_management/control_repo.html) for use with my [archlinux_workstation](https://forge.puppet.com/jantman/archlinux_workstation) and optionally [archlinux_macbookretina](https://forge.puppet.com/jantman/archlinux_macbookretina) Puppet modules. This specific repository includes some personal configuration of mine, and is intended to be forked and modified as described below. This is intended to be a generic framework for anyone who wants to use Puppet to manage their workstation's configuration. The project provides some sane (though opinionated) defaults, and instructions for how to change them. The defaults are geared towards Arch Linux, but the core in this repository can be used for any distribution, or just as an example/starting point.
+This is an example of a puppet / [r10k](https://github.com/puppetlabs/r10k) masterless repository for use with my [archlinux_workstation](https://forge.puppet.com/jantman/archlinux_workstation) and optionally [archlinux_macbookretina](https://forge.puppet.com/jantman/archlinux_macbookretina) Puppet modules. This specific repository includes some personal configuration of mine, and is intended to be forked and modified as described below. This is intended to be a generic framework for anyone who wants to use Puppet to manage their workstation's configuration. The project provides some sane (though opinionated) defaults, and instructions for how to change them. The defaults are geared towards Arch Linux, but the core in this repository can be used for any distribution, or just as an example/starting point.
 
 In general, what this repository has is:
 
 * a [Puppetfile](#puppetfile) for use with r10k, to install all dependencies.
 * a [site.pp main manifest](#site.pp-manifest), which sets up the top-scope things needed for [puppetlabs-firewall](https://forge.puppetlabs.com/puppetlabs/firewall)) and uses your [hiera data](#hiera) to include the classes you want to use.
-* Some helper scripts under ``bin/`` to aid in installation and use. See [Setup](#setup) and [Usage](#usage).
+* Some helper scripts under ``bin/`` to aid in use. See [Setup](#setup) and [Usage](#usage).
 * Documentation on initial setup of an Arch computer to use with this repo.
 
 ### Warning
@@ -68,9 +73,9 @@ Distro-specific instructions follow.
 Here's how to make this project do what you want:
 
 1. Fork this repository.
-2. Edit ``puppet/Puppetfile`` to contain all of the modules that you need as well as their dependencies. Unlike ``puppet module install``, r10k does not have dependency resolution.
-3. Edit the files under ``puppet/hiera/`` to do what you need. See below for more information.
-4. Edit ``puppet/manifests/site.pp`` as needed, though the default should be acceptable for most people.
+2. Edit ``Puppetfile`` to contain all of the modules that you need as well as their dependencies. Unlike ``puppet module install``, r10k does not have dependency resolution.
+3. Edit the files under ``hiera/`` to do what you need. See below for more information.
+4. Edit ``manifests/site.pp`` as needed, though the default should be acceptable for most people.
 5. Edit the spec tests under ``spec/hosts`` to match your changes in the previous steps.
 6. Commit and push your changes.
 
@@ -104,23 +109,22 @@ Most users will have some sensitive information that they want on their machine
 
 To set up the project on one of your own machines:
 
-1. ``cd /etc/puppetlabs/code``
-2. ``git clone https://github.com/jantman/workstation-bootstrap.git workstation-bootstrap`` (or your fork, if you made one)
-3. ``cd workstation-bootstrap``
-4. ``./bin/setup.sh``
-5. Deploy the modules with r10k and then run Puppet: ``./bin/run_r10k_puppet.sh``. Assuming you're running under Arch Linux and using my [archlinux_workstation](https://github.com/jantman/puppet-archlinux-workstation) module, you'll want to do this either in a screen session or redirect the output to a file; at some point in the run, Xorg and SDDM will start up and your display will turn graphical. You can either login or use ``Ctrl + Alt + F2`` to get to a text console. If puppet dies when the ``sddm`` service starts, just re-run it.
-6. After the initial run, set the password for your newly-created user and then reboot.
-7. Log in as your user.
+1. ``git clone https://github.com/jantman/workstation-bootstrap.git`` (or your fork, if you made one) somewhere convenient; I use ``/root`` for ease.
+2. ``cd workstation-bootstrap``
+3. To deploy the dependencies with r10k and then run Puppet: ``./bin/run_r10k_puppet.sh``. Assuming you're running under Arch Linux and using my [archlinux_workstation](https://github.com/jantman/puppet-archlinux-workstation) module, you'll want to do this either in a screen session or redirect the output to a file; at some point in the run, Xorg and SDDM will start up and your display will turn graphical. You can either login or use ``Ctrl + Alt + F2`` to get to a text console. If puppet dies when the ``sddm`` service starts, just re-run it.
+4. After the initial run, set the password for your newly-created user and then reboot.
+5. Log in as your user.
 
 ## Usage
 
 * To run the r10k deploy, ``./bin/run_r10k.sh``
 * To run puppet on ``site.pp``, ``./bin/run_puppet.sh``
 * To run r10k and then puppet, ``./bin/run_r10k_puppet.sh``
-* To find the value of a given key in the current Hiera data, ``./bin/hiera_show_value.sh KEY_NAME``
 
 ``./bin/run_puppet.sh`` and ``./bin/run_r10k_puppet.sh`` will add any command-line arguments that you specify to the ``puppet`` command before the path to ``site.pp`` (i.e. ``./bin/run_r10k_puppet.sh --noop`` will end run ``puppet`` with ``--noop``).
 
+I generally create symlinks in ``~/bin`` to these scripts for ease.
+
 ## Firewall Rules and Docker
 
 The pre-1.0.0 behavior of this module was to include a global firewall resource purge, to remove all unmanaged iptables rules:
@@ -160,27 +164,18 @@ At this moment, what this code does is:
 
 ### workstation_bootstrap module
 
-This module has two classes, ``workstation_bootstrap::firewall_pre`` and ``workstation_bootstrap::firewall_post``, which
+The base ``workstation_bootstrap`` module can be found in ``modules/local/workstation_bootstrap``. It has two classes, ``workstation_bootstrap::firewall_pre`` and ``workstation_bootstrap::firewall_post``, which
 do setup of default Firewall module rules, including accepting SSH on port 22.
 
 ### Puppetfile
 
-* [archlinux_workstation](https://forge.puppet.com/jantman/archlinux_workstation)
-* [archlinux_macbookretina](https://forge.puppet.com/jantman/archlinux_macbookretina)
-* [puppetlabs/stdlib](https://forge.puppetlabs.com/puppetlabs/stdlib)
-* [saz/sudo](https://forge.puppetlabs.com/saz/sudo) (dependency of archlinux_workstation)
-* [saz/ssh](https://forge.puppetlabs.com/saz/ssh) (dependency of archlinux_workstation)
-* [puppetlabs/firewall](https://forge.puppetlabs.com/puppetlabs/firewall)
-* [puppetlabs/inifile](https://forge.puppetlabs.com/puppetlabs/inifile)
-* [puppetlabs/vcsrepo](https://forge.puppetlabs.com/puppetlabs/vcsrepo)
-* [eirc/single_user_rvm](https://forge.puppetlabs.com/eirc/single_user_rvm)
-* [nanliu/staging](https://forge.puppetlabs.com/nanliu/staging)
+See [Puppetfile](Puppetfile) itself for the current list of included dependencies.
 
 By default, the Puppetfile also includes my personal "privatepuppet" module. You should comment this out or replace it with your own personal module(s).
 
 ### Hiera
 
-The Hiera hierarchy used is as follows:
+The Hiera hierarchy used is rooted at ``hiera/`` and has configurations as follows:
 
 * ``defaults.yaml`` - default configuration and classes
 * ``osfamily/Archlinux.yaml`` - include ``archlinux-workstation`` class on Arch Linux

README.md

@@ -5,12 +5,15 @@ require 'puppet-strings' if Bundler.rubygems.find_name('puppet-strings').any?
 require 'vandamme' if Bundler.rubygems.find_name('vandamme').any?
 require 'octokit' if Bundler.rubygems.find_name('octokit').any?
 require 'json'
+require 'fileutils'
 
 PuppetLint.configuration.fail_on_warnings = true
 PuppetLint.configuration.send('relative')
+PuppetLint.configuration.pattern = 'modules/local/**/*.pp'
 
 desc "NON-PARALLEL version of release_checks"
 task :release_checks_nonparallel do
+  FileUtils.rm_rf('modules/r10k') if Dir.exist?('modules/r10k')
   Rake::Task[:lint].invoke
   Rake::Task[:validate].invoke
   Rake::Task[:spec].invoke

Rakefile

@@ -1,5 +1,12 @@
 #!/bin/bash
 
+CLONEDIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )/.." && pwd )"
 set -x
+cd $CLONEDIR
 
-puppet apply --verbose $@ /etc/puppetlabs/code/environments/production/manifests/site.pp
+sed "s|%%CLONEDIR%%|${CLONEDIR}|g" hiera.yaml.template > hiera.yaml
+
+puppet apply --verbose $@ \
+  --hiera_config=${CLONEDIR}/hiera.yaml \
+  --modulepath="${CLONEDIR}/modules/local:${CLONEDIR}/modules/r10k" \
+  ${CLONEDIR}/manifests/site.pp

bin/hiera_show_value.sh

@@ -1,7 +1,9 @@
 #!/bin/bash
 
+CLONEDIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )/.." && pwd )"
 set -x
-pushd /etc/puppetlabs/code/workstation-bootstrap/puppet/
+cd $CLONEDIR
 git fetch && git pull
-popd
-PUPPETFILE=/etc/puppetlabs/code/workstation-bootstrap/puppet/Puppetfile PUPPETFILE_DIR=/etc/puppetlabs/code/workstation-bootstrap/puppet/modules /usr/bin/r10k puppetfile install $@
+PUPPETFILE=${CLONEDIR}/Puppetfile \
+  PUPPETFILE_DIR=${CLONEDIR}/modules/r10k \
+  /usr/bin/r10k puppetfile install -v $@

bin/run_puppet.sh

@@ -1,4 +1,6 @@
 #!/bin/bash
 
+CLONEDIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )/.." && pwd )"
 set -x
-/etc/puppetlabs/code/workstation-bootstrap/bin/run_r10k.sh && /etc/puppetlabs/code/workstation-bootstrap/bin/run_puppet.sh $@
+cd $CLONEDIR
+./bin/run_r10k.sh && ./bin/run_puppet.sh $@

bin/run_r10k.sh

@@ -11,4 +11,4 @@ hierarchy:
     path: "user_config.yaml"
 defaults:
   data_hash: yaml_data
-  datadir: /etc/puppetlabs/code/workstation-bootstrap/puppet/hiera
+  datadir: %%CLONEDIR%%/hiera

bin/run_r10k_puppet.sh

@@ -1,9 +1,9 @@
 {
   "name": "jantman-workstation_bootstrap",
-  "version": "2.0.0",
-  "summary": "sample control repository and main module, geared towards Arch Linux",
+  "version": "3.0.0",
+  "summary": "sample main repository and module, geared towards Arch Linux",
   "author": "jantman",
-  "description": "This is an example of a puppet/r10k control repository for use with my archlinux_workstation and optionally archlinux_macbookretina Puppet modules. This specific repository includes some personal configuration of mine, and is intended to be forked and modified as described below. This is intended to be a generic framework for anyone who wants to use Puppet to manage their workstation's configuration. The project provides some sane (though opinionated) defaults, and instructions for how to change them. The defaults are geared towards Arch Linux, but the core in this repository can be used for any distribution, or just as an example/starting point.",
+  "description": "This is an example of a puppet/r10k main repository for use with my archlinux_workstation and optionally archlinux_macbookretina Puppet modules. This specific repository includes some personal configuration of mine, and is intended to be forked and modified. This is intended to be a generic framework for anyone who wants to use Puppet to manage their workstation's configuration. The project provides some sane (though opinionated) defaults, and instructions for how to change them. The defaults are geared towards Arch Linux, but the core in this repository can be used for any distribution, or just as an example/starting point.",
   "dependencies": [
   ],
   "operatingsystem_support": [

bin/setup.sh

@@ -3,11 +3,11 @@
 proj_root = File.expand_path(File.join(File.dirname(__FILE__), '..'))
 
 RSpec.configure do |c|
-  hieraconf = File.read(File.join(proj_root, 'puppet', 'config', 'hiera.yaml'))
-  hieraconf.sub!('/etc/puppetlabs/code/workstation-bootstrap/puppet/hiera', File.join(proj_root, 'puppet', 'hiera'))
+  hieraconf = File.read(File.join(proj_root, 'hiera.yaml.template'))
+  hieraconf.sub!('%%CLONEDIR%%', proj_root)
   File.open(File.join(proj_root, 'spec', 'fixtures', 'hiera.yaml'), 'w') { |f| f.write(hieraconf) }
   c.hiera_config = File.join(proj_root, 'spec', 'fixtures', 'hiera.yaml')
-  c.manifest = File.join(proj_root, 'puppet', 'manifests', 'site.pp')
+  c.manifest = File.join(proj_root, 'manifests', 'site.pp')
 end
 
 def facts_for_host(ostype, product = 'Unknown')