Merge pull request #4 from rjd1/0.2.3

0.2.3
rjd1 · Dec 8, 2023 · 028ab22 · 028ab22
2 parents ef89e2b + 0245eb5
commit 028ab22
Show file tree

Hide file tree

Showing 7 changed files with 29 additions and 25 deletions.
diff --git a/.fixtures.yml b/.fixtures.yml
@@ -5,5 +5,5 @@ fixtures:
   forge_modules:
     kafka_connect:
        repo: "rjd1/kafka_connect"
-       ref: "0.2.2"
+       ref: "0.2.3"
     stdlib: "puppetlabs/stdlib"
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,12 @@
 
 Release notes for the rjd1-kafka_connect module.
 
+## Release 0.2.3
+
+2023-12-08 - documentation updates
+
+* Updated various portions of the docs
+
 ## Release 0.2.2
 
 2023-10-30 - update to provider restart

diff --git a/README.md b/README.md
@@ -5,9 +5,9 @@ Welcome to the kafka_connect Puppet module!
 ## Table of Contents
 
 1. [Description](#description)
-1. [Setup - The basics of getting started with kafka_connect](#setup)
+2. [Setup - The basics of getting started with kafka_connect](#setup)
     * [What kafka_connect affects](#what-kafka_connect-affects)
-1. [Usage - Configuration options and additional functionality](#usage)
+3. [Usage - Configuration options and additional functionality](#usage)
     * [Using the provider directly](#using-the-provider-directly)
     * * [Examples](#examples)
     * [Managing connectors through the helper class](#managing-connectors-through-the-helper-class)
@@ -16,15 +16,15 @@ Welcome to the kafka_connect Puppet module!
     * * [Remove a Connector](#remove-a-connector)
     * * [Pause a Connector](#pause-a-connector)
     * * [Add Secrets Config Data](#add-secrets-config-data)
-1. [Limitations - OS compatibility, etc.](#limitations)
-1. [Development - Guide for contributing to the module](#development)
+4. [Reference - An under-the-hood peek at what the module is doing and how](REFERENCE.md)
+5. [Limitations - OS compatibility, etc.](#limitations)
+    * [Known Issues](#known-issues)
+6. [Development - Guide for contributing to the module](#development)
 
 ## Description
 
 Type, Provider, and helper class for management of individual Kafka Connect connectors.
 
-Note that this module *does not* (at present) manage the actual KC installation and service setup.
-
 ## Setup
 
 ### What kafka_connect affects
@@ -52,8 +52,6 @@ To pause:
 
 ```puppet
   manage_connector { 'some-kc-connector' :
-    ensure                 => 'present',
-    config_file            => '/etc/kafka-connect/some-kc-connector.properties.json',
     connector_state_ensure => 'PAUSED',
   }
 ```
@@ -80,7 +78,7 @@ include kafka_connect
 
 The connector config data should be added to hiera with the following layout.
 
-**NOTE:** boolean and integer values must be quoted. This is important in order to avoid a situation where Puppet wants to constantly update the connector, due to the comparison done between file config & live connector.
+NOTE: boolean and integer values *must be quoted*. This is important in order to avoid a situation where Puppet wants to constantly update the connector, due to the comparison done between file config & live connector.
 
 ```yaml
 kafka_connect::connectors:
@@ -166,16 +164,20 @@ The `connectors` array should contain a list of connector names that reference i
 
 Tested with Confluent 7.1.1 on Amazon Linux 2.
 
+Each secrets file should contain only one key-value pair.
+
+### Known Issues
+
 In order to remove a connector thru hiera, the config put in place during the add step must remain. This is necessary for the config file to be removed along with the live connector.
 
-When the `enable_delete` parameter is set to false and a connector is set to absent, Puppet still says there is a removal (i.e., lies). There is a warning output along with the notice, however.
+If numeric or boolean config values in hiera are not quoted, it will result in the connector being updated on every Puppet run (config_updated changed 'no' to 'yes').
 
-Each secrets file should contain only one key-value pair.
+When the `enable_delete` parameter is set to false and a connector is set to absent, Puppet still says there is a removal (i.e., lies). A similar situation occurs with the `config_updated` property when both it and `config_file` are not specified. There are warnings output along with the notices in these scenarios.
 
 ## Development
 
-The project is held at github:
+The project is held at GitHub:
 
 * [https://github.com/rjd1/puppet-kafka_connect](https://github.com/rjd1/puppet-kafka_connect)
 
-Issue reports, patches, pull requests are welcome!
+Issue reports and pull requests are welcome.
diff --git a/REFERENCE.md b/REFERENCE.md
@@ -8,11 +8,11 @@
 
 #### Public Classes
 
-* [`kafka_connect`](#kafka_connect): Manages kafka-connect
+* [`kafka_connect`](#kafka_connect): Main kafka_connect class.
 
 #### Private Classes
 
-* `kafka_connect::manage_connectors`: Manage KC connectors
+* `kafka_connect::manage_connectors`: Private class to manage individual Kafka Connect connectors.
 
 ### Resource types
 
@@ -22,7 +22,7 @@
 
 ### <a name="kafka_connect"></a>`kafka_connect`
 
-Main kafka_connect class
+Main kafka_connect class.
 
 #### Examples
 

diff --git a/manifests/init.pp b/manifests/init.pp
@@ -1,6 +1,4 @@
-# @summary Manages kafka-connect
-#
-# Main kafka_connect class
+# Main kafka_connect class.
 #
 # @param connectors_absent
 #   List of connectors to ensure absent.

diff --git a/manifests/manage_connectors.pp b/manifests/manage_connectors.pp
@@ -1,6 +1,4 @@
-# @summary Manage KC connectors
-#
-# Private class to manage individual kafka-connect connectors.
+# Private class to manage individual Kafka Connect connectors.
 #
 # @author https://github.com/rjd1/puppet-kafka_connect/graphs/contributors
 #

diff --git a/metadata.json b/metadata.json
@@ -1,8 +1,8 @@
 {
   "name": "rjd1-kafka_connect",
-  "version": "0.2.2",
+  "version": "0.2.3",
   "author": "rjd1",
-  "summary": "Module to manage Kafka Connect",
+  "summary": "Provides management of Kafka Connect connectors.",
   "license": "Apache-2.0",
   "source": "git://github.com/rjd1/puppet-kafka_connect",
   "project_page": "https://github.com/rjd1/puppet-kafka_connect",