# netbox-ceph

NetBox plugin for Ceph — maps clusters, OSDs, storage pools, monitors, and CRUSH topology into NetBox DCIM.

| Field |Value |
| --- | --- |
| Canonical URL | https://emersonfelipesp.com/netbox-ceph |
| GitHub | https://github.com/emersonfelipesp/netbox-ceph |
| Developer guide | https://emersonfelipesp.com/netbox-ceph/developer |
| Roadmap | https://emersonfelipesp.com/netbox-ceph/roadmap |
| Releases | https://emersonfelipesp.com/netbox-ceph/releases |
| Stars | 0 |
| Forks | 0 |
| Latest release | v0.0.1 |

## Overview

netbox-ceph integrates Ceph distributed storage clusters into NetBox, giving your DCIM complete visibility into your storage infrastructure alongside the servers and VMs it backs.

OSDs, storage pools, monitors, and CRUSH rules are discovered and linked to physical hosts and Proxmox clusters already managed in NetBox.

## Features

- Ceph cluster health and status tracking in NetBox
- OSD inventory with device mapping to physical hosts
- Storage pool modeling: replication factor, usage, PGs
- Monitor and manager daemon visibility
- CRUSH rule and failure domain documentation
- Links Ceph objects to existing DCIM host records
- Read-only discovery — never mutates Ceph resources
- REST API for all plugin models

## Stack

- NetBox plugin (Django / Python 3.12+)
- Ceph REST API / `ceph` CLI integration
- Proxmox Ceph API (optional, for Proxmox-hosted clusters)

## Install

Primary command:

```shell
pip install netbox-ceph
```

Requires access to a Ceph cluster via REST API or admin socket.

## Links

| Label |URL |
| --- | --- |
| repo | https://github.com/emersonfelipesp/netbox-ceph |
| Ceph Documentation | https://docs.ceph.com/ |
| netbox-proxbox | https://emersonfelipesp.com/netbox-proxbox |