whatisgithub

What is siphon?

cinpol/siphon — explained in plain English

Analysis updated 2026-05-18

36GoAudience · ops devopsComplexity · 4/5LicenseSetup · moderate

In one sentence

A keyboard driven terminal dashboard for managing and monitoring Ceph storage clusters without memorizing long commands.

Mindmap

mindmap
  root((siphon))
    What it does
      Live cluster dashboard
      Manage disks and pools
      Confirms destructive actions
      Shows underlying commands
    Tech stack
      Go
      librados
      Ceph
    Use cases
      Cluster health monitoring
      Storage disk management
      Learning Ceph commands safely
    Audience
      Ops devops
      Developers
      Sysadmins

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

What do people build with it?

USE CASE 1

Monitor a Ceph cluster's health, capacity, and IO activity from a live terminal dashboard.

USE CASE 2

Mark storage disks in or out of service and manage storage pools with keyboard shortcuts.

USE CASE 3

Preview the exact Ceph command an action will run before confirming a destructive change.

USE CASE 4

Try out cluster management workflows safely using the built in mock cluster mode.

What is it built with?

GoCephlibradosDocker

How does it compare?

cinpol/siphonduckbugio/flockninehills/pdf2md
Stars363636
LanguageGoGoGo
Setup difficultymoderatehardhard
Complexity4/54/54/5
Audienceops devopsdeveloperdeveloper

Figures from each repo's GitHub metadata at analysis time.

How do you get it running?

Difficulty · moderate Time to first run · 30min

Requires a running Ceph cluster and Linux, or a Docker container, to manage anything real, only the mock mode works without infrastructure.

Use freely for any purpose, including commercial use, as long as you keep the copyright and license notices and note any changes you make.

So what is it?

This project is a keyboard controlled dashboard for managing Ceph, which is a system that clusters many computers together into one big storage pool used for cloud storage. Instead of typing long Ceph commands in a terminal and remembering exact flags, you get an interactive text based screen where you can browse your storage cluster, check its health, and make common changes with a few keystrokes. It shows a live dashboard with cluster health, how much storage capacity is used, and current read and write activity. From there you can look at individual storage disks and mark them in or out of service, adjust pools of storage, view the rules that decide where data gets placed, and manage the background services that keep the cluster running. Every action you take in the tool shows you the exact underlying command it is about to run, and anything destructive always asks for confirmation first, so nothing happens by accident. Because this tool talks directly to a real Ceph cluster using a low level storage library, it currently only runs on Linux, though a container image is available that can also run on Apple Silicon Macs to reach a real cluster remotely. If you do not have a Ceph cluster to test against, there is also a built in mock mode that simulates a fake cluster, which works on any operating system and is useful for trying the interface out or building new features. Installation options include downloading a ready made binary for Linux, building it yourself from the Go source code, or running it as a Docker container, with extra guidance provided for Kubernetes and Rook based Ceph setups. It supports the current Ceph release lines known as Reef, Squid, and Tentacle. The project was previously called Argonaut before being renamed to avoid confusion with an unrelated older Ceph release of the same name. It is released under the Apache 2.0 license.

Copy-paste prompts

Prompt 1
Help me install Siphon and connect it to my existing Ceph cluster on Linux.
Prompt 2
Explain how to use Siphon's mock client mode to try the interface without a real cluster.
Prompt 3
Show me how to reweight or remove an OSD disk safely using Siphon's keyboard shortcuts.
Prompt 4
Walk me through running Siphon inside Docker against a remote Ceph cluster.

Frequently asked questions

What is siphon?

A keyboard driven terminal dashboard for managing and monitoring Ceph storage clusters without memorizing long commands.

What language is siphon written in?

Mainly Go. The stack also includes Go, Ceph, librados.

What license does siphon use?

Use freely for any purpose, including commercial use, as long as you keep the copyright and license notices and note any changes you make.

How hard is siphon to set up?

Setup difficulty is rated moderate, with roughly 30min to a first successful run.

Who is siphon for?

Mainly ops devops.

Open on GitHub → Ask about another repo

This repo across BitVibe Labs

Verify against the repo before relying on details.