Charmed Kafka Documentation
The Charmed Kafka Operator delivers automated operations management from day 0 to day 2 on the Apache Kafka event streaming platform. It is an open source, end-to-end, production ready data platform on top of cloud native technologies.
This operator charm comes with features such as:
- Fault-tolerance, replication, scalability and high-availability out-of-the-box.
- SASL/SCRAM auth for Broker-Broker and Client-Broker authenticaion enabled by default.
- Access control management supported with user-provided ACL lists.
The Kafka Operator uses the latest upstream Kafka binaries released by the The Apache Software Foundation that comes with Kafka, made available using the
charmed-kafka snap distributed by Canonical.
As currently Kafka requires a paired ZooKeeper deployment in production, this operator makes use of the ZooKeeper Operator for various essential functions.
The Charmed Kafka operator comes in two flavours to deploy and operate Kafka on physical/virtual machines and Kubernetes. Both offer features such as replication, TLS, password rotation, and easy to use integration with applications. The Charmed Kafka Operator meets the need of deploying Kafka in a structured and consistent manner while allowing the user flexibility in configuration. It simplifies deployment, scaling, configuration and management of Kafka in production at scale in a reliable way.
Charm version, environment and OS
A charm version is a combination of both the application version and / (slash) the channel, e.g. 3/stable, 3/candidate, 3/edge. The channels are ordered from the most stable to the least stable, candidate, and edge. More risky channels like edge are always implicitly available. So, if the candidate is listed, you can pull the candidate and edge. When stable is listed, all three are available.
You can deploy the charm a stand-alone machine or cloud and cloud-like environments, including AWS, Azure, OpenStack and VMWare.
The upper portion of this page describes the Operating System (OS) where the charm can run e.g. 3/stable is compatible and should run in a machine with Ubuntu 22.04 OS.
Security, Bugs and feature request
If you find a bug in this snap or want to request a specific feature, here are the useful links:
Raise issues or feature requests in Github
Security issues in the Charmed Kafka Operator can be reported through LaunchPad. Please do not file GitHub issues about security issues.
Meet the community and chat with us if there are issues and feature requests in our Mattermost Channel
The Charmed Kafka Operator is free software, distributed under the Apache Software License, version 2.0. See LICENSE for more information.
|2||t-setup-environment||2. Set up the environment|
|2||t-deploy-kafka||3. Deploy Kafka|
|2||t-manage-passwords||4. Manage passwords|
|2||t-relate-kafka||5. Relate Kafka to other applications|
|2||t-cleanup-environment||6. Cleanup your environment|
|2||h-create-mtls-client-credentials||Create mTLS Client Credentials|