Drop EoL Puppet, update supported OSs, fix example

This makes the list of supported Puppet versions match the ones
currently supported by Puppet, Inc. It also tunes the list of supported
operating systems a bit and fixes an example that had bad info.

Fixes #25

Author: genebean

.github/workflows/ci.yml

@@ -12,8 +12,8 @@ jobs:
     strategy:
       matrix:
         puppet_versions:
-          - '5'
           - '6'
+          # - '7' # PDK doesn't support Puppet 7 directly as of 1.18.1
 
     name: Puppet ${{ matrix.puppet_versions }}
     steps:

REFERENCE.md

@@ -23,7 +23,7 @@
 
 ## Classes
 
-### `promtail`
+### <a name="promtail"></a>`promtail`
 
 promtail's main interface. All interactions should be with this class. The promtail
 module is intended to install and configure Grafana's promtail tool for shipping
@@ -37,13 +37,21 @@ logs to Loki.
 include promtail
 ```
 
-##### 
+##### Sample of defining within a profile
 
 ```puppet
 class { 'promtail':
-  config_hash           => $config_hash,
-  password_file_path    => '/etc/promtail/.gc_pw',
-  password_file_content => Sensitive('myPassword'),
+  clients_config_hash   => $clients_config_hash,
+  positions_config_hash => $positions_config_hash,
+  scrape_configs_hash   => $_real_scrape_configs_hash,
+  password_file_content => $sensitive_password_file_content,
+  password_file_path    => $password_file_path,
+  service_ensure        => $service_ensure,
+  server_config_hash    => $server_config_hash,
+  target_config_hash    => $target_config_hash,
+  bin_dir               => $bin_dir,
+  checksum              => $checksum,
+  version               => $version,
 }
 ```
 
@@ -68,22 +76,22 @@ promtail::positions_config_hash:
     filename: /tmp/positions.yaml
 promtail::scrape_configs_hash:
   scrape_configs:
-    - job_name: system_secure
-      static_configs:
-      - targets:
-          - localhost
-        labels:
-          job: var_log_secure
-          host: "%{facts.networking.fqdn}"
-          __path__: /var/log/secure
-    - job_name: system_messages
-      static_configs:
-      - targets:
-          - localhost
+    - job_name: journal
+      journal:
+        max_age: 12h
         labels:
-          job: var_log_messages
+          job: systemd-journal
           host: "%{facts.networking.fqdn}"
-          __path__: /var/log/messages
+      relabel_configs:
+        - source_labels:
+            - '__journal__systemd_unit'
+          target_label: 'unit'
+        - source_labels:
+            - 'unit'
+          regex: "session-(.*)"
+          action: replace
+          replacement: 'pam-session'
+          target_label: 'unit'
 ```
 
 ##### Merging scrape configs in Hiera
@@ -99,37 +107,51 @@ class profile::logging::promtail {
 
 #### Parameters
 
-The following parameters are available in the `promtail` class.
+The following parameters are available in the `promtail` class:
+
+* [`service_enable`](#service_enable)
+* [`service_ensure`](#service_ensure)
+* [`clients_config_hash`](#clients_config_hash)
+* [`positions_config_hash`](#positions_config_hash)
+* [`scrape_configs_hash`](#scrape_configs_hash)
+* [`bin_dir`](#bin_dir)
+* [`checksum`](#checksum)
+* [`version`](#version)
+* [`server_config_hash`](#server_config_hash)
+* [`target_config_hash`](#target_config_hash)
+* [`password_file_path`](#password_file_path)
+* [`password_file_content`](#password_file_content)
+* [`source_url`](#source_url)
 
-##### `service_enable`
+##### <a name="service_enable"></a>`service_enable`
 
 Data type: `Boolean`
 
 The value passed to the service resource's enable parameter for promtail's service
 
-##### `service_ensure`
+##### <a name="service_ensure"></a>`service_ensure`
 
 Data type: `Enum['running', 'stopped']`
 
 The value passed to the service resource's ensure parameter for promtail's service
 
-##### `clients_config_hash`
+##### <a name="clients_config_hash"></a>`clients_config_hash`
 
 Data type: `Hash`
 
 Describes how Promtail connects to multiple instances of Loki, sending logs to each.
 See https://github.com/grafana/loki/blob/master/docs/clients/promtail/configuration.md
 for all parameters.
 
-##### `positions_config_hash`
+##### <a name="positions_config_hash"></a>`positions_config_hash`
 
 Data type: `Hash`
 
 Describes how to save read file offsets to disk.
 See https://github.com/grafana/loki/blob/master/docs/clients/promtail/configuration.md
 for all parameters.
 
-##### `scrape_configs_hash`
+##### <a name="scrape_configs_hash"></a>`scrape_configs_hash`
 
 Data type: `Hash`
 
@@ -138,28 +160,28 @@ using a specified discovery method.
 See https://github.com/grafana/loki/blob/master/docs/clients/promtail/configuration.md
 for all parameters.
 
-##### `bin_dir`
+##### <a name="bin_dir"></a>`bin_dir`
 
 Data type: `Stdlib::Absolutepath`
 
 The directory in which to create a symlink to the promtail binary
 
-##### `checksum`
+##### <a name="checksum"></a>`checksum`
 
 Data type: `String[1]`
 
 The checksum of the promtail binary.
 Note: each platform has its own checksum.
 Values can be found with each release on GitHub
 
-##### `version`
+##### <a name="version"></a>`version`
 
 Data type: `String[1]`
 
 The version as listed on the GitHub release page
 See https://github.com/grafana/loki/releases for a list
 
-##### `server_config_hash`
+##### <a name="server_config_hash"></a>`server_config_hash`
 
 Data type: `Optional[Hash]`
 
@@ -170,7 +192,7 @@ for all parameters.
 
 Default value: ``undef``
 
-##### `target_config_hash`
+##### <a name="target_config_hash"></a>`target_config_hash`
 
 Data type: `Optional[Hash]`
 
@@ -181,15 +203,15 @@ for all parameters.
 
 Default value: ``undef``
 
-##### `password_file_path`
+##### <a name="password_file_path"></a>`password_file_path`
 
 Data type: `Optional[Stdlib::Absolutepath]`
 
 The fully qualified path to the file containing the password used for basic auth
 
 Default value: ``undef``
 
-##### `password_file_content`
+##### <a name="password_file_content"></a>`password_file_content`
 
 Data type: `Optional[Sensitive[String[1]]]`
 
@@ -198,7 +220,7 @@ lookup_options defined in `data/common.yaml`
 
 Default value: ``undef``
 
-##### `source_url`
+##### <a name="source_url"></a>`source_url`
 
 Data type: `Stdlib::HTTPUrl`
 
@@ -208,7 +230,7 @@ Default value: `'https://github.com/grafana/loki/releases/download'`
 
 ## Functions
 
-### `promtail::strip_yaml_header`
+### <a name="promtailstrip_yaml_header"></a>`promtail::strip_yaml_header`
 
 Type: Ruby 4.x API
 
@@ -250,7 +272,7 @@ Data type: `String`
 
 A string that may start with the ---'s used to denote a YAML file
 
-### `promtail::to_yaml`
+### <a name="promtailto_yaml"></a>`promtail::to_yaml`
 
 Type: Ruby 4.x API
 

manifests/init.pp

@@ -63,11 +63,19 @@
 # @example
 #   include promtail
 #
-# @example
+# @example Sample of defining within a profile
 #   class { 'promtail':
-#     config_hash           => $config_hash,
-#     password_file_path    => '/etc/promtail/.gc_pw',
-#     password_file_content => Sensitive('myPassword'),
+#     clients_config_hash   => $clients_config_hash,
+#     positions_config_hash => $positions_config_hash,
+#     scrape_configs_hash   => $_real_scrape_configs_hash,
+#     password_file_content => $sensitive_password_file_content,
+#     password_file_path    => $password_file_path,
+#     service_ensure        => $service_ensure,
+#     server_config_hash    => $server_config_hash,
+#     target_config_hash    => $target_config_hash,
+#     bin_dir               => $bin_dir,
+#     checksum              => $checksum,
+#     version               => $version,
 #   }
 #
 # @example Settings in a Hiera file
@@ -89,22 +97,22 @@
 #       filename: /tmp/positions.yaml
 #   promtail::scrape_configs_hash:
 #     scrape_configs:
-#       - job_name: system_secure
-#         static_configs:
-#         - targets:
-#             - localhost
-#           labels:
-#             job: var_log_secure
-#             host: "%{facts.networking.fqdn}"
-#             __path__: /var/log/secure
-#       - job_name: system_messages
-#         static_configs:
-#         - targets:
-#             - localhost
+#       - job_name: journal
+#         journal:
+#           max_age: 12h
 #           labels:
-#             job: var_log_messages
+#             job: systemd-journal
 #             host: "%{facts.networking.fqdn}"
-#             __path__: /var/log/messages
+#         relabel_configs:
+#           - source_labels:
+#               - '__journal__systemd_unit'
+#             target_label: 'unit'
+#           - source_labels:
+#               - 'unit'
+#             regex: "session-(.*)"
+#             action: replace
+#             replacement: 'pam-session'
+#             target_label: 'unit'
 #
 # @example Merging scrape configs in Hiera
 #   class profile::logging::promtail {

metadata.json

@@ -29,18 +29,21 @@
     {
       "operatingsystem": "CentOS",
       "operatingsystemrelease": [
-        "7"
+        "7",
+        "8"
       ]
     },
     {
       "operatingsystem": "OracleLinux",
       "operatingsystemrelease": [
-        "7"
+        "7",
+        "8"
       ]
     },
     {
       "operatingsystem": "RedHat",
       "operatingsystemrelease": [
+        "7",
         "8"
       ]
     },
@@ -53,7 +56,8 @@
     {
       "operatingsystem": "Debian",
       "operatingsystemrelease": [
-        "9"
+        "9",
+        "10"
       ]
     },
     {
@@ -66,7 +70,7 @@
   "requirements": [
     {
       "name": "puppet",
-      "version_requirement": ">= 4.10.0 < 7.0.0"
+      "version_requirement": ">= 6.1.0 < 8.0.0"
     }
   ],
   "pdk-version": "1.18.1",