{"id":13644270,"url":"https://github.com/canonical/microceph","last_synced_at":"2025-04-21T07:30:43.512Z","repository":{"id":61679719,"uuid":"306091767","full_name":"canonical/microceph","owner":"canonical","description":"MicroCeph is snap-deployed Ceph with built-in clustering","archived":false,"fork":false,"pushed_at":"2025-04-17T08:41:42.000Z","size":2448,"stargazers_count":255,"open_issues_count":99,"forks_count":43,"subscribers_count":17,"default_branch":"main","last_synced_at":"2025-04-17T23:49:14.372Z","etag":null,"topics":["block","ceph","cloud","cluster","filesystem","micro","object","storage"],"latest_commit_sha":null,"homepage":"https://snapcraft.io/microceph","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/canonical.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"COPYING","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-10-21T16:59:01.000Z","updated_at":"2025-04-17T08:41:48.000Z","dependencies_parsed_at":"2024-03-12T17:01:08.607Z","dependency_job_id":"b69d6f3f-2ce0-4048-afbc-ea4624ca3a6c","html_url":"https://github.com/canonical/microceph","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/canonical%2Fmicroceph","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/canonical%2Fmicroceph/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/canonical%2Fmicroceph/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/canonical%2Fmicroceph/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/canonical","download_url":"https://codeload.github.com/canonical/microceph/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250014561,"owners_count":21360972,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["block","ceph","cloud","cluster","filesystem","micro","object","storage"],"created_at":"2024-08-02T01:02:00.234Z","updated_at":"2025-04-21T07:30:43.498Z","avatar_url":"https://github.com/canonical.png","language":"Go","readme":"# MicroCeph\n\n[![microceph](https://snapcraft.io/microceph/badge.svg)](https://snapcraft.io/microceph)\n[![microceph](https://snapcraft.io/microceph/trending.svg?name=0)](https://snapcraft.io/microceph)\n[![Go Report Card](https://goreportcard.com/badge/github.com/canonical/microceph/microceph)](https://goreportcard.com/report/github.com/canonical/microceph/microceph)\n[![Documentation Status](https://readthedocs.com/projects/canonical-microceph/badge/?version=latest)](https://canonical-microceph.readthedocs-hosted.com/en/latest/?badge=latest)\n\n[![Get it from the Snap Store][snap-button]][snap-microceph]\n\n\nMicroCeph is an opinionated orchestration tool for Ceph clusters at all scales.\nIt reduces the complexity of deploying and managing clusters by simplifying various operations like, service placement,\ndisk administration and remote replication via RESTful APIs and CLI commands.\n\nAvailable as a snap, MicroCeph is the easiest tool for administrators, developers, and hobbyists to manage Ceph clusters.\n\n## Installation\n\nMicroCeph is delivered as a snap. On [snap-ready systems][snap-ready], you can install it on the command line with:\n\n```\nsudo snap install microceph\n```\n\nDisable automatic snap upgrades, so that no unexpected updates change your set-up:\n\n```\nsudo snap refresh --hold microceph\n```\n\n## Basic usage\n\nMicroCeph can deploy a Ceph cluster on a single machine with minimal commands.\n\nFirst, initialise a Ceph cluster on your machine with:\n\n```\nsudo microceph cluster bootstrap\n```\n\n\u003e [!NOTE]  \n\u003e `cluster` is a MicroCeph subcommand for managing associated Ceph clusters.\n\nAfter bootstrap, add storage to your cluster with:\n\n```\nsudo microceph disk add loop,4G,3\n```\n\nHere, you’ll add three virtual disks (“loop file” disks) of 4 GiB each. Make sure that your root disk has 12 GiB of free storage space.\n\nNote that there are no spaces between the `disk add` arguments.\n\nOnce your cluster is set up and running, you can monitor its status with:\n\n```\nsudo microceph status\n```\n\nIf you need a comprehensive status report of your cluster, including its health and disk usage, run:\n\n```\nsudo ceph status\n```\n\u003e [!NOTE]\n\u003e MicroCeph supports the usage of Ceph native tooling where snap-level commands are not yet available.\n\n## Documentation\n\nThe [MicroCeph documentation][rtd-microceph] contains guides and learning material about\nwhat you can do with MicroCeph and how it works.\n\nDocumentation is maintained in the [`docs`][docs-dir-microceph] directory of this repository.\nIt is written in reStructuredTest (reST) format, built with Sphinx, and published on [Read the Docs][rtd]. \n\n## Project and Community\n\nMicroCeph is a member of the Ubuntu family. It's an open-source project that warmly welcomes community contributions,\nsuggestions, fixes, and constructive feedback.\n\nIf you find any errors or have suggestions for improvements, please [open an issue on GitHub][bug-microceph].\n\n[Join our Matrix forum][matrix-microceph] to engage with our community and get support.\n\nWe abide by the [Ubuntu Code of Conduct][ubuntu-coc].\n\nExcited about MicroCeph? See [who else is a fan][stargazers-microceph].\n\n## Contribute to MicroCeph\n\nMicroCeph is growing rapidly, and we would love your help.\n\nIf you are interested in contributing to our code or documentation, our [contribution guide][contrib-microceph]\nis the best place to start.\n\nWe are also a proud member of the [Canonical Open Documentation Academy][coda], an initiative aimed at lowering the\nbarrier to open-source software contributions through documentation. Find a wide range of MicroCeph documentation tasks there.\n\n## License and copyright\n\nMicroCeph is a free and open source software distributed under the [AGPLv3.0 license][license-microceph].\n\n© 2025 Canonical Ltd.\n\n\u003c!-- LINKS --\u003e\n\n[snap-button]: https://snapcraft.io/static/images/badges/en/snap-store-black.svg\n[snap-microceph]: https://snapcraft.io/microceph\n[rtd-microceph]: https://canonical-microceph.readthedocs-hosted.com/en/latest/\n[docs-dir-microceph]: https://github.com/canonical/microceph/tree/main/docs\n[contrib-microceph]: ./CONTRIBUTING.md\n[license-microceph]: ./COPYING\n[ubuntu-coc]: https://ubuntu.com/community/ethos/code-of-conduct\n[bug-microceph]: https://github.com/canonical/microceph/issues/new\n[stargazers-microceph]: https://github.com/canonical/microceph/stargazers\n[matrix-microceph]: https://matrix.to/#/#ubuntu-ceph:matrix.org\n[coda]: https://documentationacademy.org/\n[snap-ready]: https://snapcraft.io/docs/installing-snapd/\n[rtd]: https://about.readthedocs.com/","funding_links":[],"categories":["Go"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcanonical%2Fmicroceph","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcanonical%2Fmicroceph","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcanonical%2Fmicroceph/lists"}