Skip to content

canonical/microceph

Folders and files

NameName
Last commit message
Last commit date
Feb 11, 2025
Apr 25, 2023
Feb 21, 2025
Mar 11, 2025
Jan 28, 2025
Jan 28, 2025
Feb 10, 2025
Aug 20, 2024
Sep 5, 2023
Oct 25, 2023
May 13, 2022
Jan 16, 2025
Nov 11, 2024
Oct 16, 2023
Feb 17, 2023

Repository files navigation

MicroCeph

microceph microceph Go Report Card Documentation Status

MicroCeph is snap-deployed Ceph with built-in clustering.

Get it from the Snap Store

Table of contents

πŸ’‘ Philosophy

Deploying and operating a Ceph cluster is complex because Ceph is designed to be a general-purpose storage solution. This is a significant overhead for small Ceph clusters. MicroCeph solves this by being opinionated and focused on the small scale. With MicroCeph, deploying and operating a Ceph cluster is as easy as a Snap!

🎯 Features

  • Quick and consistent deployment with minimal overhead
  • Single-command operations (for bootstrapping, adding OSDs, service enablement, etc)
  • Isolated from the host and upgrade-friendly
  • Built-in clustering so you don't have to worry about it!

⚑️ Quickstart

The below commands will set you up with a testing environment on a single machine using file-backed OSDs - you'll need about 15 GiB of available space on your root drive:

sudo snap install microceph 
sudo snap refresh --hold microceph
sudo microceph cluster bootstrap
sudo microceph disk add loop,4G,3

You're done! Check Ceph status:

sudo ceph status

You can remove everything cleanly with:

sudo snap remove microceph --purge

πŸ“– Documentation

The documentation is found in the docs directory. It is written in RST format, built with Sphinx, and published on Read The Docs:

MicroCeph documentation

πŸ’« Project & community

Excited about MicroCeph? Become one of our Stargazers!

πŸ“° License

MicroCeph is free software, distributed under the AGPLv3 license (GNU Affero General Public License version 3.0). Refer to the COPYING file (the actual license) for more information.