Commit 28cc06c4 authored by Constantinos Venetsanopoulos's avatar Constantinos Venetsanopoulos
Browse files

docs: Minor wording fixes in index page

Also, move the complete component list from the index
to the Admin Guide.
parent 92fc8589
......@@ -1282,6 +1282,28 @@ these messages and properly updates the state of the Cyclades DB. Subsequent
requests to the Cyclades API, will retrieve the updated state from the DB.
List of all Synnefo components
==============================
They are also available from our apt repository: ``apt.dev.grnet.gr``
* `snf-common <http://www.synnefo.org/docs/snf-common/latest/index.html>`_
* `snf-webproject <http://www.synnefo.org/docs/snf-webproject/latest/index.html>`_
* `snf-astakos-app <http://www.synnefo.org/docs/astakos/latest/index.html>`_
* `snf-pithos-backend <http://www.synnefo.org/docs/pithos/latest/backends.html>`_
* `snf-pithos-app <http://www.synnefo.org/docs/pithos/latest/index.html>`_
* `snf-pithos-webclient <http://www.synnefo.org/docs/pithos-webclient/latest/index.html>`_
* `snf-cyclades-app <http://www.synnefo.org/docs/snf-cyclades-app/latest/index.html>`_
* `snf-cyclades-gtools <http://www.synnefo.org/docs/snf-cyclades-gtools/latest/index.html>`_
* `astakosclient <http://www.synnefo.org/docs/astakosclient/latest/index.html>`_
* `snf-vncauthproxy <https://code.grnet.gr/projects/vncauthproxy>`_
* `snf-image <http://www.synnefo.org/docs/snf-image/latest/index.html/>`_
* `snf-image-creator <http://www.synnefo.org/docs/snf-image-creator/latest/index.html>`_
* `snf-occi <http://www.synnefo.org/docs/snf-occi/latest/index.html>`_
* `snf-cloudcms <http://www.synnefo.org/docs/snf-cloudcms/latest/index.html>`_
* `nfdhcpd <https://code.grnet.gr/projects/nfdhcpd>`_
Synnefo management commands ("snf-manage")
==========================================
......
Welcome to Synnefo's documentation
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Welcome to the Synnefo documentation
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. image:: /images/synnefo-logo.png
......@@ -7,11 +7,13 @@ Synnefo is a complete open source cloud stack written in Python that provides
Compute, Network, Image, Volume and Storage services, similar to the ones
offered by AWS. Synnefo manages multiple `Ganeti
<http://code.google.com/p/ganeti>`_ clusters at the backend for handling of
low-level VM operations. To boost 3rd-party compatibility, Synnefo exposes the
OpenStack APIs to users.
low-level VM operations and uses `Archipelago
<http://www.synnefo.org/docs/archipelago/latest/>`_ to unify cloud storage. To
boost 3rd-party compatibility, Synnefo exposes the OpenStack APIs to users.
You can see Synnefo in action, powering GRNET's
`~okeanos public cloud service <http://okeanos.grnet.gr>`_.
Synnefo powers GRNET's `~okeanos public cloud service
<http://okeanos.grnet.gr>`_ and you can try it out live at `demo.synnefo.org
<http://demo.synnefo.org>`_.
Synnefo has three main components providing the corresponding services:
......@@ -22,29 +24,18 @@ Synnefo has three main components providing the corresponding services:
Pithos: File/Object Storage service <pithos>
Cyclades: Compute/Network/Image/Volume services <cyclades>
There are also the following tools:
.. toctree::
:maxdepth: 1
kamaki: Command-line client <http://www.synnefo.org/docs/kamaki/latest/index.html>
snf-deploy: Synnefo deployment tool <snf-deploy>
snf-image-creator: Image bundling/uploading/registering tool <http://www.synnefo.org/docs/snf-image-creator/latest/index.html>
snf-image: Secure image deployment tool <http://www.synnefo.org/docs/snf-image/latest/index.html>
snf-burnin: Integration testing tool for a running Synnefo deployment <snf-burnin>
This is an overview of the Synnefo services:
.. image:: images/synnefo-overview.png
:target: _images/synnefo-overview.png
Synnefo is designed to be as simple, scalable and production ready as possible.
Furthermore, although it can be deployed in small configurations, its prime
target is large installations.
Synnefo is designed with simplicity, scalability and stability in mind.
Furthermore, although it can be deployed in small configurations, it was
initially designed to address large installation problems.
All Synnefo components use an intuitive settings mechanism, that adds and removes
settings dynamically as components are getting added or removed from a physical
node. All settings are stored in a single location.
All Synnefo components use an intuitive settings mechanism, that adds and
removes settings dynamically as components are getting added or removed from a
physical node. All settings are stored in a single location.
.. _general-arch:
......@@ -52,20 +43,21 @@ node. All settings are stored in a single location.
Synnefo General Architecture
============================
The following graph shows the whole Synnefo stack and how it interacts with
The following figure shows the whole Synnefo stack and how it interacts with
multiple Ganeti clusters and the storage backends. Synnefo decouples the cloud
from the cluster layer enhancing robustness, stability and ease of
administration. As shown in the figure below, Synnefo sits on the cloud layer:
from the cluster layer enhancing robustness, scalability, and ease of
administration and upgrades without impacting VM stability. As shown in the
figure below, Synnefo sits on the cloud layer:
.. image:: images/snf-architecture.png
:width: 100%
:target: _images/snf-architecture.png
Synnefo manages multiple Ganeti clusters and different kind of storage backends
such as a Ceph/RADOS cluster or an NFS-based backend.
Synnefo manages multiple Ganeti clusters and different storage backends
(e.g., Ceph/RADOS or NFS-based backends as shown in the figure).
For an extensive view of all components and APIs between them, please take a
look at the Admin Guide's :ref:`corresponding figure <syn+archip>`.
For an extensive view of all components, the interconnection and APIs between
them, please take a look at the Admin Guide's :ref:`corresponding figure
<syn+archip>`.
Synnefo Guides
......@@ -80,7 +72,7 @@ deployments. It is the perfect way, even for an inexperienced user to have the
whole Synnefo stack up and running and allows for a quick preview of the basic
Synnefo features.
The Admin's installation guide describes how to install the whole Synnefo stack
The Admin's Installation guide describes how to install the whole Synnefo stack
in just two physical nodes. This guide is useful to those interested in
deploying Synnefo in large scale, as a starting point that will help them get
familiar with the Synnefo components and overall architecture, as well as the
......@@ -111,32 +103,25 @@ external world. Also documents all Synnefo external REST APIs.
Installation Guide (on two nodes) <quick-install-admin-guide>
.. toctree::
:maxdepth: 2
:maxdepth: 1
Administrator's Guide <admin-guide>
Developer's Guide <dev-guide>
List of all Synnefo components
==============================
Synnefo tools
=============
They are also available from our apt repository: ``apt.dev.grnet.gr``
There are also the following tools:
.. toctree::
:maxdepth: 1
* `snf-common <http://www.synnefo.org/docs/snf-common/latest/index.html>`_
* `snf-webproject <http://www.synnefo.org/docs/snf-webproject/latest/index.html>`_
* `snf-astakos-app <http://www.synnefo.org/docs/astakos/latest/index.html>`_
* `snf-pithos-backend <http://www.synnefo.org/docs/pithos/latest/backends.html>`_
* `snf-pithos-app <http://www.synnefo.org/docs/pithos/latest/index.html>`_
* `snf-pithos-webclient <http://www.synnefo.org/docs/pithos-webclient/latest/index.html>`_
* `snf-cyclades-app <http://www.synnefo.org/docs/snf-cyclades-app/latest/index.html>`_
* `snf-cyclades-gtools <http://www.synnefo.org/docs/snf-cyclades-gtools/latest/index.html>`_
* `astakosclient <http://www.synnefo.org/docs/astakosclient/latest/index.html>`_
* `snf-vncauthproxy <https://www.synnefo.org/docs/snf-vncauthproxy/latest/index.html>`_
* `snf-image <http://www.synnefo.org/docs/snf-image/latest/index.html/>`_
* `snf-image-creator <http://www.synnefo.org/docs/snf-image-creator/latest/index.html>`_
* `snf-occi <http://www.synnefo.org/docs/snf-occi/latest/index.html>`_
* `snf-cloudcms <http://www.synnefo.org/docs/snf-cloudcms/latest/index.html>`_
* `nfdhcpd <https://code.grnet.gr/projects/nfdhcpd>`_
kamaki: Command-line client <http://www.synnefo.org/docs/kamaki/latest/index.html>
snf-deploy: Synnefo deployment tool <snf-deploy>
snf-image-creator: Image bundling/uploading/registering tool <http://www.synnefo.org/docs/snf-image-creator/latest/index.html>
snf-image: Secure image deployment tool <http://www.synnefo.org/docs/snf-image/latest/index.html>
snf-burnin: Integration testing tool for a running Synnefo deployment <snf-burnin>
Design
......@@ -163,11 +148,3 @@ You can contact the Synnefo team at the following mailing lists:
The official site is:
`http://www.synnefo.org <http://www.synnefo.org>`_
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment