Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/canonical/microceph
Ceph for a one-rack cluster and appliances
https://github.com/canonical/microceph
ceph cluster hacktoberfest
Last synced: about 1 month ago
JSON representation
Ceph for a one-rack cluster and appliances
- Host: GitHub
- URL: https://github.com/canonical/microceph
- Owner: canonical
- License: agpl-3.0
- Created: 2020-10-21T16:59:01.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-05-27T07:59:43.000Z (7 months ago)
- Last Synced: 2024-05-28T19:22:12.093Z (7 months ago)
- Topics: ceph, cluster, hacktoberfest
- Language: Go
- Homepage: https://snapcraft.io/microceph
- Size: 1.92 MB
- Stars: 182
- Watchers: 20
- Forks: 25
- Open Issues: 52
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: COPYING
Awesome Lists containing this project
- awesome-repositories - canonical/microceph - MicroCeph is snap-deployed Ceph with built-in clustering (Go)
README
# MicroCeph
[](https://snapcraft.io/microceph)
[](https://snapcraft.io/microceph)
[](https://goreportcard.com/report/github.com/canonical/microceph/microceph)
[](https://canonical-microceph.readthedocs-hosted.com/en/latest/?badge=latest)
MicroCeph is snap-deployed Ceph with built-in clustering.
[![Get it from the Snap Store][snap-button]][snap-microceph]
## Table of contents
* [💡 Philosophy](#-philosophy)
* [🎯 Features](#-features)
* [⚡️Quickstart](#%EF%B8%8Fquickstart)
* [📖 Documentation](#-documentation)
* [💫 Project & community](#-project--community)
* [📰 License](#-license)
## 💡 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][snap-microceph]!
## 🎯 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`][docs-dir-microceph] directory. It is
written in RST format, built with Sphinx, and published on Read The Docs:
[MicroCeph documentation][rtd-microceph]
## 💫 Project & community
* [Join our online forum][matrix-microceph] - **Ubuntu Ceph** on Matrix
* [Contributing guidelines][contrib-microceph]
* [Code of conduct][ubuntu-coc]
* [File a bug][bug-microceph]
Excited about MicroCeph? Become one of our [Stargazers][stargazers-microceph]!
## 📰 License
MicroCeph is free software, distributed under the AGPLv3 license (GNU Affero
General Public License version 3.0). Refer to the [COPYING][license-microceph]
file (the actual license) for more information.
[snap-button]: https://snapcraft.io/static/images/badges/en/snap-store-black.svg
[snap-microceph]: https://snapcraft.io/microceph
[rtd-microceph]: https://canonical-microceph.readthedocs-hosted.com/
[docs-dir-microceph]: https://github.com/canonical/microceph/tree/main/docs
[contrib-microceph]: ./CONTRIBUTING.md
[license-microceph]: ./COPYING
[ubuntu-coc]: https://ubuntu.com/community/ethos/code-of-conduct
[bug-microceph]: https://github.com/canonical/microceph/issues/new
[stargazers-microceph]: https://github.com/canonical/microceph/stargazers
[matrix-microceph]: https://matrix.to/#/#ubuntu-ceph:matrix.org