# netbox-ceph

Read-only NetBox plugin for Proxmox-managed Ceph inventory through proxbox-api.

| 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 | 1 |
| Forks | 0 |
| Latest release | v0.0.1 |

## Overview

netbox-ceph v0.0.1 mirrors Proxmox-managed Ceph inventory through proxbox-api.

It reuses netbox-proxbox backend context, branch lifecycle, endpoint relationships, and job conventions without writing back to Ceph.

## Features

- Read-only Proxmox-managed Ceph inventory
- Shared netbox-proxbox backend context and endpoint relationships
- Shared branch lifecycle and job conventions
- No NetBox-to-Ceph write operations
- Direct Ceph Dashboard, Prometheus, RGW/S3, RBD, and external clusters remain out of scope

## Stack

- NetBox plugin (Django / Python 3.12+)
- proxbox-api Proxmox Ceph surface
- netbox-proxbox >=0.0.16

## Install

Primary command:

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

Requires netbox-proxbox and a proxbox-api backend with Proxmox-managed Ceph access.

## Links

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