Skip to content

Commit 9a7bdb8

Browse files
TheMeierTheMeier
committed
chore: clean up documentation
1 parent 5532377 commit 9a7bdb8

File tree

7 files changed

+33
-201
lines changed

7 files changed

+33
-201
lines changed

‎.puppet-lint.rc‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1 @@
11
--fail-on-warnings
2-
--no-parameter_documentation-check
3-
--no-parameter_types-check

‎REFERENCE.md‎

Lines changed: 8 additions & 197 deletions
Original file line numberDiff line numberDiff line change
@@ -11,22 +11,22 @@
1111
* [`kafka`](#kafka): This class handles the Kafka requirements.
1212
* [`kafka::broker`](#kafka--broker): This class handles the Kafka (broker).
1313
* [`kafka::consumer`](#kafka--consumer): This class handles the Kafka (consumer).
14-
* [`kafka::consumer::config`](#kafka--consumer--config): This class handles the Kafka (consumer) config.
1514
* [`kafka::mirror`](#kafka--mirror): This class handles the Kafka (mirror).
1615
* [`kafka::params`](#kafka--params): This class provides default parameters.
1716
* [`kafka::producer`](#kafka--producer): This class handles the Kafka (producer).
18-
* [`kafka::producer::config`](#kafka--producer--config): This class handles the Kafka (producer) config.
1917

2018
#### Private Classes
2119

2220
* `kafka::broker::config`: This class handles the Kafka (broker) config.
2321
* `kafka::broker::install`: This class handles the Kafka (broker) package.
2422
* `kafka::broker::service`: This class handles the Kafka (broker) service.
23+
* `kafka::consumer::config`: This class handles the Kafka (consumer) config.
2524
* `kafka::consumer::install`: This class handles the Kafka (consumer) package.
2625
* `kafka::consumer::service`: This class handles the Kafka (consumer) service.
2726
* `kafka::mirror::config`: This class handles the Kafka (mirror) config.
2827
* `kafka::mirror::install`: This class handles the Kafka (mirror) package.
2928
* `kafka::mirror::service`: This class handles the Kafka (mirror) service.
29+
* `kafka::producer::config`: This class handles the Kafka (producer) config.
3030
* `kafka::producer::install`: This class handles the Kafka (producer) package.
3131
* `kafka::producer::service`: This class handles the Kafka (producer) service.
3232

@@ -960,134 +960,26 @@ Default value: `$kafka::params::consumer_log4j_opts`
960960

961961
Data type: `Boolean`
962962

963-
963+
Enable or disable the management of the log4j configuration file.
964964

965965
Default value: `$kafka::params::manage_log4j`
966966

967967
##### <a name="-kafka--consumer--log_file_size"></a>`log_file_size`
968968

969969
Data type: `Pattern[/[1-9][0-9]*[KMG]B/]`
970970

971-
971+
Set the max size of the Kafka log files before they are rolled.
972972

973973
Default value: `$kafka::params::log_file_size`
974974

975975
##### <a name="-kafka--consumer--log_file_count"></a>`log_file_count`
976976

977977
Data type: `Integer[1, 50]`
978978

979-
979+
Set the number of Kafka log files to keep.
980980

981981
Default value: `$kafka::params::log_file_count`
982982

983-
### <a name="kafka--consumer--config"></a>`kafka::consumer::config`
984-
985-
This class handles the Kafka (consumer) config.
986-
987-
#### Parameters
988-
989-
The following parameters are available in the `kafka::consumer::config` class:
990-
991-
* [`manage_service`](#-kafka--consumer--config--manage_service)
992-
* [`service_name`](#-kafka--consumer--config--service_name)
993-
* [`service_restart`](#-kafka--consumer--config--service_restart)
994-
* [`config`](#-kafka--consumer--config--config)
995-
* [`config_dir`](#-kafka--consumer--config--config_dir)
996-
* [`user_name`](#-kafka--consumer--config--user_name)
997-
* [`group_name`](#-kafka--consumer--config--group_name)
998-
* [`config_mode`](#-kafka--consumer--config--config_mode)
999-
* [`manage_log4j`](#-kafka--consumer--config--manage_log4j)
1000-
* [`log_file_size`](#-kafka--consumer--config--log_file_size)
1001-
* [`log_file_count`](#-kafka--consumer--config--log_file_count)
1002-
1003-
##### <a name="-kafka--consumer--config--manage_service"></a>`manage_service`
1004-
1005-
Data type: `Boolean`
1006-
1007-
1008-
1009-
Default value: `$kafka::consumer::manage_service`
1010-
1011-
##### <a name="-kafka--consumer--config--service_name"></a>`service_name`
1012-
1013-
Data type: `String[1]`
1014-
1015-
1016-
1017-
Default value: `$kafka::consumer::service_name`
1018-
1019-
##### <a name="-kafka--consumer--config--service_restart"></a>`service_restart`
1020-
1021-
Data type: `Boolean`
1022-
1023-
1024-
1025-
Default value: `$kafka::consumer::service_restart`
1026-
1027-
##### <a name="-kafka--consumer--config--config"></a>`config`
1028-
1029-
Data type: `Hash[String[1], Any]`
1030-
1031-
1032-
1033-
Default value: `$kafka::consumer::config`
1034-
1035-
##### <a name="-kafka--consumer--config--config_dir"></a>`config_dir`
1036-
1037-
Data type: `Stdlib::Absolutepath`
1038-
1039-
1040-
1041-
Default value: `$kafka::consumer::config_dir`
1042-
1043-
##### <a name="-kafka--consumer--config--user_name"></a>`user_name`
1044-
1045-
Data type: `String[1]`
1046-
1047-
1048-
1049-
Default value: `$kafka::consumer::user_name`
1050-
1051-
##### <a name="-kafka--consumer--config--group_name"></a>`group_name`
1052-
1053-
Data type: `String[1]`
1054-
1055-
1056-
1057-
Default value: `$kafka::consumer::group_name`
1058-
1059-
##### <a name="-kafka--consumer--config--config_mode"></a>`config_mode`
1060-
1061-
Data type: `Stdlib::Filemode`
1062-
1063-
1064-
1065-
Default value: `$kafka::consumer::config_mode`
1066-
1067-
##### <a name="-kafka--consumer--config--manage_log4j"></a>`manage_log4j`
1068-
1069-
Data type: `Boolean`
1070-
1071-
1072-
1073-
Default value: `$kafka::consumer::manage_log4j`
1074-
1075-
##### <a name="-kafka--consumer--config--log_file_size"></a>`log_file_size`
1076-
1077-
Data type: `Pattern[/[1-9][0-9]*[KMG]B/]`
1078-
1079-
1080-
1081-
Default value: `$kafka::consumer::log_file_size`
1082-
1083-
##### <a name="-kafka--consumer--config--log_file_count"></a>`log_file_count`
1084-
1085-
Data type: `Integer[1, 50]`
1086-
1087-
1088-
1089-
Default value: `$kafka::consumer::log_file_count`
1090-
1091983
### <a name="kafka--mirror"></a>`kafka::mirror`
1092984

1093985
This class handles the Kafka (mirror).
@@ -1420,23 +1312,23 @@ Default value: `$kafka::params::mirror_log4j_opts`
14201312

14211313
Data type: `Boolean`
14221314

1423-
1315+
Enable or disable the management of the log4j configuration file.
14241316

14251317
Default value: `$kafka::params::manage_log4j`
14261318

14271319
##### <a name="-kafka--mirror--log_file_size"></a>`log_file_size`
14281320

14291321
Data type: `Pattern[/[1-9][0-9]*[KMG]B/]`
14301322

1431-
1323+
Set the max size of the Kafka log files before they are rolled.
14321324

14331325
Default value: `$kafka::params::log_file_size`
14341326

14351327
##### <a name="-kafka--mirror--log_file_count"></a>`log_file_count`
14361328

14371329
Data type: `Integer[1, 50]`
14381330

1439-
1331+
Set the number of Kafka log files to keep.
14401332

14411333
Default value: `$kafka::params::log_file_count`
14421334

@@ -1752,87 +1644,6 @@ Set the Log4j options.
17521644

17531645
Default value: `$kafka::params::producer_log4j_opts`
17541646

1755-
### <a name="kafka--producer--config"></a>`kafka::producer::config`
1756-
1757-
This class handles the Kafka (producer) config.
1758-
1759-
#### Parameters
1760-
1761-
The following parameters are available in the `kafka::producer::config` class:
1762-
1763-
* [`manage_service`](#-kafka--producer--config--manage_service)
1764-
* [`service_name`](#-kafka--producer--config--service_name)
1765-
* [`service_restart`](#-kafka--producer--config--service_restart)
1766-
* [`config`](#-kafka--producer--config--config)
1767-
* [`config_dir`](#-kafka--producer--config--config_dir)
1768-
* [`user_name`](#-kafka--producer--config--user_name)
1769-
* [`group_name`](#-kafka--producer--config--group_name)
1770-
* [`config_mode`](#-kafka--producer--config--config_mode)
1771-
1772-
##### <a name="-kafka--producer--config--manage_service"></a>`manage_service`
1773-
1774-
Data type: `Boolean`
1775-
1776-
1777-
1778-
Default value: `$kafka::producer::manage_service`
1779-
1780-
##### <a name="-kafka--producer--config--service_name"></a>`service_name`
1781-
1782-
Data type: `String[1]`
1783-
1784-
1785-
1786-
Default value: `$kafka::producer::service_name`
1787-
1788-
##### <a name="-kafka--producer--config--service_restart"></a>`service_restart`
1789-
1790-
Data type: `Boolean`
1791-
1792-
1793-
1794-
Default value: `$kafka::producer::service_restart`
1795-
1796-
##### <a name="-kafka--producer--config--config"></a>`config`
1797-
1798-
Data type: `Hash[String[1], Any]`
1799-
1800-
1801-
1802-
Default value: `$kafka::producer::config`
1803-
1804-
##### <a name="-kafka--producer--config--config_dir"></a>`config_dir`
1805-
1806-
Data type: `Stdlib::Absolutepath`
1807-
1808-
1809-
1810-
Default value: `$kafka::producer::config_dir`
1811-
1812-
##### <a name="-kafka--producer--config--user_name"></a>`user_name`
1813-
1814-
Data type: `String[1]`
1815-
1816-
1817-
1818-
Default value: `$kafka::producer::user_name`
1819-
1820-
##### <a name="-kafka--producer--config--group_name"></a>`group_name`
1821-
1822-
Data type: `String[1]`
1823-
1824-
1825-
1826-
Default value: `$kafka::producer::group_name`
1827-
1828-
##### <a name="-kafka--producer--config--config_mode"></a>`config_mode`
1829-
1830-
Data type: `Stdlib::Filemode`
1831-
1832-
1833-
1834-
Default value: `$kafka::producer::config_mode`
1835-
18361647
## Defined types
18371648

18381649
### <a name="kafka--topic"></a>`kafka::topic`

‎manifests/broker.pp‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,7 @@
117117
# @param log4j_content
118118
# Provide custom content for the log4j configuration file if manage_log4j is enabled,
119119
# instead of using the content provided in this module.
120+
#
120121
# @param log_file_size
121122
# Set the max size of the Kafka log files before they are rolled.
122123
#

‎manifests/consumer.pp‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,15 @@
102102
# @param log4j_opts
103103
# Set the Log4j options.
104104
#
105+
# @param manage_log4j
106+
# Enable or disable the management of the log4j configuration file.
107+
#
108+
# @param log_file_size
109+
# Set the max size of the Kafka log files before they are rolled.
110+
#
111+
# @param log_file_count
112+
# Set the number of Kafka log files to keep.
113+
#
105114
class kafka::consumer (
106115
String[1] $kafka_version = $kafka::params::kafka_version,
107116
String[1] $scala_version = $kafka::params::scala_version,

‎manifests/consumer/config.pp‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# @summary
22
# This class handles the Kafka (consumer) config.
3-
#
3+
# @api private
44
class kafka::consumer::config (
55
Boolean $manage_service = $kafka::consumer::manage_service,
66
String[1] $service_name = $kafka::consumer::service_name,
@@ -14,6 +14,8 @@
1414
Pattern[/[1-9][0-9]*[KMG]B/] $log_file_size = $kafka::consumer::log_file_size,
1515
Integer[1, 50] $log_file_count = $kafka::consumer::log_file_count,
1616
) {
17+
assert_private()
18+
1719
if ($manage_service and $service_restart) {
1820
$config_notify = Service[$service_name]
1921
} else {

‎manifests/mirror.pp‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,15 @@
114114
# @param log4j_opts
115115
# Set the Log4j options.
116116
#
117+
# @param manage_log4j
118+
# Enable or disable the management of the log4j configuration file.
119+
#
120+
# @param log_file_size
121+
# Set the max size of the Kafka log files before they are rolled.
122+
#
123+
# @param log_file_count
124+
# Set the number of Kafka log files to keep.
125+
#
117126
class kafka::mirror (
118127
String[1] $kafka_version = $kafka::params::kafka_version,
119128
String[1] $scala_version = $kafka::params::scala_version,

‎manifests/producer/config.pp‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# @summary
22
# This class handles the Kafka (producer) config.
3-
#
3+
# @api private
44
class kafka::producer::config (
55
Boolean $manage_service = $kafka::producer::manage_service,
66
String[1] $service_name = $kafka::producer::service_name,
@@ -11,6 +11,8 @@
1111
String[1] $group_name = $kafka::producer::group_name,
1212
Stdlib::Filemode $config_mode = $kafka::producer::config_mode,
1313
) {
14+
assert_private()
15+
1416
if ($manage_service and $service_restart) {
1517
$config_notify = Service[$service_name]
1618
} else {

0 commit comments

Comments
 (0)