README.md

AxonOps Ansible Collection - Role Documentation

This directory contains detailed documentation for each role in the AxonOps Ansible Collection.

Available Roles

Core AxonOps Components

agent

Installs and configures the AxonOps Agent on Cassandra nodes for monitoring and metric collection.

Use when: You want to monitor your Cassandra cluster with AxonOps (required on all Cassandra nodes).

server

Installs and configures the AxonOps Server for self-hosted deployments.

Use when: You're deploying AxonOps on-premises instead of using the SaaS offering.

dash

Installs and configures the AxonOps Dashboard web interface.

Use when: You're deploying a self-hosted AxonOps Server and need the web UI (typically installed alongside the server).

alerts

Configures alerts, integrations, and monitoring settings for AxonOps.

Use when: You need to automate the configuration of alerts, Slack/PagerDuty integrations, or backup policies.

Infrastructure Components

cassandra

Installs and configures Apache Cassandra (versions 3.11, 4.x, and 5.x).

Use when: You need to deploy new Cassandra nodes or manage existing installations.

elastic

Installs and configures Elasticsearch for AxonOps Server configuration storage.

Use when: Deploying a self-hosted AxonOps Server (Elasticsearch stores AxonOps configuration data).

java

Installs Java (OpenJDK or Azul Zulu) on target systems.

Use when: Deploying Cassandra, Elasticsearch, or any Java-dependent component.

Utility Roles

preflight

Performs pre-installation checks to ensure systems meet requirements.

Use when: Before deploying Cassandra or AxonOps components to validate system readiness.

Quick Reference

Role	Purpose	Typically Used With
agent	Monitor Cassandra clusters	Cassandra nodes
server	Self-hosted AxonOps backend	Elastic, Cassandra (optional)
dash	Web UI for AxonOps	Server
alerts	Alert configuration	Server
cassandra	Apache Cassandra installation	Agent, Java
elastic	Elasticsearch installation	Server
java	Java installation	Cassandra, Elastic
preflight	System validation	Before any installation

Common Deployment Patterns

Pattern 1: Monitor Existing Cassandra Cluster (SaaS)

Deploy AxonOps Agent on existing Cassandra nodes to monitor with AxonOps SaaS:

- hosts: cassandra
  roles:
    - agent

Roles needed: agent

See: agent.md

---

Pattern 2: New Cassandra Cluster with Monitoring (SaaS)

Deploy new Cassandra cluster with AxonOps monitoring:

- hosts: cassandra
  roles:
    - preflight
    - java
    - agent
    - cassandra

Roles needed: preflight, java, agent, cassandra

See: cassandra.md, agent.md, java.md, preflight.md

---

Pattern 3: Self-Hosted AxonOps Server

Deploy complete self-hosted AxonOps stack:

- hosts: axon-server
  roles:
    - java
    - elastic
    - cassandra  # Optional: for metrics storage
    - server
    - dash

Roles needed: java, elastic, server, dash, optionally cassandra

See: server.md, elastic.md, dash.md

---

Pattern 4: Complete Infrastructure

Deploy both AxonOps Server and monitored Cassandra cluster:

Server host:

- hosts: axon-server
  roles:
    - java
    - elastic
    - cassandra
    - agent
    - server
    - dash

Cassandra hosts:

- hosts: cassandra
  roles:
    - preflight
    - java
    - agent
    - cassandra

Roles needed: All roles

---

Pattern 5: Alert Configuration

Configure alerts and integrations for existing AxonOps deployment:

- hosts: localhost
  roles:
    - alerts

Roles needed: alerts

See: alerts.md

Getting Started

1. Choose your deployment pattern from the list above
2. Read the documentation for each role you'll use
3. Review the example playbooks in each role's documentation
4. Customize variables to match your environment
5. Run preflight checks before deploying Cassandra
6. Deploy in stages (infrastructure first, then applications, then configuration)

Additional Resources

• Main README - Collection overview and installation
• Examples Directory - Complete example playbooks
• AxonOps Documentation - Official AxonOps documentation
• ALERTS.md - Alert configuration guide

Support

For issues, questions, or contributions:

• GitHub Issues: axonops-ansible-collection
• AxonOps Support: support@axonops.com
• Community Slack: axonops.slack.com

License

See the LICENSE file in the repository root.