# Charmed Apache Kafka

> This is the documentation for Charmed Apache Kafka, an automated
> deployment and management solution for Apache Kafka on Ubuntu.


2026

## Pages

- [Charmed Apache Kafka documentation](https://canonical.com/data/kafka/docs/4/index.html.md): Complete documentation for Charmed Apache Kafka operators - deploy, manage, and scale Apache Kafka clusters on VMs and Kubernetes.
- [How to contribute](https://canonical.com/data/kafka/docs/4/contributing/index.html.md): How to contribute to Charmed Apache Kafka - report issues, contribute code and documentation, get in touch with the team, and learn about Canonical career opportunities.
- [How-to guides](https://canonical.com/data/kafka/docs/4/how-to/index.html.md): Comprehensive how-to guides for Charmed Apache Kafka - deployment, management, security, monitoring, and cluster replication.
- [How to set up monitoring](https://canonical.com/data/kafka/docs/4/how-to/monitoring/index.html.md): Set up Charmed Apache Kafka monitoring with Canonical Observability Stack - integrate Grafana, Prometheus, and Loki for metrics.
- [Enable OAuth through Canonical Identity Platform](https://canonical.com/data/kafka/docs/4/how-to/oauth/index.html.md): This guide currently covers **VM deployments only**. The Canonical
- [How to use Kafka Connect for ETL workloads](https://canonical.com/data/kafka/docs/4/how-to/kafka-connect/index.html.md): Use Kafka Connect for ETL workloads - deploy connectors, manage plugins, and configure REST API authentication.
- [How to manage client connections](https://canonical.com/data/kafka/docs/4/how-to/client-connections/index.html.md): Manage Charmed Apache Kafka client connections using the kafka_client interface and data-integrator charm for credential management.
- [Use mTLS for clients](https://canonical.com/data/kafka/docs/4/how-to/create-mtls-client-credentials/index.html.md): Create mTLS client credentials for Charmed Apache Kafka - set up mutual TLS authentication with certificate generation and trust.
- [How to use Kafka UI](https://canonical.com/data/kafka/docs/4/how-to/kafka-ui/index.html.md): Administration of a Charmed Apache Kafka cluster can be performed using the Juju CLI and the
- [How to upgrade between versions](https://canonical.com/data/kafka/docs/4/how-to/upgrade/index.html.md): Upgrade Charmed Apache Kafka between versions - in-place minor upgrades with rolling restart and rollback procedures.
- [How to connect to Charmed Apache Kafka K8s externally](https://canonical.com/data/kafka/docs/4/how-to/external-k8s-connection/index.html.md): Configure NodePort services for clients outside a Charmed Apache Kafka K8s cluster.
- [How to manage units](https://canonical.com/data/kafka/docs/4/how-to/manage-units/index.html.md): Scale Charmed Apache Kafka clusters - add or remove broker units and reassign partitions for optimal resource utilization.
- [Schemas and serialisation](https://canonical.com/data/kafka/docs/4/how-to/schemas-serialisation/index.html.md): Manage Charmed Apache Kafka message schemas with Karapace - schema registry for data serialization and deserialization.
- [How to enable TLS encryption](https://canonical.com/data/kafka/docs/4/how-to/tls-encryption/index.html.md): Enable TLS encryption for Charmed Apache Kafka - secure client and internal communications with certificate management.
- [Cluster replication](https://canonical.com/data/kafka/docs/4/how-to/cluster/index.html.md): Charmed Apache Kafka cluster operations with MirrorMaker 2 - migration and replication guides for charmed clusters.
- [Set up replication between charmed clusters](https://canonical.com/data/kafka/docs/4/how-to/cluster/replication/index.html.md): Set up Charmed Apache Kafka cluster replication with MirrorMaker - active-passive replication using Kafka Connect.
- [Migrate from a non-charmed Kafka clusters](https://canonical.com/data/kafka/docs/4/how-to/cluster/migrate/index.html.md): Migrate from non-charmed Kafka clusters using MirrorMaker 2.0 - one-way data and offset synchronization.
- [Deploy](https://canonical.com/data/kafka/docs/4/how-to/deploy/index.html.md): Deploy Charmed Apache Kafka on any platform - complete deployment guides via Juju CLI, Terraform, AWS, Azure, and Juju spaces.
- [How to deploy via Terraform](https://canonical.com/data/kafka/docs/4/how-to/deploy/deploy-terraform/index.html.md): Deploy Charmed Apache Kafka using Terraform and the Juju Terraform provider.
- [Deploy on Juju spaces](https://canonical.com/data/kafka/docs/4/how-to/deploy/deploy-spaces/index.html.md): Deploy Charmed Apache Kafka using Juju network spaces - separate internal and client traffic with network space binding.
- [How to deploy on Azure](https://canonical.com/data/kafka/docs/4/how-to/deploy/deploy-azure/index.html.md): Deploy Charmed Apache Kafka on Microsoft Azure - installation, authentication, and managed identity configuration.
- [How to deploy on AWS](https://canonical.com/data/kafka/docs/4/how-to/deploy/deploy-aws/index.html.md): Deploy Charmed Apache Kafka on AWS EC2 - complete guide with Juju setup, authentication, and cluster deployment.
- [How to deploy Charmed Apache Kafka](https://canonical.com/data/kafka/docs/4/how-to/deploy/deploy-anywhere/index.html.md): Platform-independent guide to deploy Charmed Apache Kafka on VM or Kubernetes - set up Juju controller, model, and create admin users.
- [Reference](https://canonical.com/data/kafka/docs/4/reference/index.html.md): Charmed Apache Kafka reference materials - release notes, actions, configurations, file paths, command-line utilities, and status reference.
- [File system paths](https://canonical.com/data/kafka/docs/4/reference/file-system-paths/index.html.md): Charmed Apache Kafka file system paths reference - binary, configuration, logs, and data directory locations in Charmed Apache Kafka.
- [Performance tuning](https://canonical.com/data/kafka/docs/4/reference/performance-tuning/index.html.md): Charmed Apache Kafka performance tuning - virtual memory handling, memory maps, file descriptors, and networking optimizations.
- [Apache Kafka listeners](https://canonical.com/data/kafka/docs/4/reference/listeners/index.html.md): Charmed Apache Kafka listeners reference - internal and client listener protocols, ports, and endpoint configurations.
- [Requirements](https://canonical.com/data/kafka/docs/4/reference/requirements/index.html.md): Charmed Apache Kafka system requirements - Juju version, recommended hardware, storage, memory, CPU, and supported architectures.
- [Command-line utilities](https://canonical.com/data/kafka/docs/4/reference/cli-utilities/index.html.md): Charmed Apache Kafka command-line utilities on machines and Kubernetes, including snap commands and container scripts.
- [Terraform module reference](https://canonical.com/data/kafka/docs/4/reference/terraform/index.html.md): Reference for the Charmed Apache Kafka Terraform module - input variables and outputs.
- [Releases](https://canonical.com/data/kafka/docs/4/reference/release-notes/index.html.md): Release notes are organised by deployment substrate.
- [Kubernetes releases](https://canonical.com/data/kafka/docs/4/reference/release-notes/k8s/index.html.md): Release notes for Charmed Apache Kafka on Kubernetes.
- [Revision 56/51](https://canonical.com/data/kafka/docs/4/reference/release-notes/k8s/revision-56-51/index.html.md): Kubernetes revision 56/51 release notes for Charmed Apache Kafka and ZooKeeper.
- [Revision 82](https://canonical.com/data/kafka/docs/4/reference/release-notes/k8s/revision-82/index.html.md): Kubernetes revision 82 release notes with Kafka 3.9, KRaft, Cruise Control, and Karapace support.
- [Machine releases](https://canonical.com/data/kafka/docs/4/reference/release-notes/machine/index.html.md): Release notes for Charmed Apache Kafka on machines and virtual machines.
- [Revision 248](https://canonical.com/data/kafka/docs/4/reference/release-notes/machine/revision-248/index.html.md): Charmed Apache Kafka revision 248 release notes - Upgraded Apache Kafka to 4.1.1, Cruise Control, Karapace, Kafka Connect and Kafka UI stable releases, removed Apache ZooKeeper.
- [Actions](https://canonical.com/data/kafka/docs/4/reference/_generated/actions/index.html.md): Charmed Apache Kafka actions reference - complete list of juju actions with parameters, types, and defaults.
- [Charm statuses](https://canonical.com/data/kafka/docs/4/reference/_generated/statuses/index.html.md): Charmed Apache Kafka charm statuses reference - complete guide to Juju application statuses, messages, and troubleshooting actions.
- [Configurations](https://canonical.com/data/kafka/docs/4/reference/_generated/configurations/index.html.md): Charmed Apache Kafka configuration options reference - types, defaults, and descriptions for all config options.
- [1. Set up the environment](https://canonical.com/data/kafka/docs/4/tutorial/environment/index.html.md): Set up your development environment for Charmed Apache Kafka using LXD, Juju, and command-line tools on Ubuntu.
- [3. Integrate with client applications](https://canonical.com/data/kafka/docs/4/tutorial/integrate-with-client-applications/index.html.md): Connect client applications to Charmed Apache Kafka using Data Integrator charm - automatic user management and credential rotation.
- [Tutorial](https://canonical.com/data/kafka/docs/4/tutorial/index.html.md): Step-by-step tutorial for deploying and managing Charmed Apache Kafka - from environment setup to encryption, ETL, and cluster rebalancing.
- [2. Deploy Apache Kafka](https://canonical.com/data/kafka/docs/4/tutorial/deploy/index.html.md): Deploy Charmed Apache Kafka clusters with KRaft controllers using Juju - complete guide for broker and controller deployment.
- [5. Enable encryption](https://canonical.com/data/kafka/docs/4/tutorial/enable-encryption/index.html.md): Enable TLS encryption for Charmed Apache Kafka using self-signed certificates - secure data transmission across your cluster.
- [8. Cleanup your environment](https://canonical.com/data/kafka/docs/4/tutorial/cleanup/index.html.md): Clean up your Charmed Apache Kafka tutorial environment - remove deployments, Juju controllers, and free system resources.
- [7. Rebalance and reassign partitions](https://canonical.com/data/kafka/docs/4/tutorial/rebalance-partitions/index.html.md): Rebalance Charmed Apache Kafka partitions using Cruise Control - optimize resource distribution when scaling brokers.
- [4. Manage passwords](https://canonical.com/data/kafka/docs/4/tutorial/manage-passwords/index.html.md): Manage and rotate passwords for Charmed Apache Kafka admin users and external users using Juju secrets and actions.
- [Tutorial](https://canonical.com/data/kafka/docs/4/tutorial/introduction/index.html.md): Learn to deploy and manage Charmed Apache Kafka - automated operations from Day 0 to Day 2, including replication, SSL encryption, and Kafka Connect.
- [6. Use Kafka Connect for ETL](https://canonical.com/data/kafka/docs/4/tutorial/use-kafka-connect/index.html.md): Use Kafka Connect for ETL workloads - move data between PostgreSQL and OpenSearch using charmed Apache Kafka.
- [Explanation](https://canonical.com/data/kafka/docs/4/explanation/index.html.md): Understand Charmed Apache Kafka concepts - security, cryptography, backups, MirrorMaker replication, and architectural explanations.
- [Security](https://canonical.com/data/kafka/docs/4/explanation/security/index.html.md): Security overview for Charmed Apache Kafka deployments - environment hardening, Juju security, cloud credentials, and authentication.
- [Cryptography](https://canonical.com/data/kafka/docs/4/explanation/cryptography/index.html.md): Cryptography in Charmed Apache Kafka - resource checksums, source verification, encryption, and authentication protocols.
- [Components](https://canonical.com/data/kafka/docs/4/explanation/components/index.html.md): Overview of Charmed Apache Kafka components - brokers, KRaft controllers, Cruise Control, Kafka Connect, integrator charms, Karapace, Kafka UI, Data Integrator, and Terraform modules.
- [Trademarks](https://canonical.com/data/kafka/docs/4/explanation/trademarks/index.html.md): Apache Kafka trademarks and terminology - official trademark information and usage guidelines.
- [MirrorMaker 2.0 overview](https://canonical.com/data/kafka/docs/4/explanation/mirrormaker2-0/index.html.md): MirrorMaker 2.0 overview - Kafka Connect connectors for cluster replication, topic mirroring, and offset synchronization.
- [Backups](https://canonical.com/data/kafka/docs/4/explanation/backups/index.html.md): Apache Kafka backups explained - what replication does and does not protect against, and how to plan recovery for Charmed Apache Kafka.

---

For more comprehensive documentation, see [llms-full.txt](https://canonical.com/data/kafka/docs/4/llms-full.txt)