diff --git a/.puppet-lint.rc b/.puppet-lint.rc
index 558d766..02a3e71 100644
--- a/.puppet-lint.rc
+++ b/.puppet-lint.rc
@@ -1,2 +1 @@
--fail-on-warnings
---no-parameter_documentation-check
diff --git a/REFERENCE.md b/REFERENCE.md
index 712c066..49ed9a5 100644
--- a/REFERENCE.md
+++ b/REFERENCE.md
@@ -11,22 +11,22 @@
* [`kafka`](#kafka): This class handles the Kafka requirements.
* [`kafka::broker`](#kafka--broker): This class handles the Kafka (broker).
* [`kafka::consumer`](#kafka--consumer): This class handles the Kafka (consumer).
-* [`kafka::consumer::config`](#kafka--consumer--config): This class handles the Kafka (consumer) config.
* [`kafka::mirror`](#kafka--mirror): This class handles the Kafka (mirror).
* [`kafka::params`](#kafka--params): This class provides default parameters.
* [`kafka::producer`](#kafka--producer): This class handles the Kafka (producer).
-* [`kafka::producer::config`](#kafka--producer--config): This class handles the Kafka (producer) config.
#### Private Classes
* `kafka::broker::config`: This class handles the Kafka (broker) config.
* `kafka::broker::install`: This class handles the Kafka (broker) package.
* `kafka::broker::service`: This class handles the Kafka (broker) service.
+* `kafka::consumer::config`: This class handles the Kafka (consumer) config.
* `kafka::consumer::install`: This class handles the Kafka (consumer) package.
* `kafka::consumer::service`: This class handles the Kafka (consumer) service.
* `kafka::mirror::config`: This class handles the Kafka (mirror) config.
* `kafka::mirror::install`: This class handles the Kafka (mirror) package.
* `kafka::mirror::service`: This class handles the Kafka (mirror) service.
+* `kafka::producer::config`: This class handles the Kafka (producer) config.
* `kafka::producer::install`: This class handles the Kafka (producer) package.
* `kafka::producer::service`: This class handles the Kafka (producer) service.
@@ -960,7 +960,7 @@ Default value: `$kafka::params::consumer_log4j_opts`
Data type: `Boolean`
-
+Enable or disable the management of the log4j configuration file.
Default value: `$kafka::params::manage_log4j`
@@ -968,7 +968,7 @@ Default value: `$kafka::params::manage_log4j`
Data type: `Pattern[/[1-9][0-9]*[KMG]B/]`
-
+Set the max size of the Kafka log files before they are rolled.
Default value: `$kafka::params::log_file_size`
@@ -976,118 +976,10 @@ Default value: `$kafka::params::log_file_size`
Data type: `Integer[1, 50]`
-
+Set the number of Kafka log files to keep.
Default value: `$kafka::params::log_file_count`
-### `kafka::consumer::config`
-
-This class handles the Kafka (consumer) config.
-
-#### Parameters
-
-The following parameters are available in the `kafka::consumer::config` class:
-
-* [`manage_service`](#-kafka--consumer--config--manage_service)
-* [`service_name`](#-kafka--consumer--config--service_name)
-* [`service_restart`](#-kafka--consumer--config--service_restart)
-* [`config`](#-kafka--consumer--config--config)
-* [`config_dir`](#-kafka--consumer--config--config_dir)
-* [`user_name`](#-kafka--consumer--config--user_name)
-* [`group_name`](#-kafka--consumer--config--group_name)
-* [`config_mode`](#-kafka--consumer--config--config_mode)
-* [`manage_log4j`](#-kafka--consumer--config--manage_log4j)
-* [`log_file_size`](#-kafka--consumer--config--log_file_size)
-* [`log_file_count`](#-kafka--consumer--config--log_file_count)
-
-##### `manage_service`
-
-Data type: `Boolean`
-
-
-
-Default value: `$kafka::consumer::manage_service`
-
-##### `service_name`
-
-Data type: `String[1]`
-
-
-
-Default value: `$kafka::consumer::service_name`
-
-##### `service_restart`
-
-Data type: `Boolean`
-
-
-
-Default value: `$kafka::consumer::service_restart`
-
-##### `config`
-
-Data type: `Hash[String[1], Any]`
-
-
-
-Default value: `$kafka::consumer::config`
-
-##### `config_dir`
-
-Data type: `Stdlib::Absolutepath`
-
-
-
-Default value: `$kafka::consumer::config_dir`
-
-##### `user_name`
-
-Data type: `String[1]`
-
-
-
-Default value: `$kafka::consumer::user_name`
-
-##### `group_name`
-
-Data type: `String[1]`
-
-
-
-Default value: `$kafka::consumer::group_name`
-
-##### `config_mode`
-
-Data type: `Stdlib::Filemode`
-
-
-
-Default value: `$kafka::consumer::config_mode`
-
-##### `manage_log4j`
-
-Data type: `Boolean`
-
-
-
-Default value: `$kafka::consumer::manage_log4j`
-
-##### `log_file_size`
-
-Data type: `Pattern[/[1-9][0-9]*[KMG]B/]`
-
-
-
-Default value: `$kafka::consumer::log_file_size`
-
-##### `log_file_count`
-
-Data type: `Integer[1, 50]`
-
-
-
-Default value: `$kafka::consumer::log_file_count`
-
### `kafka::mirror`
This class handles the Kafka (mirror).
@@ -1420,7 +1312,7 @@ Default value: `$kafka::params::mirror_log4j_opts`
Data type: `Boolean`
-
+Enable or disable the management of the log4j configuration file.
Default value: `$kafka::params::manage_log4j`
@@ -1428,7 +1320,7 @@ Default value: `$kafka::params::manage_log4j`
Data type: `Pattern[/[1-9][0-9]*[KMG]B/]`
-
+Set the max size of the Kafka log files before they are rolled.
Default value: `$kafka::params::log_file_size`
@@ -1436,7 +1328,7 @@ Default value: `$kafka::params::log_file_size`
Data type: `Integer[1, 50]`
-
+Set the number of Kafka log files to keep.
Default value: `$kafka::params::log_file_count`
@@ -1752,87 +1644,6 @@ Set the Log4j options.
Default value: `$kafka::params::producer_log4j_opts`
-### `kafka::producer::config`
-
-This class handles the Kafka (producer) config.
-
-#### Parameters
-
-The following parameters are available in the `kafka::producer::config` class:
-
-* [`manage_service`](#-kafka--producer--config--manage_service)
-* [`service_name`](#-kafka--producer--config--service_name)
-* [`service_restart`](#-kafka--producer--config--service_restart)
-* [`config`](#-kafka--producer--config--config)
-* [`config_dir`](#-kafka--producer--config--config_dir)
-* [`user_name`](#-kafka--producer--config--user_name)
-* [`group_name`](#-kafka--producer--config--group_name)
-* [`config_mode`](#-kafka--producer--config--config_mode)
-
-##### `manage_service`
-
-Data type: `Boolean`
-
-
-
-Default value: `$kafka::producer::manage_service`
-
-##### `service_name`
-
-Data type: `String[1]`
-
-
-
-Default value: `$kafka::producer::service_name`
-
-##### `service_restart`
-
-Data type: `Boolean`
-
-
-
-Default value: `$kafka::producer::service_restart`
-
-##### `config`
-
-Data type: `Hash[String[1], Any]`
-
-
-
-Default value: `$kafka::producer::config`
-
-##### `config_dir`
-
-Data type: `Stdlib::Absolutepath`
-
-
-
-Default value: `$kafka::producer::config_dir`
-
-##### `user_name`
-
-Data type: `String[1]`
-
-
-
-Default value: `$kafka::producer::user_name`
-
-##### `group_name`
-
-Data type: `String[1]`
-
-
-
-Default value: `$kafka::producer::group_name`
-
-##### `config_mode`
-
-Data type: `Stdlib::Filemode`
-
-
-
-Default value: `$kafka::producer::config_mode`
-
## Defined types
### `kafka::topic`
diff --git a/manifests/broker.pp b/manifests/broker.pp
index 4c19c0b..65249f5 100644
--- a/manifests/broker.pp
+++ b/manifests/broker.pp
@@ -117,6 +117,7 @@
# @param log4j_content
# Provide custom content for the log4j configuration file if manage_log4j is enabled,
# instead of using the content provided in this module.
+#
# @param log_file_size
# Set the max size of the Kafka log files before they are rolled.
#
diff --git a/manifests/consumer.pp b/manifests/consumer.pp
index d94bffb..530ec09 100644
--- a/manifests/consumer.pp
+++ b/manifests/consumer.pp
@@ -102,6 +102,15 @@
# @param log4j_opts
# Set the Log4j options.
#
+# @param manage_log4j
+# Enable or disable the management of the log4j configuration file.
+#
+# @param log_file_size
+# Set the max size of the Kafka log files before they are rolled.
+#
+# @param log_file_count
+# Set the number of Kafka log files to keep.
+#
class kafka::consumer (
String[1] $kafka_version = $kafka::params::kafka_version,
String[1] $scala_version = $kafka::params::scala_version,
diff --git a/manifests/consumer/config.pp b/manifests/consumer/config.pp
index ec11ac1..7d569e6 100644
--- a/manifests/consumer/config.pp
+++ b/manifests/consumer/config.pp
@@ -1,6 +1,6 @@
# @summary
# This class handles the Kafka (consumer) config.
-#
+# @api private
class kafka::consumer::config (
Boolean $manage_service = $kafka::consumer::manage_service,
String[1] $service_name = $kafka::consumer::service_name,
@@ -14,6 +14,8 @@
Pattern[/[1-9][0-9]*[KMG]B/] $log_file_size = $kafka::consumer::log_file_size,
Integer[1, 50] $log_file_count = $kafka::consumer::log_file_count,
) {
+ assert_private()
+
if ($manage_service and $service_restart) {
$config_notify = Service[$service_name]
} else {
diff --git a/manifests/mirror.pp b/manifests/mirror.pp
index f0493b3..4e7baa4 100644
--- a/manifests/mirror.pp
+++ b/manifests/mirror.pp
@@ -114,6 +114,15 @@
# @param log4j_opts
# Set the Log4j options.
#
+# @param manage_log4j
+# Enable or disable the management of the log4j configuration file.
+#
+# @param log_file_size
+# Set the max size of the Kafka log files before they are rolled.
+#
+# @param log_file_count
+# Set the number of Kafka log files to keep.
+#
class kafka::mirror (
String[1] $kafka_version = $kafka::params::kafka_version,
String[1] $scala_version = $kafka::params::scala_version,
diff --git a/manifests/producer/config.pp b/manifests/producer/config.pp
index a4113c8..8bcef46 100644
--- a/manifests/producer/config.pp
+++ b/manifests/producer/config.pp
@@ -1,6 +1,6 @@
# @summary
# This class handles the Kafka (producer) config.
-#
+# @api private
class kafka::producer::config (
Boolean $manage_service = $kafka::producer::manage_service,
String[1] $service_name = $kafka::producer::service_name,
@@ -11,6 +11,8 @@
String[1] $group_name = $kafka::producer::group_name,
Stdlib::Filemode $config_mode = $kafka::producer::config_mode,
) {
+ assert_private()
+
if ($manage_service and $service_restart) {
$config_notify = Service[$service_name]
} else {