# anish-anish/awx architecture

> Architecture diagram of the GitHub repository anish-anish/awx, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-02). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/anish-anish/awx
- Repository: https://github.com/anish-anish/awx

## Overview

AWX is an Ansible automation controller: users manage automation through its web UI or REST API, then submit work for scheduling and execution. Its domain includes inventories, projects, job templates and jobs, workflows, access control, and notifications; supporting layers handle configuration and analytics. The README documents the UI, API, and task engine, while source-index references and excerpts clarify selected API, model, scheduler, and integration links. Many domain modules were not sampled, so their internal connections are omitted rather than inferred.

Main entry points: [`awx/api/generics.py`](https://github.com/anish-anish/awx/blob/devel/awx/api/generics.py) (REST API), [`awx/main/scheduler/task_manager.py`](https://github.com/anish-anish/awx/blob/devel/awx/main/scheduler/task_manager.py) (Task manager), [`awx/main/tasks/jobs.py`](https://github.com/anish-anish/awx/blob/devel/awx/main/tasks/jobs.py) (Job execution), [`awx/main/models/jobs.py`](https://github.com/anish-anish/awx/blob/devel/awx/main/models/jobs.py) (Jobs and templates)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_interfaces["User interfaces"]
  node_ui["Web UI<br/>[urls.py]"]
  node_api["REST API<br/>[generics.py]"]
  node_serializers["API serializers<br/>[serializers.py]"]
  node_awxkit["AWX client<br/>[client.py]"]
  node_collection["Ansible collection<br/>[controller_api.py]"]
end

subgraph group_domain["Automation domain"]
  node_inventory[("Inventory<br/>[inventory.py]")]
  node_projects[("Projects<br/>[projects.py]")]
  node_jobs[("Jobs and templates<br/>[jobs.py]")]
  node_workflows[("Workflow jobs<br/>[workflow.py]")]
  node_rbac[("Access control<br/>[rbac.py]")]
  node_schedules[("Schedules<br/>[schedules.py]")]
  node_webhooks["Webhook receiver<br/>[webhooks.py]"]
end

subgraph group_runtime["Execution runtime"]
  node_taskmanager["Task manager<br/>[task_manager.py]"]
  node_capacity["Capacity model"]
  node_workflowmanager["Workflow manager<br/>[task_manager.py]"]
  node_jobexecution["Job execution<br/>[jobs.py]"]
  node_dispatch["Task dispatch<br/>[task.py]"]
end

subgraph group_platform["Platform services"]
  node_notifications["Notifications"]
  node_configuration["Configuration<br/>[settings.py]"]
  node_analytics["Analytics and metrics"]
end

node_user(("AWX user"))
node_ansible(("Ansible"))
node_database[("AWX database")]

node_user -->|"uses"| node_ui
node_user -->|"uses"| node_api
node_api -->|"uses"| node_serializers
node_serializers -->|"serializes"| node_inventory
node_serializers -->|"serializes"| node_jobs
node_api -->|"checks access"| node_rbac
node_awxkit -.->|"calls"| node_api
node_collection -.->|"calls"| node_api
node_webhooks -->|"triggers job"| node_jobs
node_taskmanager -->|"models capacity"| node_capacity
node_taskmanager -->|"runs"| node_workflowmanager
node_workflowmanager -->|"schedules nodes"| node_workflows
node_workflowmanager -->|"spawns jobs"| node_jobs
node_taskmanager -->|"starts tasks"| node_jobexecution
node_jobexecution -.->|"dispatches"| node_dispatch
node_jobexecution -->|"runs automation"| node_ansible
node_jobs -.->|"stores job state"| node_database
node_inventory -.->|"stores inventory"| node_database
node_projects -.->|"stores project state"| node_database
node_schedules -.->|"stores schedules"| node_database
node_jobexecution -.->|"sends notifications"| node_notifications
node_taskmanager -->|"reports metrics"| node_analytics
node_api -.->|"uses settings"| node_configuration

click node_ui "https://github.com/anish-anish/awx/blob/devel/awx/ui/urls.py"
click node_api "https://github.com/anish-anish/awx/blob/devel/awx/api/generics.py"
click node_serializers "https://github.com/anish-anish/awx/blob/devel/awx/api/serializers.py"
click node_awxkit "https://github.com/anish-anish/awx/blob/devel/awxkit/awxkit/api/client.py"
click node_collection "https://github.com/anish-anish/awx/blob/devel/awx_collection/plugins/module_utils/controller_api.py"
click node_inventory "https://github.com/anish-anish/awx/blob/devel/awx/main/models/inventory.py"
click node_projects "https://github.com/anish-anish/awx/blob/devel/awx/main/models/projects.py"
click node_jobs "https://github.com/anish-anish/awx/blob/devel/awx/main/models/jobs.py"
click node_workflows "https://github.com/anish-anish/awx/blob/devel/awx/main/models/workflow.py"
click node_rbac "https://github.com/anish-anish/awx/blob/devel/awx/main/models/rbac.py"
click node_schedules "https://github.com/anish-anish/awx/blob/devel/awx/main/models/schedules.py"
click node_webhooks "https://github.com/anish-anish/awx/blob/devel/awx/api/views/webhooks.py"
click node_taskmanager "https://github.com/anish-anish/awx/blob/devel/awx/main/scheduler/task_manager.py"
click node_capacity "https://github.com/anish-anish/awx/blob/devel/awx/main/scheduler/task_manager_models.py"
click node_workflowmanager "https://github.com/anish-anish/awx/blob/devel/awx/main/scheduler/task_manager.py"
click node_jobexecution "https://github.com/anish-anish/awx/blob/devel/awx/main/tasks/jobs.py"
click node_dispatch "https://github.com/anish-anish/awx/blob/devel/awx/main/dispatch/worker/task.py"
click node_notifications "https://github.com/anish-anish/awx/tree/devel/awx/main/notifications"
click node_configuration "https://github.com/anish-anish/awx/blob/devel/awx/conf/settings.py"
click node_analytics "https://github.com/anish-anish/awx/tree/devel/awx/main/analytics"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_ui,node_api,node_serializers,node_awxkit,node_collection,node_user toneBlue
class node_inventory,node_projects,node_jobs,node_workflows,node_rbac,node_schedules,node_webhooks,node_database toneAmber
class node_taskmanager,node_capacity,node_workflowmanager,node_jobexecution,node_dispatch toneMint
class node_notifications,node_configuration,node_analytics toneRose
class node_ansible toneIndigo
```

## Components

### User interfaces

- [Web UI](https://github.com/anish-anish/awx/blob/devel/awx/ui/urls.py): `awx/ui/urls.py`
- [REST API](https://github.com/anish-anish/awx/blob/devel/awx/api/generics.py): `awx/api/generics.py`
- [API serializers](https://github.com/anish-anish/awx/blob/devel/awx/api/serializers.py): `awx/api/serializers.py`
- [AWX client](https://github.com/anish-anish/awx/blob/devel/awxkit/awxkit/api/client.py): `awxkit/awxkit/api/client.py`
- [Ansible collection](https://github.com/anish-anish/awx/blob/devel/awx_collection/plugins/module_utils/controller_api.py): `awx_collection/plugins/module_utils/controller_api.py`

### Automation domain

- [Inventory](https://github.com/anish-anish/awx/blob/devel/awx/main/models/inventory.py): `awx/main/models/inventory.py`
- [Projects](https://github.com/anish-anish/awx/blob/devel/awx/main/models/projects.py): `awx/main/models/projects.py`
- [Jobs and templates](https://github.com/anish-anish/awx/blob/devel/awx/main/models/jobs.py): `awx/main/models/jobs.py`
- [Workflow jobs](https://github.com/anish-anish/awx/blob/devel/awx/main/models/workflow.py): `awx/main/models/workflow.py`
- [Access control](https://github.com/anish-anish/awx/blob/devel/awx/main/models/rbac.py): `awx/main/models/rbac.py`
- [Schedules](https://github.com/anish-anish/awx/blob/devel/awx/main/models/schedules.py): `awx/main/models/schedules.py`
- [Webhook receiver](https://github.com/anish-anish/awx/blob/devel/awx/api/views/webhooks.py): `awx/api/views/webhooks.py`

### Execution runtime

- [Task manager](https://github.com/anish-anish/awx/blob/devel/awx/main/scheduler/task_manager.py): `awx/main/scheduler/task_manager.py`
- [Capacity model](https://github.com/anish-anish/awx/blob/devel/awx/main/scheduler/task_manager_models.py): `awx/main/scheduler/task_manager_models.py`
- [Workflow manager](https://github.com/anish-anish/awx/blob/devel/awx/main/scheduler/task_manager.py): `awx/main/scheduler/task_manager.py`
- [Job execution](https://github.com/anish-anish/awx/blob/devel/awx/main/tasks/jobs.py): `awx/main/tasks/jobs.py`
- [Task dispatch](https://github.com/anish-anish/awx/blob/devel/awx/main/dispatch/worker/task.py): `awx/main/dispatch/worker/task.py`

### Platform services

- [Notifications](https://github.com/anish-anish/awx/tree/devel/awx/main/notifications): `awx/main/notifications`
- [Configuration](https://github.com/anish-anish/awx/blob/devel/awx/conf/settings.py): `awx/conf/settings.py`
- [Analytics and metrics](https://github.com/anish-anish/awx/tree/devel/awx/main/analytics): `awx/main/analytics`

### Other components

- **AWX user**
- **Ansible**
- **AWX database**

## Connections

- AWX user → Web UI: uses (evidence: `README.md`)
- AWX user → REST API: uses (evidence: `README.md`)
- REST API → API serializers: uses (evidence: `awx/api/generics.py`)
- API serializers → Inventory: serializes (evidence: `awx/api/serializers.py`)
- API serializers → Jobs and templates: serializes (evidence: `awx/api/serializers.py`)
- REST API → Access control: checks access (evidence: `awx/api/generics.py`)
- AWX client → REST API: calls
- Ansible collection → REST API: calls
- Webhook receiver → Jobs and templates: triggers job (evidence: `awx/api/views/webhooks.py`)
- Task manager → Capacity model: models capacity (evidence: `awx/main/scheduler/task_manager.py`)
- Task manager → Workflow manager: runs (evidence: `awx/main/scheduler/task_manager.py`)
- Workflow manager → Workflow jobs: schedules nodes (evidence: `awx/main/scheduler/task_manager.py`)
- Workflow manager → Jobs and templates: spawns jobs (evidence: `awx/main/scheduler/task_manager.py`)
- Task manager → Job execution: starts tasks (evidence: `awx/main/scheduler/task_manager.py`)
- Job execution → Task dispatch: dispatches
- Job execution → Ansible: runs automation (evidence: `README.md`)
- Jobs and templates → AWX database: stores job state
- Inventory → AWX database: stores inventory
- Projects → AWX database: stores project state
- Schedules → AWX database: stores schedules
- Job execution → Notifications: sends notifications
- Task manager → Analytics and metrics: reports metrics (evidence: `awx/main/scheduler/task_manager.py`)
- REST API → Configuration: uses settings
