Charmed Kafka Documentation

charm
, ,
1

Charmed Kafka documentation

Charmed Kafka is an open-source operator that makes it easier to manage Apache Kafka, with built-in support for enterprise features.

Apache Kafka is a free, open source software project by the Apache Software Foundation. Users can find out more at the Kafka project page.

Charmed Kafka is built on top of Juju and reliably simplifies the deployment, scaling, design, and management of Apache Kafka in production. Additionally, you can use the charm to manage your Kafka clusters with automation capabilities. It also offers replication, TLS, password rotation, easy-to-use application integration, and monitoring. Charmed Kafka operates Apache Kafka on physical systems, Virtual Machines (VM), and a wide range of cloud and cloud-like environments, including AWS, Azure, OpenStack, and VMware.

Charmed Kafka is a solution designed and developed to help ops teams and administrators automate Apache Kafka operations from Day 0 to Day 2, across multiple cloud environments and platforms.

Canonical has also developed the Charmed Kafka K8s operator to support Kafka in Kubernetes environments.

Charmed Kafka is developed and supported by Canonical, as part of its commitment to provide open-source, self-driving solutions, seamlessly integrated using the Operator Framework Juju. Please refer to Charmhub, for more charmed operators that can be integrated by Juju.

In this documentation
Tutorials
Get started - a hands-on introduction to using Charmed Kafka operator for new users
How-to guides
Step-by-step guides covering key operations and common tasks
Reference
Technical information - specifications, APIs, architecture		 Explanation
Concepts - discussion and clarification of key topics

Project and community

Charmed Kafka 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 Kafka logo are either registered trademarks or trademarks of the Apache Software Foundation in the United States and/or other countries.

License

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

Navigation

Level Path Navlink
1 tutorial Tutorial
2 t-overview 1. Introduction
2 t-setup-environment 2. Set up the environment
2 t-deploy 3. Deploy Kafka
2 t-relate-kafka 4. Integrate with client applications
2 t-manage-passwords 5. Manage passwords
2 t-enable-encryption 6. Enable Encryption
2 t-cleanup-environment 7. Cleanup your environment
1 how-to How To
2 h-deploy Deploy
2 h-deploy-aws Deploy on AWS
2 h-deploy-azure Deploy on Azure
2 h-manage-units Manage units
2 h-manage-app Manage applications
2 h-enable-encryption Enable encryption
2 h-upgrade Upgrade
2 h-enable-monitoring Enable Monitoring
2 h-integrate-alerts-dashboards Integrate alerts and dashboards
2 h-cluster-migration Migrate a cluster
2 h-create-mtls-client-credentials Create mTLS Client Credentials
2 h-enable-oauth Enable Oauth through Hydra
2 h-backup-restore-configuration Backup and restore configuration
1 reference Reference
2 r-releases Release Notes
3 r-rev156_126 Revision 156/126
3 r-rev156_136 Revision 156/136
2 r-actions Actions
2 r-configurations Configurations
2 r-libraries Libraries
2 r-file-system-paths File System Paths
2 r-snap-entrypoints Snap Entrypoints
2 r-listeners Kafka Listeners
2 r-statuses Statuses
2 r-requirements Requirements
2 r-performance-tuning Performance Tuning
2 r-contacts Contact
1 explanation Explanation
2 e-security Security
2 e-hardening Hardening Guide
2 e-cluster-configuration Overview of Cluster Configuration

Redirects

Mapping table
Path Location
2

Same issue with links as in kafka-k8s