Commit 13d01dff authored by Constantinos Venetsanopoulos's avatar Constantinos Venetsanopoulos
Browse files

Make the "Plankton" name obsolete

Since the Image Service is not going to be decoupled from Cyclades
we will stop calling it with a different name because it is
frustrating for people who are trying to understand the Synnefo
architecture and the interaction between different services.

We will keep all references to "plankton" inside the code, but we
remove all references inside the documentation. From now on
"Plankton" will be just called "The Image Service" and we will note
that it is a part of Cyclades. The same already happens with
"The Network Service", which doesn't have a special name since it's
part of Cyclades too.

This patch removes all Plankton references inside the documentation,
except from those inside `docs/plankton-api-guide.rst' which will be
removed with a separate patch.
parent 6d06e0e6
......@@ -1086,11 +1086,11 @@ Before proceeding make sure that it is configured properly. Verify that
$ kamaki config list
To chage a setting use ``kamaki config set``:
To change a setting use ``kamaki config set``:
.. code-block:: console
$ kamaki config set image.url https://cyclades.example.com/plankton
$ kamaki config set image.url https://cyclades.example.com/image
$ kamaki config set file.url https://pithos.example.com/v1
$ kamaki config set user.url https://accounts.example.com
$ kamaki config set token ...
......
......@@ -11,14 +11,15 @@ Synnefo exposes the OpenStack APIs for all its operations. Also, extensions
have been written for advanced operations wherever needed, and minor changes
for things that were missing or change frequently.
All Synnefo services have the analogous OpenStack API:
Most Synnefo services have a corresponding OpenStack API:
| Cyclades/Compute Service -> OpenStack Compute API
| Cyclades/Network Service -> OpenStack Compute/Network API (not Quantum yet)
| Cyclades/Image Service -> OpenStack Compute/Image API
| Cyclades/Plankton/Image Service -> OpenStack Glance API
| Cyclades/Image Service -> OpenStack Glance API
| Pithos/Storage Service -> OpenStack Object Store API
| Astakos/Identity Service -> Proprietary, moving to OpenStack Keystone API
| Astakos/Quota Service -> Proprietary API
| Astakos/Resource Service -> Proprietary API
Below, we will describe all Synnefo APIs with conjuction to the OpenStack APIs.
......@@ -37,8 +38,8 @@ The current Identity Management API is:
Identity API <astakos-api-guide>
Resource and Quota API (Astakos)
================================
Resource and Quota Service API (Astakos)
========================================
.. toctree::
:maxdepth: 2
......@@ -71,14 +72,13 @@ Please consult the :ref:`Cyclades/Network API <cyclades-api-guide>` for more
details.
Images Service API (Cyclades/Plankton)
======================================
Image Service API (Cyclades)
============================
Plankton is the Image Service of Synnefo, currently implemented inside
Cyclades. Plankton exposes the OpenStack Glance API with minor changes wherever
needed.
The Image Service is implemented inside Cyclades. It exposes the OpenStack
Glance API with minor changes wherever needed.
This is the Cyclades/Plankton Image API:
This is the Cyclades/Image API:
.. toctree::
:maxdepth: 2
......
......@@ -20,7 +20,7 @@ Welcome to Synnefo's documentation
Object Storage Service (codename: pithos) <pithos>
Compute Service (codename: cyclades) <cyclades>
Network Service (part of Cyclades) <networks>
Image Service (codename: plankton) <plankton>
Image Service (part of Cyclades) <plankton>
Volume Storage Service (codename: archipelago) <archipelago>
.. image:: images/synnefo-overview.png
......
.. _plankton:
Image Registry Service (plankton)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Image Registry Service
^^^^^^^^^^^^^^^^^^^^^^
Introduction
============
Plankton is the synnefo Image Registry Service. It is implemented as a very thin
layer on top of Pithos+; every Image on Plankton is a file on a Pithos+ backend,
with special metadata. At the frontend, Plankton implements the OpenStack
Glance API; at the backend it queries an existing Pithos+ backend. In the
current implementation the service runs Plankton and Pithos+ on a single,
unified backend: users may synchronize their Images, using the Pithos+ clients,
then register them with Plankton, with zero data movement. Then spawn new VMs
from those images with Cyclades.
The Image Registry Service is a part of Cyclades. It is implemented as a very
thin layer on top of Pithos; every Image on the Image Service is a file on
Pithos, with special metadata which are stored on Cyclades. At the frontend,
Cyclades implement the OpenStack Glance API; at the backend it queries an
existing Pithos backend. In the current implementation the service runs the
Image Service and Pithos on a single, unified backend: users may synchronize
their Images, using the Pithos clients, then register them with Cyclades, with
zero data movement. Then spawn new VMs from those Images with Cyclades.
Let's see below:
.. image:: images/synnefo-clonepath.png
The figure shows a sailor bundling his physical machine with the
``snf-image-creator`` tool, uploading the file to pithos+, registering the file
as a new image with plankton and then spawning two new VMs with Cyclades from
this image.
The :ref:`Plankton API <plankton-api-guide>` is implemented inside Cyclades, so please consult the
:ref:`Cyclades Documentation <cyclades>` for more details.
``snf-image-creator`` tool, uploading the file to Pithos, registering the file
as a new Image, and then spawning two new VMs with Cyclades from this Image.
The :ref:`Image API <plankton-api-guide>` is implemented inside Cyclades, so
please consult the :ref:`Cyclades Documentation <cyclades>` for more details.
......@@ -13,7 +13,8 @@ have the following services running:
* Identity Management (Astakos)
* Object Storage Service (Pithos+)
* Compute Service (Cyclades)
* Image Registry Service (Plankton)
* Image Service (part of Cyclades)
* Network Service (part of Cyclades)
and a single unified Web UI to manage them all.
......@@ -27,12 +28,12 @@ guide and just stop after the "Testing of Pithos+" section.
Installation of Synnefo / Introduction
======================================
We will install the services with the above list's order. Cyclades and Plankton
will be installed in a single step (at the end), because at the moment they are
contained in the same software component. Furthermore, we will install all
services in the first physical node, except Pithos+ which will be installed in
the second, due to a conflict between the snf-pithos-app and snf-cyclades-app
component (scheduled to be fixed in the next version).
We will install the services with the above list's order. The last three
services will be installed in a single step (at the end), because at the moment
they are contained in the same software component (Cyclades). Furthermore, we
will install all services in the first physical node, except Pithos+ which will
be installed in the second, due to a conflict between the snf-pithos-app and
snf-cyclades-app component (scheduled to be fixed in the next version).
For the rest of the documentation we will refer to the first physical node as
"node1" and the second as "node2". We will also assume that their domain names
......@@ -53,7 +54,7 @@ General Prerequisites
=====================
These are the general synnefo prerequisites, that you need on node1 and node2
and are related to all the services (Astakos, Pithos+, Cyclades, Plankton).
and are related to all the services (Astakos, Pithos+, Cyclades).
To be able to download all synnefo components you need to add the following
lines in your ``/etc/apt/sources.list`` file:
......@@ -1035,13 +1036,13 @@ If you would like to do more, such as:
please continue with the rest of the guide.
Cyclades (and Plankton) Prerequisites
=====================================
Cyclades Prerequisites
======================
Before proceeding with the Cyclades (and Plankton) installation, make sure you
have successfully set up Astakos and Pithos+ first, because Cyclades depends
on them. If you don't have a working Astakos and Pithos+ installation yet,
please return to the :ref:`top <quick-install-admin-guide>` of this guide.
Before proceeding with the Cyclades installation, make sure you have
successfully set up Astakos and Pithos+ first, because Cyclades depends on
them. If you don't have a working Astakos and Pithos+ installation yet, please
return to the :ref:`top <quick-install-admin-guide>` of this guide.
Besides Astakos and Pithos+, you will also need a number of additional working
prerequisites, before you start the Cyclades installation.
......@@ -1636,27 +1637,26 @@ and then putting the output in ``/var/lib/ganeti/rapi/users`` as follows:
More about Ganeti's RAPI users `here.
<http://docs.ganeti.org/ganeti/2.5/html/rapi.html#introduction>`_
You have now finished with all needed Prerequisites for Cyclades (and
Plankton). Let's move on to the actual Cyclades installation.
You have now finished with all needed Prerequisites for Cyclades. Let's move on
to the actual Cyclades installation.
Installation of Cyclades (and Plankton) on node1
================================================
Installation of Cyclades on node1
=================================
This section describes the installation of Cyclades. Cyclades is Synnefo's
Compute service. Plankton (the Image Registry service) will get installed
automatically along with Cyclades, because it is contained in the same Synnefo
component right now.
Compute service. The Image Service will get installed automatically along with
Cyclades, because it is contained in the same Synnefo component.
We will install Cyclades (and Plankton) on node1. To do so, we install the
corresponding package by running on node1:
We will install Cyclades on node1. To do so, we install the corresponding
package by running on node1:
.. code-block:: console
# apt-get install snf-cyclades-app memcached python-memcache
If all packages install successfully, then Cyclades and Plankton are installed
and we proceed with their configuration.
If all packages install successfully, then Cyclades are installed and we
proceed with their configuration.
Since version 0.13, Synnefo uses the VMAPI in order to prevent sensitive data
needed by 'snf-image' to be stored in Ganeti configuration (e.g. VM password).
......@@ -1665,8 +1665,8 @@ exporting it via VMAPI. The cache entries are invalidated after the first
request. Synnefo uses `memcached <http://memcached.org/>`_ as a
`Django <https://www.djangoproject.com/>`_ cache backend.
Configuration of Cyclades (and Plankton)
========================================
Configuration of Cyclades
=========================
Conf files
----------
......@@ -1733,7 +1733,7 @@ Edit ``/etc/synnefo/20-snf-cyclades-app-plankton.conf``:
BACKEND_DB_CONNECTION = 'postgresql://synnefo:example_passw0rd@node1.example.com:5432/snf_pithos'
BACKEND_BLOCK_PATH = '/srv/pithos/data/'
In this file we configure the Plankton Service. ``BACKEND_DB_CONNECTION``
In this file we configure the Image Service. ``BACKEND_DB_CONNECTION``
denotes the Pithos+ database (where the Image files are stored). So we set that
to point to our Pithos+ database. ``BACKEND_BLOCK_PATH`` denotes the actual
Pithos+ data location.
......@@ -1774,7 +1774,7 @@ Edit ``/etc/default/vncauthproxy``:
CHUID="nobody:www-data"
We have now finished with the basic Cyclades and Plankton configuration.
We have now finished with the basic Cyclades configuration.
Database Initialization
-----------------------
......@@ -1989,13 +1989,13 @@ Apply Quotas
node1 # snf-manage reconcile-resources-cyclades --fix
If all the above return successfully, then you have finished with the Cyclades
and Plankton installation and setup.
installation and setup.
Let's test our installation now.
Testing of Cyclades (and Plankton)
==================================
Testing of Cyclades
===================
Cyclades Web UI
---------------
......@@ -2019,13 +2019,13 @@ register our first Image file.
Cyclades Images
---------------
To test our Cyclades (and Plankton) installation, we will use an Image stored on
Pithos+ to spawn a new VM from the Cyclades interface. We will describe all
steps, even though you may already have uploaded an Image on Pithos+ from a
:ref:`previous <snf-image-images>` section:
To test our Cyclades installation, we will use an Image stored on Pithos+ to
spawn a new VM from the Cyclades interface. We will describe all steps, even
though you may already have uploaded an Image on Pithos+ from a :ref:`previous
<snf-image-images>` section:
* Upload an Image file to Pithos+
* Register that Image file to Plankton
* Register that Image file to Cyclades
* Spawn a new VM from that Image from the Cyclades Web UI
We will use the `kamaki <http://www.synnefo.org/docs/kamaki/latest/index.html>`_
......@@ -2055,7 +2055,7 @@ installation. We do this by running:
$ kamaki config set user.url "https://node1.example.com"
$ kamaki config set compute.url "https://node1.example.com/api/v1.1"
$ kamaki config set image.url "https://node1.example.com/plankton"
$ kamaki config set image.url "https://node1.example.com/image"
$ kamaki config set file.url "https://node2.example.com/v1"
$ kamaki config set token USER_TOKEN
......@@ -2121,14 +2121,14 @@ Check if the file has been uploaded, by listing the container contents:
Alternatively check if the new container and file appear on the Pithos+ Web UI.
Register an existing Image file to Plankton
Register an existing Image file to Cyclades
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
For the purposes of the following example, we assume that the user UUID is
``u53r-un1qu3-1d``.
Once the Image file has been successfully uploaded on Pithos+ then we register
it to Plankton (so that it becomes visible to Cyclades), by running:
it to Cyclades, by running:
.. code-block:: console
......@@ -2143,7 +2143,7 @@ it to Plankton (so that it becomes visible to Cyclades), by running:
This command registers the Pithos+ file
``pithos://u53r-un1qu3-1d/images/debian_base-6.0-7-x86_64.diskdump`` as an
Image in Plankton. This Image will be public (``--public``), so all users will
Image in Cyclades. This Image will be public (``--public``), so all users will
be able to spawn VMs from it and is of type ``diskdump``. The first two
properties (``OSFAMILY`` and ``ROOT_PARTITION``) are mandatory. All the rest
properties are optional, but recommended, so that the Images appear nicely on
......@@ -2152,7 +2152,7 @@ the Cyclades Web UI. ``Debian Base`` will appear as the name of this Image. The
inside the ``20-snf-cyclades-app-ui.conf`` configuration file.
``OSFAMILY`` and ``ROOT_PARTITION`` are mandatory because they will be passed
from Plankton to Cyclades and then to Ganeti and `snf-image` (also see
from Cyclades to Ganeti and then `snf-image` (also see
:ref:`previous section <ganeti-with-pithos-images>`). All other properties are
used to show information on the Cyclades UI.
......
......@@ -17,7 +17,8 @@ installation, you will have the following services running:
* Identity Management (Astakos)
* Object Storage Service (Pithos+)
* Compute Service (Cyclades)
* Image Registry Service (Plankton)
* Image Service (part of Cyclades)
* Network Service (part of Cyclades)
and a single unified Web UI to manage them all.
......
......@@ -40,7 +40,7 @@ and build the correct config file:
# kamaki config set astakos.url "https://accounts.example.com"
# kamaki config set compute.url "https://cyclades.example.com/api/v1.1"
# kamaki config set image.url "https://cyclades.example.com/plankton"
# kamaki config set image.url "https://cyclades.example.com/image"
# kamaki config set store.enable on
# kamaki config set store.pithos_extensions on
# kamaki config set store.url "https://pithos.example.com/v1"
......@@ -63,7 +63,7 @@ create a container in pithos, upload it:
# kamaki store create images
# kamaki store upload --container images /tmp/debian_base.diskdump debian_base.diskdump
and register it to plankton:
and register it with Cyclades:
.. code-block:: console
......
......@@ -26,7 +26,8 @@ will have the following services running:
* Identity Management (Astakos)
* Object Storage Service (Pithos+)
* Compute Service (Cyclades)
* Image Registry Service (Plankton)
* Image Service (part of Cyclades)
* Network Service (part of Cyclades)
and a single unified Web UI to manage them all.
......
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