Skip to content

Commit dc3c5da

Browse files
authored
Update README (#461)
JIRA ticket: https://warthogs.atlassian.net/browse/LXD-2125 * Update logos * Update documentation hyperlinks * Update networking section
2 parents 2bc5afd + 504f09a commit dc3c5da

File tree

3 files changed

+64
-5
lines changed

3 files changed

+64
-5
lines changed

README.md

+11-5
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
<p align="left">
2+
<img alt="MicroCloud logo" width="10%" src="doc/images/microcloud_logo_dark.svg#gh-dark-mode-only">
3+
<img alt="MicroCloud logo" width="10%" src="doc/images/microcloud_logo_light.svg#gh-light-mode-only">
4+
</p>
5+
16
# **MicroCloud**
27

38
**MicroCloud** allows you to deploy your own fully functional cloud in minutes.
@@ -15,10 +20,6 @@ It supports up to 50 machines.
1520
To use local storage, each machine requires a local disk.
1621
To use distributed storage, at least three additional disks (not only partitions) for use by Ceph are required, and these disks must be on at least three different machines.
1722

18-
<p align="center" width="100%">
19-
<img alt="MicroCloud logo" width="33%" src="https://res.cloudinary.com/canonical/image/fetch/f_auto,q_auto,fl_sanitize,w_236,h_214/https://assets.ubuntu.com/v1/904e5156-LXD+illustration+2.svg">
20-
</p>
21-
2223
Once the simple initialisation is complete, users can launch, run and manage their workloads using system containers or VMs, and otherwise utilise regular LXD functionality.
2324

2425
## **How to get started**
@@ -45,7 +46,7 @@ Following the simple CLI prompts, a working MicroCloud will be ready within minu
4546

4647
<!-- include start about -->
4748

48-
The MicroCloud snap drives three other snaps ([LXD](https://documentation.ubuntu.com/lxd), [MicroCeph](https://canonical-microceph.readthedocs-hosted.com/), and [MicroOVN](https://canonical-microovn.readthedocs-hosted.com/)), enabling automated deployment of a highly available LXD cluster for compute with Ceph as the storage driver and OVN as the managed network.
49+
The MicroCloud snap drives three other snaps ([LXD](https://canonical-microcloud.readthedocs-hosted.com/en/latest/lxd/), [MicroCeph](https://canonical-microcloud.readthedocs-hosted.com/en/latest/microceph/), and [MicroOVN](https://canonical-microcloud.readthedocs-hosted.com/en/latest/microovn/)), enabling automated deployment of a highly available LXD cluster for compute, with Ceph as the storage driver and OVN as the managed network.
4950

5051
During initialisation, MicroCloud scrapes the other servers for details and then prompts you to add disks to Ceph and configure the networking setup.
5152

@@ -58,6 +59,11 @@ At the end of this, you’ll have an OVN cluster, a Ceph cluster, and a LXD clus
5859
By default, MicroCloud uses MicroOVN for networking, which is a minimal wrapper around OVN (Open Virtual Network).
5960
If you decide to not use MicroOVN, MicroCloud falls back on the Ubuntu fan for basic networking.
6061

62+
You can optionally add the following dedicated networks:
63+
- a network for Ceph management traffic (also called public traffic)
64+
- a network for internal traffic (also called cluster traffic)
65+
- a network for OVN underlay traffic
66+
6167
## **What's next?**
6268

6369
This is just the beginning of MicroCloud. We’re very excited about what’s coming up next!

doc/images/microcloud_logo_dark.svg

+18
Loading

doc/images/microcloud_logo_light.svg

+35
Loading

0 commit comments

Comments
 (0)