Skip to content

Commit

Permalink
Merge pull request #108 from pmatulis/improve-home-page-text
Browse files Browse the repository at this point in the history
docs: Improve home page text
  • Loading branch information
mkalcok authored Dec 7, 2023
2 parents 7237b4f + f52fb4f commit 10b9bc0
Showing 1 changed file with 19 additions and 14 deletions.
33 changes: 19 additions & 14 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,24 @@
MicroOVN
========

``MicroOVN`` is a snap-based distribution of ``OVN (Open Virtual Network)``.
``MicroOVN`` is a snap-based distribution of OVN - `Open Virtual Network`_.

It allows users to easily deploy an ``OVN`` cluster with just a few commands.
Aside from regular ``OVN`` packages, ``MicroOVN`` comes bundled with CLI
utility (``microovn``) that facilitates deployment management. Among other
things, it allows adding or removing cluster members and status checking.
It allows users to deploy an OVN cluster with just a few commands. Aside from
the regular OVN packages, ``MicroOVN`` comes bundled with a CLI utility
(``microovn``) that facilitates operational management. In particular, it
simplifies the task of adding/removing cluster members and incorporates status
checking out of the box.

Besides the ease of deployment and convenient CLI, another benefit of
``MicroOVN`` is its self-contained nature. It is distributed as a strictly
confined snap which means that it can be easily upgraded/downgraded/removed
without affecting host system.
Besides the ease of deployment and a convenient CLI tool, another benefit of
``MicroOVN`` is in its self-contained nature: it is distributed as a `strictly
confined snap`_. This means that it can be easily upgraded/downgraded/removed
without affecting the host system.

``MicroOVN`` can be useful for wide range of users. It lowers a barrier of
entry to ``OVN`` for people that are not yet familiar with it by automating as
much of a deployment process as possible. At the same time, the aim is for
``MicroOVN`` to provide fully fledged ``OVN`` deployment not restricted in any
way and suitable for production environment.
``MicroOVN`` caters to a wide range of user and environment types. It lowers
the barrier of entry to OVN for people that are less familiar with it by
automating much of the deployment process. It also provides a fully fledged,
unrestricted OVN deployment that is suitable for both development and
production environments.

.. toctree::
:hidden:
Expand All @@ -27,3 +28,7 @@ way and suitable for production environment.
how-to/index
tutorial/index
reference/index

.. LINKS
.. _strictly confined snap: https://snapcraft.io/docs/snap-confinement
.. _Open Virtual Network: https://www.ovn.org/en/

0 comments on commit 10b9bc0

Please sign in to comment.