Documentation Issues

[TJM]

I was helping someone new to puppet setup this module, and we found that several of the documentation examples have issues. I might be able to convince him to submit a PR, or if not, I will try to fit it in. Just in case someone else is trying to figure out why things are not working when they paste in the example code.

I will try to itemize the ones I see for now:

• There are several places where the code expects an "Integer" but the example code has '1', which is a "String" ... This results in the following error:

Error: Evaluation Error: Error while evaluating a Function Call, Class[Confluent::Kafka::Broker]: parameter 'broker_id' expects an Integer value, got String (file: /etc/puppetlabs/code/environments/vagrant/site/profile/manifests/confluent_kafka/broker.pp, line: 3, column: 3) on node kafka01.vagrant.local`)

It can be solved by removing the quotes around the 1, like:

confluent::zookeeper::zookeeper_id: 1

or

class{'confluent::zookeeper':
  zookeeper_id => 1,
}

NOTE: I feel like there should be some "automated" way to determine this ID by default, but that is another story.

• The hieradata lists should not have commas or quotes (some of the hiera examples appear to be copied from the Puppet code example, with minimal reformatting). It should look like:

confluent::kafka::broker::zookeeper_connect:
  - zookeeper01:2181
  - zookeeper02:2181
  - zookeeper03:2181

• The hashes are represented incorrectly in the examples and readme. It should just be key: value. Like:

confluent::zookeeper::config:
  server.1: zookeeper01:2888:3888
  server.2: zookeeper02:2888:3888
  server.3: zookeeper03:2888:3888

[TJM]

• It is no longer necessary or desirable to prefix class names with :: such as:

include ::confluent::zookeeper

It should just be:

include confluent::zookeeper

REF: https://tickets.puppetlabs.com/browse/PUP-4818

This was fixed ~ Puppet 3.8.7 (long ago)