Skip to content

UtkarshBhatthere/microceph

 
 

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 --channel quincy/edge
sudo snap refresh --hold microceph
sudo microceph cluster bootstrap
sudo microceph disk add loop,4G,3
sudo ceph status

You're done!

You can remove everything cleanly with:

sudo snap remove microceph

📖 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.

About

Ceph for a one-rack cluster and appliances

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Go 93.3%
  • Shell 6.4%
  • Makefile 0.3%