openvox 7.37.1 → 8.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 01fbc2fdf8ac3b55d5dc55277bdae9ea52b40ddf0408e1f28567b26898298bb3
-  data.tar.gz: 0d520c4674e67f33821cf4ed8776bf98c6582e1b415d1959e08e3df45e1686d2
+  metadata.gz: d93165eba5931e56f1e9ad74aca8b0cf091a42b55fb2636b1162233b5e728ef1
+  data.tar.gz: 9022fc3d15af6d41d10488728ef753385804c3c156316eecbc4603bd168c3690
 SHA512:
-  metadata.gz: bd24070977f71d1d9983a9f8cd087c468ffd8d87d10b0a4592461080fab60c9ea3ce1e5c428852c1364ccb9882c768c763ae19a02763e8ffbf8e873fe6273fcb
-  data.tar.gz: 2bbfdf42ec1c3490c0869125a104bc9ba3a1d9cc81c30466bdf85eb3b95876e55de5bb00c0eb490a3604960f275afbee4cd6ecb88f172a6bc1b08615d1510e42
+  metadata.gz: abeaa866c11089656ddaa88a2ac3ede01438bd2df46c8ed5ef69e3eb9345e99464eb968458485d77addc26ae8b88d5966dad9b65098db9ac455d547c00ffafe3
+  data.tar.gz: cb86cb05e131cda9607ad018594603af8ceedc096c1bf64769099681eeded7068b0b07fd7d92a30f76fd3bd670ae80295b2ae743e8c5e22aec1bc3ed18e3ed61

data/CHANGELOG.md

@@ -2,13 +2,17 @@
 
 All notable changes to this project will be documented in this file.
 
-## [7.37.0](https://github.com/openvoxproject/puppet/tree/7.37.0) (2025-06-03)
+## [8.19.0](https://github.com/openvoxproject/puppet/tree/8.19.0) (2025-05-30)
 
-[Full Changelog](https://github.com/openvoxproject/puppet/compare/7.36.1...7.37.0)
+[Full Changelog](https://github.com/openvoxproject/puppet/compare/8.18.1...8.19.0)
 
 **Implemented enhancements:**
 
-- Add `implementation` fact to agent and server [\#87](https://github.com/OpenVoxProject/puppet/pull/87) ([bastelfreak](https://github.com/bastelfreak))
+- Add `implementation` fact to agent and server. [\#63](https://github.com/OpenVoxProject/puppet/pull/63) ([ffrank](https://github.com/ffrank))
+
+**Fixed bugs:**
+
+- Replace `erase` with `remove`, since it's no longer supported with DNF5 [\#68](https://github.com/OpenVoxProject/puppet/pull/68) ([Stricken1670](https://github.com/Stricken1670))
 
 
 

data/Gemfile

@@ -14,16 +14,15 @@ end
 
 # Make sure these gem requirements are in sync with the gempspec. Specifically,
 # the runtime_dependencies in puppet.gemspec match the runtime dependencies here
-# (like semantic_puppet and puppet-resource_api)
+# (like facter, semantic_puppet, and puppet-resource_api)
 
-# override .gemspec deps for facter & hiera - may issue warning depending on Bundler version
-gem "facter", *location_for(ENV['FACTER_LOCATION']) if ENV.has_key?('FACTER_LOCATION')
-gem "hiera", *location_for(ENV['HIERA_LOCATION']) if ENV.has_key?('HIERA_LOCATION')
+gem "facter", *location_for(ENV['FACTER_LOCATION'] || ["~> 4.3"])
 gem "semantic_puppet", *location_for(ENV['SEMANTIC_PUPPET_LOCATION'] || ["~> 1.0"])
 gem "puppet-resource_api", *location_for(ENV['RESOURCE_API_LOCATION'] || ["~> 1.5"])
 
 group(:features) do
   gem 'diff-lcs', '~> 1.3', require: false
+  gem "hiera", *location_for(ENV['HIERA_LOCATION']) if ENV.has_key?('HIERA_LOCATION')
   gem 'hiera-eyaml', *location_for(ENV['HIERA_EYAML_LOCATION'])
   gem 'hocon', '~> 1.0', require: false
   # requires native libshadow headers/libs
@@ -36,30 +35,34 @@ group(:features) do
   # requires native ldap headers/libs
   # gem 'ruby-ldap', '~> 0.9', require: false, platforms: [:ruby]
   gem 'puppetserver-ca', '~> 2.0', require: false
-  gem 'CFPropertyList', '~> 2.2', require: false
+  gem 'syslog', '>= 0.1.1', '< 1', require: false, platforms: [:ruby]
+  gem 'CFPropertyList', ['>= 3.0.6', '< 4'], require: false
 end
 
 group(:test) do
   # 1.16.0 - 1.16.2 are broken on Windows
   gem 'ffi', '>= 1.15.5', '< 1.17.0', '!= 1.16.0', '!= 1.16.1', '!= 1.16.2', require: false
-  gem "json-schema", "~> 2.0", require: false
+  gem "json-schema", '>= 2', '< 6', require: false
+  gem "racc", "1.5.2", require: false
   gem "rake", *location_for(ENV['RAKE_LOCATION'] || '~> 13.0')
   gem "rspec", "~> 3.1", require: false
   gem "rspec-expectations", ["~> 3.9", "!= 3.9.3"]
   gem "rspec-its", "~> 1.1", require: false
-  gem 'vcr', '~> 5.0', require: false
+  gem 'vcr', '~> 6.1', require: false
   gem 'webmock', '~> 3.0', require: false
-  gem 'webrick', '~> 1.7', require: false if RUBY_VERSION.to_f >= 3.0
+  gem 'webrick', '~> 1.7', require: false
   gem 'yard', require: false
 
-  gem 'rubocop', '1.28.0', require: false, platforms: [:ruby]
+  gem 'rubocop', '~> 1.0', require: false, platforms: [:ruby]
   gem 'rubocop-i18n', '~> 3.0', require: false, platforms: [:ruby]
+  gem 'rubocop-performance', '~> 1.0', require: false, platforms: [:ruby]
+  gem 'rubocop-rake', '~> 0.6', require: false, platforms: [:ruby]
+  gem 'rubocop-rspec', '~> 3.0', require: false, platforms: [:ruby]
 end
 
 group(:development, optional: true) do
   gem 'memory_profiler', require: false, platforms: [:mri]
   gem 'pry', require: false, platforms: [:ruby]
-  gem "racc", "1.5.2", require: false, platforms: [:ruby]
   if RUBY_PLATFORM != 'java'
     gem 'ruby-prof', '>= 0.16.0', require: false
   end
@@ -71,8 +74,10 @@ group(:packaging) do
 end
 
 group(:documentation, optional: true) do
-  gem 'gettext-setup', '~> 0.28', require: false, platforms: [:ruby]
-  gem 'ronn', '~> 0.7.3', require: false, platforms: [:ruby]
+  gem 'gettext-setup', '~> 1.0', require: false, platforms: [:ruby]
+  gem 'ronn-ng', '~> 0.10.1', require: false, platforms: [:ruby]
+  gem 'puppet-strings', require: false, platforms: [:ruby]
+  gem 'pandoc-ruby', require: false, platforms: [:ruby]
 end
 
 if File.exist? "#{__FILE__}.local"

data/README.md

@@ -1,17 +1,15 @@
-# Puppet
+# OpenVox
 
-![RSpec tests](https://github.com/puppetlabs/puppet/workflows/RSpec%20tests/badge.svg)
-[![Gem Version](https://badge.fury.io/rb/puppet.svg)](https://badge.fury.io/rb/puppet)
-[![Inline docs](https://inch-ci.org/github/puppetlabs/puppet.svg)](https://inch-ci.org/github/puppetlabs/puppet)
-
-Puppet, an automated administrative engine for your Linux, Unix, and Windows systems, performs
+OpenVox is a community implementation of Puppet, an automated administrative engine for your Linux, Unix, and Windows systems, designed to perform
 administrative tasks (such as adding users, installing packages, and updating server
 configurations) based on a centralized specification.
 
 ## Documentation
 
-Documentation for Puppet and related projects can be found online at the
-[Puppet Docs site](https://puppet.com/docs).
+As of now, OpenVox is effectively the same as the original Puppet™️ packages, aside from some minor build pipeline changes and package renaming.
+This means that aside from the installation, all Puppet™️ docs and tutorials will still be completely applicable.
+As the OpenVox project matures, we will create more documentation, guides, and tutorials.
+For the time being though, now you’ll want to hop over to [Puppet’s own documentation](https://puppet.com/docs) and go from there.
 
 ### HTTP API
 
@@ -19,36 +17,37 @@ Documentation for Puppet and related projects can be found online at the
 
 ## Installation
 
-The best way to run Puppet is with [Puppet Enterprise (PE)](https://puppet.com/products/puppet-enterprise/),
-which also includes orchestration features, a web console, and professional support.
-The PE documentation is [available here.](https://puppet.com/docs/pe/latest)
-
-To install an open source release of Puppet,
-[see the installation guide on the docs site.](https://puppet.com/docs/puppet/latest/installing_and_upgrading.html)
+To install OpenVox,
+[see our installation guide.](https://voxpupuli.org/openvox/install/) and [quickstart page](https://voxpupuli.org/openvox/quickstart/).
 
-If you need to run Puppet from source as a tester or developer,
+If you need to run OpenVox from source as a tester or developer,
 see the [Quick Start to Developing on Puppet](docs/quickstart.md) guide.
 
 ## Developing and Contributing
 
 We'd love to get contributions from you! For a quick guide to getting your
 system setup for developing, take a look at our [Quickstart
-Guide](https://github.com/puppetlabs/puppet/blob/main/docs/quickstart.md). Once you are up and running, take a look at the
-[Contribution Documents](https://github.com/puppetlabs/puppet/blob/main/CONTRIBUTING.md) to see how to get your changes merged
+Guide](docs/quickstart.md). Once you are up and running, take a look at the
+[Contribution Documents](https://github.com/OpenVoxProject/.github/blob/main/CONTRIBUTING.md) to see how to get your changes merged
 in.
 
 For more complete docs on developing with Puppet, take a look at the
-rest of the [developer documents](https://github.com/puppetlabs/puppet/blob/main/docs/index.md).
+rest of the [developer documents](docs/index.md).
 
 ## Licensing
 
-See [LICENSE](https://github.com/puppetlabs/puppet/blob/main/LICENSE) file. Puppet is licensed by Puppet, Inc. under the Apache license. Puppet, Inc. can be contacted at: info@puppet.com
+See [LICENSE](LICENSE) file. OpenVox is licensed by Vox Pupuli as a community maintained
+implementation of Puppet. Vox Pupuli can be contacted at: voxpupuli@groups.io.
+Puppet itself is licensed by Puppet, Inc. under the Apache license. Puppet, Inc. can be contacted at: info@puppet.com
 
 ## Support
 
-Please log tickets and issues at our [JIRA tracker](https://tickets.puppetlabs.com). A [mailing
-list](https://groups.google.com/forum/?fromgroups#!forum/puppet-users) is
-available for asking questions and getting help from others, or if you prefer chat, we also have a [Puppet Community slack.](https://puppetcommunity.slack.com/)
+Please log issues in this project's [GitHub Issues](https://github.com/OpenVoxProject/puppet/issues).
+Other channels for getting help can be found at our
+[support page](https://voxpupuli.org/openvox/support/),
+including the mailing list and other community spaces available
+for asking questions and getting help from others.
+
 
 We use semantic version numbers for our releases and recommend that users stay
 as up-to-date as possible by upgrading to patch releases and minor releases as
@@ -58,11 +57,7 @@ Bug fixes and ongoing development will occur in minor releases for the current
 major version. Security fixes will be backported to a previous major version on
 a best-effort basis, until the previous major version is no longer maintained.
 
-For example: If a security vulnerability is discovered in Puppet 6.1.1, we
-would fix it in the 6 series, most likely as 6.1.2. Maintainers would then make
-a best effort to backport that fix onto the latest Puppet 5 release.
-
-Long-term support, including security patches and bug fixes, is available for
-commercial customers. Please see the following page for more details:
-
-[Puppet Enterprise Support Lifecycle](https://puppet.com/docs/puppet-enterprise/product-support-lifecycle/)
+For example: If a security vulnerability is discovered in Puppet 8.1.1, we
+would fix it in the 8 series, most likely as 8.1.2. Maintainers would then make
+a best effort to backport that fix onto earlier releases that haven't reached
+their respective end-of-life dates.

data/Rakefile

@@ -1,27 +1,38 @@
-# Rakefile for Puppet -*- ruby -*-
-RAKE_ROOT = File.dirname(__FILE__)
+# frozen_string_literal: true
 
-# We need access to the Puppet.version method
-$LOAD_PATH.unshift(File.expand_path("lib"))
-require 'puppet/version'
-
-$LOAD_PATH << File.join(RAKE_ROOT, 'tasks')
-
-begin
-  require 'rubygems'
-  require 'rubygems/package_task'
-rescue LoadError
-  # Users of older versions of Rake (0.8.7 for example) will not necessarily
-  # have rubygems installed, or the newer rubygems package_task for that
-  # matter.
-  require 'rake/packagetask'
-  require 'rake/gempackagetask'
+require 'open3'
+require 'rake'
+require 'rubygems'
+require 'rubygems/package_task'
+
+RED = "\033[31m"
+GREEN = "\033[32m"
+RESET = "\033[0m"
+
+def run_command(cmd, silent: true, print_command: false, report_status: false)
+  puts "#{GREEN}Running #{cmd}#{RESET}" if print_command
+  output = ''
+  Open3.popen2e(cmd) do |_stdin, stdout_stderr, thread|
+    stdout_stderr.each do |line|
+      puts line unless silent
+      output += line
+    end
+    exitcode = thread.value.exitstatus
+    unless exitcode.zero?
+      err = "#{RED}Command failed! Command: #{cmd}, Exit code: #{exitcode}"
+      # Print details if we were running silent
+      err += "\nOutput:\n#{output}" if silent
+      err += RESET
+      abort err
+    end
+    puts "#{GREEN}Command finished with status #{exitcode}#{RESET}" if report_status
+  end
+  output.chomp
 end
 
-require 'rake'
-require 'open3'
+Dir.glob(File.join('tasks/**/*.rake')).each { |file| load file }
 
-Dir['tasks/**/*.rake'].each { |t| load t }
+### Puppetlabs stuff ###
 
 if Rake.application.top_level_tasks.grep(/^(pl:|package:)/).any?
   begin
@@ -88,15 +99,19 @@ end
 
 task :spec do
   ENV["LOG_SPEC_ORDER"] = "true"
-  sh %{rspec #{ENV['TEST'] || ENV['TESTS'] || 'spec'}}
+  sh %{rspec #{ENV['TEST'] || ENV['TESTS'] || ENV['SPEC'] || 'spec'}}
 end
 
-desc 'run static analysis with rubocop'
-task(:rubocop) do
-  require 'rubocop'
-  cli = RuboCop::CLI.new
-  exit_code = cli.run(%w(--display-cop-names --format simple))
-  raise "RuboCop detected offenses" if exit_code != 0
+begin
+  require 'rubocop/rake_task'
+  RuboCop::RakeTask.new(:rubocop) do |task|
+    # These make the rubocop experience maybe slightly less terrible
+    task.options = ['--display-cop-names', '--display-style-guide', '--extra-details']
+    # Use Rubocop's Github Actions formatter if possible
+    task.formatters << 'github' if ENV['GITHUB_ACTIONS'] == 'true'
+  end
+rescue LoadError
+  # the gem is only used on MRI Ruby
 end
 
 desc "verify that changed files are clean of Ruby warnings"
@@ -145,13 +160,8 @@ begin
     config.user = "openvoxproject"
     config.project = "puppet"
     config.exclude_labels = %w[dependencies duplicate question invalid wontfix wont-fix modulesync skip-changelog]
-    config.since_tag = "7.36.1"
+    config.since_tag = "8.18.1"
     config.future_release = Puppet::PUPPETVERSION
-    # FIXME: The following should be enough to ignore versions in the main
-    # branch only, but this does not work.  For now we rely on a regexp to
-    # exclude tags that should not be matched.
-    config.release_branch = "7.x"
-    config.exclude_tags_regex = /\A8\./
   end
 rescue LoadError
   task :changelog do

data/bin/puppet

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 begin
   require 'puppet/util/command_line'

data/examples/hiera/README.md

@@ -1,91 +1,102 @@
-A working demo of Hiera with YAML and Puppet backends.
+A working demo of Hiera with YAML backend.
 ======================================================
 
 This demo consists of:
 
- * A NTP module that has defaults for pool.ntp.org servers
- * A common data module where module users can create override data in pp files
- * A YAML data source in etc/hieradb where users can override data in yaml files
- * A couple of users modules that just notify the fact that they are being included
- * In Hiera data files a key called _classes_ that decides what to include on a node
+- A **NTP** module that has defaults for *pool.ntp.org* servers
+- A **YAML** data source in the *data/* directory where users can override data in yaml files
+- A **Users** module that has a few manifests that simply notify that they are being included
+- In Hiera data files a key called **classes** that decides what to include on a node
 
 Below various usage scenarios can be tested using this module.
 
-The examples below assume you have Hiera already installed and that you have
-hiera-puppet cloned from github and running these commands in _hiera-puppet/example_ as cwd.
+The examples below assume you:
+- Have the puppet-agent already installed
+- You have this repository cloned from github
+- Are running these commands from within the *examples/hiera* directory as cwd.
 
 Module from forge with module defaults
 --------------------------------------
 
- * Move the _modules/data_ directory to _modules/data.bak_ to avoid overrides
-   used further in the example
- * Run puppet, creates _/etc/ntp.conf_ with ntp.org addresses
- * The _hiera\_include()_ function includes just _users::common_
-
-<pre>
-$ mv modules/data modules/data.bak
-$ puppet apply --config etc/puppet.conf site.pp
-notice: /Stage[main]/Ntp::Config/File[/tmp/ntp.conf]/ensure: defined content as '{md5}7045121976147a932a66c7671939a9ad'
-notice: /Stage[main]/Users::Common/Notify[Adding users::common]/message: defined 'message' as 'Adding users::common'
+- Comment out lines 6-8 of [data/common.yaml](data/common.yaml#L6-8) to avoid overrides used further in the example
+- Run a `puppet apply` to create a */tmp/ntp.conf* file containing the two *pool.ntp.org* addresses
+- The *users::common* class should also be present in your catalog
+
+```shell
+$ sed -i '6,8 s/^/#/' data/common.yaml
+$ puppet apply site.pp --hiera_config=hiera.yaml --modulepath=modules
+Notice: Compiled catalog for node.corp.com in environment production in 0.04 seconds
+Notice: Adding users::common
+Notice: /Stage[main]/Users::Common/Notify[Adding users::common]/message: defined 'message' as 'Adding users::common'
+Notice: /Stage[main]/Ntp::Config/File[/tmp/ntp.conf]/ensure: defined content as '{sha256}949c7247dbe0870258c921418cc8b270afcc57e1aa6f9d9933f306009ede60d0'
+Notice: Applied catalog in 0.02 seconds
 $ cat /tmp/ntp.conf
 server 1.pool.ntp.org
 server 2.pool.ntp.org
-</pre>
+```
 
 Site wide override data in _data::common_
 -----------------------------------------
 
- * Restore the _modules/data_ directory that has a class _data::common_ that declares site wide overrides
- * The _hiera_include()_ function includes just _users::common_
-
-<pre>
-$ mv modules/data.bak modules/data
-$ puppet apply --config etc/puppet.conf site.pp
-notice: /Stage[main]/Ntp::Config/File[/tmp/ntp.conf]/content: content changed '{md5}7045121976147a932a66c7671939a9addc2' to '{md5}8f9039fe1989a278a0a8e1836acb8d23'
-notice: /Stage[main]/Users::Common/Notify[Adding users::common]/message: defined 'message' as 'Adding users::common'
+- Remove the comments on lines 6-8 of [data/common.yaml](data/common.yaml#L6-8)
+- Run a `puppet apply` to update */tmp/ntp.conf* to contain the two *ntp.example.com* addresses
+- The *users::common* class should also be present in your catalog
+
+```shell
+$ sed -i '6,8 s/^#//' data/common.yaml
+$ puppet apply site.pp --hiera_config=hiera.yaml --modulepath=modules
+Notice: Compiled catalog for node.corp.com in environment production in 0.04 seconds
+Notice: Adding users::common
+Notice: /Stage[main]/Users::Common/Notify[Adding users::common]/message: defined 'message' as 'Adding users::common'
+Notice: /Stage[main]/Ntp::Config/File[/tmp/ntp.conf]/content: content changed '{sha256}949c7247dbe0870258c921418cc8b270afcc57e1aa6f9d9933f306009ede60d0' to '{sha256}28ced955a8ed9efd7514b2364fe378ba645ab947f26e8c0b4d84e8368f1257a0'
+Notice: Applied catalog in 0.02 seconds
 $ cat /tmp/ntp.conf
 server ntp1.example.com
 server ntp2.example.com
-</pre>
+```
 
 Fact driven overrides for location=dc1
 --------------------------------------
 
- * Set a fact location=dc1 that uses the YAML data in _etc/hieradb/dc1.yaml_ to override
- * Show that machines in dc2 would use site-wide defaults
- * The _hiera_include()_ function includes _users::common_ and _users::dc1_ as the data file for dc1 adds that
-
-<pre>
-$ FACTER_location=dc1 puppet apply --config etc/puppet.conf site.pp
-notice: /Stage[main]/Ntp::Config/File[/tmp/ntp.conf]/content: content changed '{md5}8f9039fe1989a278a0a8e1836acb8d23' to '{md5}074d0e2ac727f6cb9afe3345d574b578'
-notice: /Stage[main]/Users::Common/Notify[Adding users::common]/message: defined 'message' as 'Adding users::common'
-notice: /Stage[main]/Users::Dc1/Notify[Adding users::dc1]/message: defined 'message' as 'Adding users::dc1'
+- Override the location fact to `dc1` to demonstrate *data/dc1.yaml* overrides the *ntp::config::ntpservers* values in *data/common.yaml*
+- `dc1` nodes will
+  - have the *users::common* and *users::dc1* in their catalogs
+  - */tmp/ntp.conf* will contain the two *ntp.dc1.example.com* addresses
+- Show that the nodes in `dc2` would use the site-wide defaults
+
+```shell
+$ FACTER_location=dc1 puppet apply site.pp --hiera_config=hiera.yaml --modulepath=modules
+Notice: Compiled catalog for node.corp.com in environment production in 0.04 seconds
+Notice: Adding users::dc1
+Notice: /Stage[main]/Users::Dc1/Notify[Adding users::dc1]/message: defined 'message' as 'Adding users::dc1'
+Notice: Adding users::common
+Notice: /Stage[main]/Users::Common/Notify[Adding users::common]/message: defined 'message' as 'Adding users::common'
+Notice: /Stage[main]/Ntp::Config/File[/tmp/ntp.conf]/content: content changed '{sha256}28ced955a8ed9efd7514b2364fe378ba645ab947f26e8c0b4d84e8368f1257a0' to '{sha256}39227f1cf8d09623d2e66b6622af2e8db01ab26f77a5a2e6d6e058d0977f369b'
+Notice: Applied catalog in 0.02 seconds
 $ cat /tmp/ntp.conf
 server ntp1.dc1.example.com
 server ntp2.dc1.example.com
-</pre>
-
-Now simulate a machine in _dc2_, because there is no data for dc2 it uses the site wide defaults and
-does not include the _users::dc1_ class anymore
-
-<pre>
-$ FACTER_location=dc2 puppet apply --config etc/puppet.conf site.pp
-warning: Could not find class data::dc2 for nephilim.ml.org
-notice: /Stage[main]/Ntp::Config/File[/tmp/ntp.conf]/content: content changed '{md5}074d0e2ac727f6cb9afe3345d574b578' to '{md5}8f9039fe1989a278a0a8e1836acb8d23'
-notice: /Stage[main]/Users::Common/Notify[Adding users::common]/message: defined 'message' as 'Adding users::common'
+```
+
+Now simulate a machine in `dc2`, because there is no data for `dc2` it uses the site wide defaults and
+does not include the *users::dc1* class anymore
+
+```shell
+$ FACTER_location=dc2 puppet apply site.pp --hiera_config=hiera.yaml --modulepath=modules
+Notice: Compiled catalog for node.corp.com in environment production in 0.04 seconds
+Notice: Adding users::common
+Notice: /Stage[main]/Users::Common/Notify[Adding users::common]/message: defined 'message' as 'Adding users::common'
+Notice: /Stage[main]/Ntp::Config/File[/tmp/ntp.conf]/content: content changed '{sha256}39227f1cf8d09623d2e66b6622af2e8db01ab26f77a5a2e6d6e058d0977f369b' to '{sha256}28ced955a8ed9efd7514b2364fe378ba645ab947f26e8c0b4d84e8368f1257a0'
+Notice: Applied catalog in 0.02 seconds
 $ cat /tmp/ntp.conf
 server ntp1.example.com
 server ntp2.example.com
-</pre>
+```
 
-You could create override data in the following places for a machine in _location=dc2_, they will be searched in this order and the first one with data will match.
+You could create override data in the following places for a machine in *location=dc2*, they will be searched in this order and the first one with data will match.
 
- * file etc/hieradb/dc2.yaml
- * file etc/hieradb/common.yaml
- * class data::dc2
- * class data::production
- * class data::common
- * class ntp::config::data
- * class ntp::data
+- file data/dc2.yaml
+- file data/&lt;environment&gt;.yaml
+- file data/common.yaml
 
-In this example due to the presence of _common.yaml_ that declares _ntpservers_ the classes will never be searched, it will have precedence.
+In this example due to the presence of *common.yaml* that declares *ntpservers* the classes will never be searched, it will have precedence.

data/examples/hiera/data/common.yaml

@@ -0,0 +1,12 @@
+---
+classes:
+  - users::common
+  - ntp::config
+
+ntp::config::ntpservers:
+  - 'ntp1.example.com'
+  - 'ntp2.example.com'
+
+lookup_options:
+  classes:
+    merge: unique

data/examples/hiera/data/dc1.yaml

@@ -0,0 +1,6 @@
+---
+ntp::config::ntpservers:
+  - 'ntp1.dc1.example.com'
+  - 'ntp2.dc1.example.com'
+classes:
+  - users::dc1

data/examples/hiera/hiera.yaml

@@ -0,0 +1,15 @@
+---
+version: 5
+defaults:
+  datadir: data
+  data_hash: yaml_data
+
+hierarchy:
+  - name: 'Per Location'
+    path: "%{facts.location}.yaml"
+
+  - name: 'Per Environment'
+    path: "%{facts.environment}.yaml"
+
+  - name: 'Common Data'
+    path: 'common.yaml'

data/examples/hiera/modules/ntp/data/common.yaml

@@ -0,0 +1,4 @@
+---
+ntp::config::ntpservers:
+  - '1.pool.ntp.org'
+  - '2.pool.ntp.org'

data/examples/hiera/modules/ntp/hiera.yaml

@@ -0,0 +1,9 @@
+---
+version: 5
+defaults:
+  datadir: data
+  data_hash: yaml_data
+
+hierarchy:
+  - name: 'Common Data'
+    path: 'common.yaml'

data/examples/hiera/modules/ntp/manifests/config.pp

@@ -1,6 +1,18 @@
-# lookup ntpservers from hiera, or allow user of class to provide other value
-class ntp::config($ntpservers = hiera('ntpservers')) {
-  file{'/tmp/ntp.conf':
-    content => template('ntp/ntp.conf.erb')
+# @summary Manage /tmp/ntp.conf file
+#
+# Given an array of ntpservers, manage the /tmp/ntp.conf file
+#
+# @example
+#   include ntp::config
+#
+# @param ntpservers
+#   An array of ntpserver(s) that should be present in the conf file
+class ntp::config(
+  Array[String[1], 1] $ntpservers = undef,
+) {
+
+  file { '/tmp/ntp.conf':
+    content => epp('ntp/ntp.conf.epp')
   }
+
 }

data/examples/hiera/modules/ntp/templates/ntp.conf.epp

@@ -0,0 +1,3 @@
+<% $ntp::config::ntpservers.each |$server| { -%>
+server <%= $server %>
+<% } -%>

data/examples/hiera/modules/users/manifests/common.pp

@@ -1,4 +1,9 @@
-# notifies
+# @summary Notify to demonstrate users::common in catalog
+#
+# A common Class that all examples should include
+#
+# @example
+#   include users::common
 class users::common {
-  notify{'Adding users::common': }
+  notify { 'Adding users::common': }
 }

data/examples/hiera/modules/users/manifests/dc1.pp

@@ -1,4 +1,9 @@
-# notifies
+# @summary Notify to demonstrate users::dc1 in catalog
+#
+# A Class that should be present in dc1 node(s) catalog
+#
+# @example
+#   include users::dc1
 class users::dc1 {
-  notify{'Adding users::dc1': }
+  notify { 'Adding users::dc1': }
 }

data/examples/hiera/site.pp

@@ -1,3 +1,3 @@
 node default {
-  hiera_include('classes')
+  include lookup('classes')
 }

data/ext/build_defaults.yaml

@@ -15,4 +15,4 @@ apt_signing_server: 'apt.puppetlabs.com'
 apt_repo_url: 'http://apt.puppetlabs.com'
 apt_repo_path: '/opt/repository/incoming'
 tar_host: 'downloads.puppetlabs.com'
-nonfinal_gem_path: '/opt/repository-nightlies/downloads/gems/puppet7-nightly'
+nonfinal_gem_path: '/opt/repository-nightlies/downloads/gems/puppet8-nightly'