https://github.com/nl2go/ansible-role-kafka

An Ansible Role that manages installation and configuration of Apache Kafka
https://github.com/nl2go/ansible-role-kafka

ansible ansible-role apache kafka

Last synced: 27 days ago
JSON representation

An Ansible Role that manages installation and configuration of Apache Kafka

• Host: GitHub
• URL: https://github.com/nl2go/ansible-role-kafka
• Owner: nl2go
• License: mit
• Created: 2020-06-08T12:45:47.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2021-11-15T14:24:35.000Z (about 3 years ago)
• Last Synced: 2024-11-11T14:50:00.812Z (3 months ago)
• Topics: ansible, ansible-role, apache, kafka
• Language: Jinja
• Homepage:
• Size: 104 KB
• Stars: 2
• Watchers: 4
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
[![Build Status](https://travis-ci.com/nl2go/ansible-role-kafka.svg?branch=master)](https://travis-ci.com/nl2go/ansible-role-kafka)

[![Ansible Galaxy](https://img.shields.io/badge/role-nl2go.kafka-blue.svg)](https://galaxy.ansible.com/nl2go/kafka/)

[![Ansible Galaxy Quality Score](https://img.shields.io/ansible/quality/49219)](https://galaxy.ansible.com/nl2go/kafka/)

[![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/nl2go/ansible-role-kafka)](https://github.com/nl2go/ansible-role-kafka/releases)

[![Ansible Galaxy Downloads](https://img.shields.io/ansible/role/d/49219.svg?color=blue)](https://galaxy.ansible.com/nl2go/kafka/)

# Ansible Role: Apache Kafka

An Ansible Role that manages installation and configuration of [Apache Kafka](https://kafka.apache.org/).

Kafka heavily depends on [Apache ZooKeeper](https://zookeeper.apache.org/) which is not part of this role - use [nl2go.zookeeper](https://galaxy.ansible.com/nl2go/zookeeper) to install it. 

## Role Variables

Available variables listed and described along with default values in [defaults/main.yml](defaults/main.yml).

## Dependencies

- [nl2go.openjdk](https://galaxy.ansible.com/nl2go/openjdk)

## Example Playbook

    - hosts: all

      roles:

        - nl2go.openjdk

        - nl2go.kafka

      vars:

        kafka_zookeeper_connection_hosts:

          - my.zookeeper.host:2181

## Set up custom JVM parameters

For adjusting JVM parameters you use the `kafka_environment_variables` variable to adjust the respective Kafka settings.

An overview of the variables used by Kafka can be found in the [Kafka startup script](https://github.com/apache/kafka/blob/trunk/bin/kafka-run-class.sh).

Here is an example playbook:

    - hosts: all

      roles:

        - nl2go.openjdk

        - nl2go.kafka

      vars:

        kafka_environment_variables:

          KAFKA_HEAP_OPTS="-Xmx192M"

## Set up monitoring for Kafka

For enabling monitoring via JMX you use the `kafka_jmx_enabled` variable. Additionally you can enable JMX authentication

by setting `kafka_jmx_username` and `kafka_jmx_password`. If you leave the authentication variables undefined JMX will

be set up without authentication.

Here is an example playbook:

    - hosts: all

      roles:

        - nl2go.openjdk

        - nl2go.kafka

      vars:

        kafka_jmx_enabled: true

        kafka_jmx_username: jmx

        kafka_jmx_password: jmxpass

## Development

Use [docker-molecule](https://github.com/nl2go/docker-molecule) following the instructions to run [Molecule](https://molecule.readthedocs.io/en/stable/)

or install [Molecule](https://molecule.readthedocs.io/en/stable/) locally (not recommended, version conflicts might appear).

Use following to run tests:

    molecule test --all

## Maintainers

- [dirkaholic](https://github.com/dirkaholic)

## License

See the [LICENSE.md](LICENSE.md) file for details.

## Author Information

This role was created in 2020 by [Newsletter2Go GmbH](https://www.newsletter2go.com/).