README.md in puppet-retrospec-1.5.0 vs README.md in puppet-retrospec-1.6.0

- old
+ new

@@ -10,10 +10,12 @@ The project was named retrospec because there are many times when you need to retrofit your module with various things. If you like this project, star it and tell people! +See the [Website](https://www.puppet-retrospec.com) + Table of Contents ================= * [Build Status](#build-status) * [News](#news) @@ -61,15 +63,15 @@ ### 5/10/17 Adds ability to create module data. With the release of puppet 4.9 we can now use module data. Use the module_data generater to auto setup module data in your puppet module. `retrospec puppet module_data` ### 4/20/17 -With all the changes in hiera recently and the ability to provide data in puppet modules. I thought it would be a good +With all the changes in hiera recently and the ability to provide data in puppet modules. I thought it would be a good time to create a generator for retrospec to create hiera backends and data in module scaffolding. With the 1.6.0 release you are now a simple step away to retrofitting data into your module. -Just run `retrospec puppet module_data` to auto create the scaffolding. +Just run `retrospec puppet module_data` to auto create the scaffolding. Note: You must be using puppet 4.7+ (PE 2016.4.x) to actually use data in a module, but there is nothing stopping you from creating the scaffolding. Note: If you are using puppet 4.7-4.8 you will need to add `data_provider: "hiera"` in your module's metadata.json file. @@ -114,11 +116,11 @@ -m, --module-path=<s> The path (relative or absolute) to the module directory (default: /Users/cosman/github/puppet-retrospec) -c, --config-map=<s> The global retrospec config file (default: /Users/cosman/.retrospec/config.yaml) -a, --available-plugins Show an online list of available plugins -v, --version Print version and exit -h, --help Show this message - + ``` ### Module Path By default the module path is dynamically set based on the current directory. If you need to point to a directory outside the current directory you can use the `--module_path` option. This option is built into the retrospec framework so be sure to use `retrospec -m path_to_module`. @@ -342,28 +344,10 @@ #:default_ssl_chain => undef, #:default_ssl_ca => undef, #:default_ssl_crl_path => undef, #:default_ssl_crl => undef, #:service_enable => true, - #:purge_configs => true, - #:purge_vdir => false, - #:serveradmin => "root@localhost", - #:sendfile => false, - #:error_documents => false, - #:httpd_dir => $apache::params::httpd_dir, - #:confd_dir => $apache::params::confd_dir, - #:vhost_dir => $apache::params::vhost_dir, - #:vhost_enable_dir => $apache::params::vhost_enable_dir, - #:mod_dir => $apache::params::mod_dir, - #:mod_enable_dir => $apache::params::mod_enable_dir, - #:mpm_module => $apache::params::mpm_module, - #:conf_template => $apache::params::conf_template, - #:servername => $apache::params::servername, - #:user => $apache::params::user, - #:group => $apache::params::group, - #:keepalive => $apache::params::keepalive, - #:keepalive_timeout => $apache::params::keepalive_timeout, #:logroot => $apache::params::logroot, #:ports_file => $apache::params::ports_file, #:server_tokens => "OS", #:server_signature => "On", } @@ -422,57 +406,10 @@ is_expected.to contain_exec('mkdir $apache::params::mod_dir'). with({"creates"=>"$apache::params::mod_dir", "require"=>"Package[httpd]"}) end it do - is_expected.to contain_file('$apache::params::mod_dir'). - with({"ensure"=>"directory", - "recurse"=>"true", - "purge"=>"true", - "notify"=>"Class[Apache::Service]", - "require"=>"Package[httpd]"}) - end - it do - is_expected.to contain_exec('mkdir $apache::params::mod_enable_dir'). - with({"creates"=>"$apache::params::mod_enable_dir", - "require"=>"Package[httpd]"}) - end - it do - is_expected.to contain_file('$apache::params::mod_enable_dir'). - with({"ensure"=>"directory", - "recurse"=>"true", - "purge"=>"true", - "notify"=>"Class[Apache::Service]", - "require"=>"Package[httpd]"}) - end - it do - is_expected.to contain_exec('mkdir $apache::params::vhost_dir'). - with({"creates"=>"$apache::params::vhost_dir", - "require"=>"Package[httpd]"}) - end - it do - is_expected.to contain_file('$apache::params::vhost_dir'). - with({"ensure"=>"directory", - "recurse"=>"true", - "purge"=>"true", - "notify"=>"Class[Apache::Service]", - "require"=>"Package[httpd]"}) - end - it do - is_expected.to contain_exec('mkdir $vhost_load_dir'). - with({"creates"=>"$vhost_load_dir", - "require"=>"Package[httpd]"}) - end - it do - is_expected.to contain_file('$apache::params::vhost_enable_dir'). - with({"ensure"=>"directory", - "recurse"=>"true", - "purge"=>"true", - "notify"=>"Class[Apache::Service]", - "require"=>"Package[httpd]"}) - end - it do is_expected.to contain_file('$apache::params::conf_dir/$apache::params::conf_file'). with({"ensure"=>"file", "content"=>"template($conf_template)", "notify"=>"Class[Apache::Service]", "require"=>"Package[httpd]"}) @@ -516,10 +453,11 @@ ``` ### Environment variables to set template defaults RETROSPEC_PUPPET_SCM_URL # set this to auto set your scm url to the templates -RETROSPEC_PUPPET_SCM_BRANCH # set this to auto checkout a particular branch (only works upon initial checkout) +RETROSPEC_PUPPET_SCM_REF (from version 1.6.0) # set this to auto checkout a particular branch (only works upon initial checkout) +RETROSPEC_PUPPET_SCM_BRANCH :same as RETROSPEC_PUPPET_SCM_REF. Use this in version before 1.6.0. As of this version, RETROSPEC_PUPPET_SCM_REF takes precedence. After running retrospec, retrospec will clone the templates from the default template url or from whatever you set to the templates path. If you have already created the erb file in the templates location, then retrospec will not overwrite the file as there will be a SCM conflict. You can use multiple template paths if you use them for different projects so just be sure the set the correct template option when running retrospec. `retrospec -t` The default user location for the templates when not using `retrospec -t` variable is ~/.retrospec/repos/retrospec-puppet-templates