# Charmed Apache Cassandra

> This is the documentation for Charmed Apache Cassandra, a Juju charm that
> automates the deployment, scaling, configuration and operations of Apache
> Cassandra clusters.


2026

## Pages

- [Charmed Apache Cassandra documentation](https://canonical.com/data/cassandra/docs/latest/index.html.md): Charmed Apache Cassandra - deploy, scale, and manage Apache Cassandra clusters on VMs with the Juju orchestrator. Documentation, guides, and reference.
- [How-to guides](https://canonical.com/data/cassandra/docs/latest/how-to/index.html.md): Charmed Apache Cassandra how-to guides - step-by-step instructions for deploying, scaling, securing, and monitoring Cassandra clusters.
- [How to deploy Charmed Apache Cassandra](https://canonical.com/data/cassandra/docs/latest/how-to/deploy/index.html.md): Deploy Charmed Apache Cassandra on VMs - set up a Juju controller and model, deploy production or testing clusters, and connect with cqlsh.
- [How to set up monitoring](https://canonical.com/data/cassandra/docs/latest/how-to/monitoring/index.html.md): Monitor Charmed Apache Cassandra - integrate with the Canonical Observability Stack for metrics, logs, alert rules, and Grafana dashboards.
- [How to enable TLS encryption](https://canonical.com/data/cassandra/docs/latest/how-to/encryption/index.html.md): Enable TLS encryption for Charmed Apache Cassandra - secure peer-to-peer and client-to-node communication and rotate certificates.
- [How to manage units](https://canonical.com/data/cassandra/docs/latest/how-to/manage-units/index.html.md): Manage Charmed Apache Cassandra units - scale clusters by adding or removing units, verify the topology with nodetool, and recover lost nodes.
- [How to manage passwords](https://canonical.com/data/cassandra/docs/latest/how-to/manage-passwords/index.html.md): Manage Charmed Apache Cassandra passwords - retrieve the operator password and rotate it using Juju secrets.
- [Contact](https://canonical.com/data/cassandra/docs/latest/reference/contact/index.html.md): This charm and its documentation are work in progress (WIP).
- [1. Set up the environment](https://canonical.com/data/cassandra/docs/latest/tutorial/environment/index.html.md): Set up your environment for Charmed Apache Cassandra - install LXD and Juju, bootstrap a controller, and create a model.
- [4. Integrate with a client application](https://canonical.com/data/cassandra/docs/latest/tutorial/integrate-with-client-applications/index.html.md): Integrate a client application with Charmed Apache Cassandra using the Data Integrator charm to generate scoped credentials and a keyspace via a relation.
- [Tutorial](https://canonical.com/data/cassandra/docs/latest/tutorial/index.html.md): Step-by-step tutorial for Charmed Apache Cassandra - bootstrap a controller, deploy a cluster, enable TLS, integrate a client, use cqlsh, and scale.
- [2. Deploy Apache Cassandra](https://canonical.com/data/cassandra/docs/latest/tutorial/deploy/index.html.md): Deploy a Charmed Apache Cassandra cluster with Juju, retrieve the operator password, and connect to the cluster with cqlsh.
- [3. Enable encryption](https://canonical.com/data/cassandra/docs/latest/tutorial/enable-encryption/index.html.md): Enable TLS encryption for Charmed Apache Cassandra using self-signed certificates, and reconnect securely with cqlsh over SSL.
- [7. Clean up your environment](https://canonical.com/data/cassandra/docs/latest/tutorial/cleanup/index.html.md): Safely clean up your Charmed Apache Cassandra tutorial environment - remove the model, and optionally the Juju controller and LXD.
- [6. Scale your cluster](https://canonical.com/data/cassandra/docs/latest/tutorial/scale/index.html.md): Scale a Charmed Apache Cassandra cluster out and in with Juju, and verify with cqlsh that data is replicated to new nodes and preserved on removal.
- [5. Manage data with cqlsh](https://canonical.com/data/cassandra/docs/latest/tutorial/manage-data/index.html.md): Use the cqlsh client to create a keyspace, define a table, and read and write data in a Charmed Apache Cassandra cluster.
- [Tutorial](https://canonical.com/data/cassandra/docs/latest/tutorial/introduction/index.html.md): Learn to deploy and operate Charmed Apache Cassandra - from bootstrapping a controller to enabling TLS, integrating clients, and scaling a cluster.

---

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