evbus-kafka 5.0.0

evbus app-merge components for kafka queues

This project contains app-merge components for pop-evbus .

Getting Started

Prerequisites

• Python 3.8+

• git (if installing from source, or contributing to the project)

Installation

Note

If wanting to contribute to the project, and setup your local development environment, see the CONTRIBUTING.rst document in the source repository for this project.

If wanting to use evbus-kafka, you can do so by either installing from PyPI or from source.

Install from PyPI

pip install evbus-kafka

Install from source

# clone repo
git clone [e-mail]:vmware/idem/evbus-kafka.git
cd evbus-kafka

# Setup venv
python3 -m venv .venv
source .venv/bin/activate
pip install -e .

Usage

Configure pop-evbus for your app.

The connection portion of the kafka profile accepts any parameters that can be used in the AIOKafkaProducer class

credentials.yml

kafka:
  default:
    connection:
      bootstrap_servers:
        - localhost:9092
    topics:
      - topic1
      - topic2

Encrypt the credentials file and export the ACCT environment variables

$ pip install acct
$ export ACCT_KEY=$(acct encrypt credentials.yml)
$ export ACCT_FILE="$PWD/credentials.yml.fernet"

Now when you put a message on the evbus queue, it will be propagated to your configured kafka implementation.

async def my_func(hub):
    await hub.evbus.broker.put(body={"message": "event content"}, profile="default")

Testing

A kafka server is necessary for running the tests. You can use your own kafka server, or you can use docker . Start a local kafka server:

docker run -p 2181:2181 -p 443:9092 -p 9092:9092 \                                    ✔  14s   idem-core 
  --env ADVERTISED_LISTENERS=PLAINTEXT://localhost:443,INTERNAL://localhost:9093 \
  --env LISTENERS=PLAINTEXT://0.0.0.0:9092,INTERNAL://0.0.0.0:9093 \
  --env SECURITY_PROTOCOL_MAP=PLAINTEXT:PLAINTEXT,INTERNAL:PLAINTEXT \
  --env INTER_BROKER=INTERNAL \
  krisgeus/docker-kafka

Configure credentials for testing with a local rabbitmq server:

# credentials.yml
kafka:
  test_development_evbus_kafka:
    connection:
      bootstrap_servers: localhost:9092

Encrypt the credentials file and export the ACCT environment variables

$ pip install acct
$ export ACCT_KEY=$(acct encrypt credentials.yml)
$ export ACCT_FILE="$PWD/credentials.yml.fernet"

Install testing requirements

$ pip install -r requirements/test.in

Run the tests with pytest: .. code-block:: bash

$ pytest tests

Roadmap

Reference the open issues for a list of proposed features (and known issues).

Acknowledgements

• Img Shields for making repository badges easy.