Note

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

Charmed Apache Kafka K8s documentation¶

Charmed Apache Kafka K8s is an open-source software operator, packaged as a Juju charm, that simplifies the deployment, scaling, and management of Apache Kafka clusters on Kubernetes.

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 • AKS • EKS • Requirements
Operations	Connections management • Unit management • Monitoring • File system paths • Broker listeners • Status reference • External K8s connection
Maintenance	Version upgrade • Migration • Replication • MirrorMaker • Backups
Security	Overview • Enable encryption • 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 K8s is a distribution of Apache Kafka. It’s an open-source project that welcomes community contributions, suggestions, fixes and constructive feedback.

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.

License¶

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