Skip to content

Commit

Permalink
Updated readme.md (#458)
Browse files Browse the repository at this point in the history
# Description
Updated README

Fixes #NIL

## Type of change

Please delete options that are not relevant.
- [X] Documentation update (Doc only change)

## How Has This Been Tested?
Doc only change

## Contributor's Checklist

Please check that you have:

- [X] self-reviewed the code in this PR.
- [ ] added code comments, particularly in hard-to-understand areas.
- [ ] updated the user documentation with corresponding changes.
- [ ] added tests to verify effectiveness of this change.

Signed-off-by: utkarsh bhatt <utkarsh.bhatt@canonical.com>
  • Loading branch information
UtkarshBhatthere authored Nov 11, 2024
1 parent ad8b261 commit c9f3f46
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@

* [💡 Philosophy](#-philosophy)
* [🎯 Features](#-features)
* [️Quickstart](#%EF%B8%8Fquickstart)
* [️ Quickstart](#%EF%B8%8Fquickstart)
* [📖 Documentation](#-documentation)
* [💫 Project & community](#-project--community)
* [📰 License](#-license)
Expand All @@ -35,23 +35,24 @@ easy as a [Snap][snap-microceph]!
* Isolated from the host and upgrade-friendly
* Built-in clustering so you don't have to worry about it!

## ️Quickstart
## ️ 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 install microceph
sudo snap refresh --hold microceph
sudo microceph cluster bootstrap
sudo microceph disk add loop,4G,3
sudo ceph status

You're done!
You're done! Check Ceph status:

sudo ceph status

You can remove everything cleanly with:

sudo snap remove microceph
sudo snap remove microceph --purge

## 📖 Documentation

Expand Down

0 comments on commit c9f3f46

Please sign in to comment.