How-to guides

The following guides cover key processes and common tasks for Charmed Apache Kafka. If you are missing a particular how-to guide, feel free to leave us feedback via button above, or get in touch directly.

Deployment

Deployment follows a broadly similar pattern on VM and Kubernetes, with substrate-specific commands shown in synchronized tabs.

• Deployment methods:

  • via Juju CLI

  • via Terraform

• Specific deployment guides:

  • AWS

  • Azure

  • External connections (Kubernetes)

  • Juju Spaces (Machine)

Management

For guidance on managing your deployed Charmed Apache Kafka, see:

• How to manage units

• How to manage client connections

• How to upgrade

• How to use Kafka UI

Security

We have a series of How-to guides for security-related topics:

• TLS encryption

• Create mTLS credentials

See also: our security overview page.

Monitoring

Monitoring Charmed Apache Kafka is typically done with the Canonical Observability Stack. See our How to set up monitoring guide for the following topics:

• Enable monitoring

• Add custom alerts and dashboards

Cluster replication and migration

Both migrating and replicating Apache Kafka cluster can be done with MirrorMaker 2. See the guides for more details:

• Cluster migration

• Replication

Advanced

Advanced features of Charmed Apache Kafka include:

• Schemas and serialisation

• Kafka Connect usage

• Enable OAuth through Canonical Identity Platform (Machine)