Note

This is an IAAS/VM charmed operator. To deploy on Kubernetes, see Charmed Apache Kafka K8s operator.

Charmed Apache Kafka documentation

Charmed Apache Kafka is an open-source software operator, packaged as a Juju charm, that simplifies the deployment, scaling, and management of Apache Kafka clusters on physical hardware, Virtual Machines, as well as cloud and cloud-like environments including AWS, Azure, OpenStack, and VMware.

Apache Kafka is a free, open-source software project by the Apache Software Foundation.

The charm helps ops teams and administrators automate Apache Kafka operations from Day 0 to Day 2 with additional capabilities, such as: replication, TLS encryption, password rotation, easy-to-use application integration, and monitoring.

In this documentation

Tutorial	Introduction • Step 1: Environment setup
Deployment	Main deployment guide • AWS • Azure • KRaft mode • Apache ZooKeeper configuration • Requirements
Operations	Application management • Unit management • Monitoring • Snap entrypoints • File system paths • Broker listeners • Status reference • Performance overview • Troubleshooting
Maintenance	Version upgrade • Migration • Replication • MirrorMaker • Backups
Security	Overview • Enable encryption • OAuth • mTLS • Cryptography
Extensions	Kafka Connect • Schema registry

How the documentation is organised

Tutorial: For new users needing to learn how to use Charmed Apache Kafka
How-to guides: For users needing step-by-step instructions to achieve a practical goal
Reference: For precise, theoretical, factual information to be used while working with the charm
Explanation: For deeper understanding of key Charmed Apache Kafka concepts

Project and community

Charmed Apache Kafka is part of the Juju ecosystem of open-source, self-driving deployment tools. It can be integrated with multiple other Juju charms, also available on Charmhub.

It’s an open-source project developed and supported by Canonical that welcomes community contributions, suggestions, fixes and constructive feedback.

• Read our Code of Conduct

• Join the Discourse forum

• Contribute and report issues

• Explore Canonical Data Fabric solutions

• Contact us for all further questions

License and trademarks

Apache®, Apache Kafka, Kafka®, and the Apache Kafka logo are either registered trademarks or trademarks of the Apache Software Foundation in the United States and/or other countries.

The Charmed Apache Kafka Operator is free software, distributed under the Apache Software License, version 2.0. See LICENSE for more information.