Ansible Collection - redhat.amq_streams

Collection to install and configure Apache Kafka / Red Hat AMQ Streams.

Ansible version compatibility

This collection has been tested against following Ansible versions: >=2.9.10.

Plugins and modules within a collection may be tested with only specific Ansible versions. A collection may contain metadata that identifies these versions.

Included content

Roles

• amq_streams_common: Common tasks for the collection.
• amq_streams_zookeeper: Perform installation and configuration of Zookeeper ensemble.
• amq_streams_broker: Perform installation and configuration of Kafka brokers cluster.
• amq_streams_connect: Perform installation and configuration of Kafka Connect cluster.

Installation

Installing the Collection from Automation Hub

Before using the collection, you need to setup Ansible Automation Hub as galaxy server; then install it via the CLI:

ansible-galaxy collection install redhat.amq_streams

Build and install locally

Clone the repository, checkout the tag you want to build, or pick the main branch for the development version; then:

ansible-galaxy collection build .
ansible-galaxy collection install redhat-amq_streams-*.tar.gz

Usage

Install Playbook

• playbooks/playbook.yml deploys based on the collections defaults.

For full service configuration details, refer to each role README file:

• Common Role
• Zookeeper Role
• Broker Role
• Connect Role

Downloading from the Customer Portal

The amq_streams role supports downloading and installing from the Red Hat Customer Portal using credentials associated to a service account. After having authenticated in the customer portal, navigate to the hybrid cloud console, and select the services account tab to create one, if needed. Client ID and Client Secret associated to the service account need to be provided to the collection using the following variables:

rhn_username: '<client_id>'
rhn_password: '<client_secret>'

The downloaded product archive will be stored in the controller working directory, and then distributed to target nodes.

Offline installation

Making the amq_streams_common_archive_file archive available to the playbook working directory, and setting amq_streams_common_offline_install to True, allows to skip the download tasks. The amq_streams_common_download_dir path for the archive does match the downloaded archive path, so that it is also used as a cache when multiple hosts are provisioned in a cluster.

  vars:
    amq_streams_common_offline_install: true
    amq_streams_common_download_dir: "/tmp"

Install from alternate sources

It is possible to perform downloads from alternate sources (like corporate Nexus, Artifactory, proxy, etc), using the amq_streams_common_download_url variable; make sure the final downloaded filename matches with the source filename described by the amq_streams_common_archive_file variable (ie. kafka_-a.b.c-x.y.z.tgz).

Support

redhat.amq_streams collection v1.0.0 is for Technical Preview. If you have any issues or questions related to collection, please don't hesitate to contact us on Ansible-middleware-core@redhat.com or open an issue on https://github.com/ansible-middleware/amq_streams/issues

License

Apache License v2.0 or later

See LICENSE to view the full text.