Commit 0a4c4238 authored by Kostas Papadimitriou's avatar Kostas Papadimitriou
Browse files

Updated documentation with new packages names

parent 0253aaac
import sys, os
project = u'snf-asterias-app'
project = u'snf-cyclades-app'
copyright = u'2012, GRNET'
version = '0.8'
release = '0.8'
......@@ -29,7 +29,7 @@ SYNNEFO_PROJECTS = {
'snf-webproject': 'dev',
'snf-common': 'dev',
'snf-image': 'dev',
'snf-asterias-app': 'dev'
'snf-cyclades-app': 'dev'
}
for name, ver in SYNNEFO_PROJECTS.iteritems():
......
.. _snf-asterias-app:
.. _snf-cyclades-app:
Component snf-asterias-app
Component snf-cyclades-app
==========================
synnefo component :ref:`snf-asterias-app <snf-asterias-app>` defines
the web application for asterias. It includes the following:
synnefo component :ref:`snf-cyclades-app <snf-cyclades-app>` defines
the web application for cyclades. It includes the following:
* A set of Django applications that define among others:
* web UI
......@@ -21,7 +21,7 @@ snf-dispatcher
--------------
The logic dispatcher provides the context to run the business logic layer of
:ref:`asterias <snf-asterias>`. It must run on :ref:`LOGIC <LOGIC_NODE>` nodes.
:ref:`cyclades <snf-cyclades>`. It must run on :ref:`LOGIC <LOGIC_NODE>` nodes.
The dispatcher retrieves messages from the queue, over AMQP, and calls the
appropriate handler function, based on the type of the message.
......@@ -32,7 +32,7 @@ snf-admin
---------
command :command:`snf-admin` provides the command-line admin interface
for :ref:`asterias <snf-asterias>`.
for :ref:`cyclades <snf-cyclades>`.
Package installation
--------------------
......@@ -40,13 +40,13 @@ Package installation
.. todo:: kpap: verify instructions for installation from source.
Use ``pip`` to install the latest version of the package from source,
or request a specific version as ``snf-asterias-app==x.y.z``.
or request a specific version as ``snf-cyclades-app==x.y.z``.
.. code-block:: console
$ pip install snf-asterias-app -f https://docs.dev.grnet.gr/pypi
$ pip install snf-cyclades-app -f https://docs.dev.grnet.gr/pypi
On Debian Squeeze, install the ``snf-asterias-app`` Debian package.
On Debian Squeeze, install the ``snf-cyclades-app`` Debian package.
Package configuration
---------------------
......@@ -55,7 +55,7 @@ Web application
***************
Please see the configuration section of :ref:`snf-webproject <snf-webproject>`
on how to serve :ref:`snf-asterias-app <snf-asterias-app>` as part of a
on how to serve :ref:`snf-cyclades-app <snf-cyclades-app>` as part of a
Django project.
snf-dispatcher
......@@ -82,7 +82,7 @@ The dispatcher should run in at least 2 instances to ensure high
Package settings
----------------
Component :ref:`snf-asterias-app <snf-asterias-app>` requires the following
Component :ref:`snf-cyclades-app <snf-cyclades-app>` requires the following
settings, as managed by :ref:`snf-common <snf-common>`:
.. literalinclude:: ../synnefo/app_settings/default/api.py
......
......@@ -29,7 +29,7 @@ SYNNEFO_PROJECTS = {
'snf-webproject': 'dev',
'snf-common': 'dev',
'snf-image': 'dev',
'snf-asterias-app': 'dev'
'snf-cyclades-app': 'dev'
}
for name, ver in SYNNEFO_PROJECTS.iteritems():
......
......@@ -29,7 +29,7 @@ SYNNEFO_PROJECTS = {
'snf-webproject': 'dev',
'snf-common': 'dev',
'snf-image': 'dev',
'snf-asterias-app': 'dev'
'snf-cyclades-app': 'dev'
}
for name, ver in SYNNEFO_PROJECTS.iteritems():
......
.. _asterias-admin-guide:
.. _cyclades-admin-guide:
===================
Administrator Guide
===================
This is the asterias administrator guide.
This is the cyclades administrator guide.
It contains instructions on how to download, install and configure
the synnefo components necessary to deploy the Compute Service. It also covers
......@@ -19,26 +19,26 @@ Overview
This guide covers the following:
Architecture
Node types needed for a complete deployment of asterias,
Node types needed for a complete deployment of cyclades,
and their roles. Throughout this guide, `node` refers to a physical machine
in the deployment.
Installation
The installation of services and synnefo software components for a working
deployment of asterias, either from source packages or the provided
deployment of cyclades, either from source packages or the provided
packages for Debian Squeeze.
Configuration
Configuration of the various software components comprising an asterias
Configuration of the various software components comprising an cyclades
deployment.
Upgrades/Changelogs
Upgrades of existing deployments of asterias to newer versions, associated
Upgrades of existing deployments of cyclades to newer versions, associated
Changelogs.
.. _asterias-architecture:
.. _cyclades-architecture:
Architecture
------------
Nodes in an asterias deployment belong in one of the following types.
Nodes in an cyclades deployment belong in one of the following types.
For every type, we list the services that execute on corresponding nodes.
.. _DB_NODE:
......@@ -48,7 +48,7 @@ DB
A node [or more than one nodes, if using an HA configuration], running a DB
engine supported by the Django ORM layer. The DB is the single source of
truth for the servicing of API requests by asterias.
truth for the servicing of API requests by cyclades.
*Services:* PostgreSQL / MySQL
......@@ -57,7 +57,7 @@ truth for the servicing of API requests by asterias.
APISERVER
*********
A node running the ``api`` application contained in
:ref:`snf-asterias-app <snf-asterias-app>`. Any number of
:ref:`snf-cyclades-app <snf-cyclades-app>`. Any number of
:ref:`APISERVER <APISERVER_NODE>` nodes
can be used, in a load-balancing configuration, without any
special consideration. Access to a common DB ensures consistency.
......@@ -108,21 +108,21 @@ queue.
* the synnefo Ganeti hook, ``ganeti/snf-ganeti-hook.py``.
* on every :ref:`GANETI-NODE <GANETI_NODE>`:
* a deployment-specific KVM ifup script
* properly configured :ref:`NFDHCPD <asterias-nfdhcpd-setup>`
* properly configured :ref:`NFDHCPD <cyclades-nfdhcpd-setup>`
.. _WEBAPP_NODE:
Installation
------------
Installation of asterias is a two step process:
Installation of cyclades is a two step process:
1. install the external services (prerequisites) on which asterias depends
2. install the synnefo software components associated with asterias
1. install the external services (prerequisites) on which cyclades depends
2. install the synnefo software components associated with cyclades
Prerequisites
*************
.. _asterias-install-ganeti:
.. _cyclades-install-ganeti:
Ganeti installation
```````````````````
......@@ -132,7 +132,7 @@ of Ganeti is not covered by this document, please refer to
gory details. A successful Ganeti installation concludes with a working
:ref:`GANETI-MASTER <GANETI_NODES>` and a number of :ref:`GANETI-NODEs <GANETI_NODES>`.
.. _asterias-install-db:
.. _cyclades-install-db:
Database
````````
......@@ -140,12 +140,12 @@ Database
Database installation is done as part of the
:ref:`snf-webproject <snf-webproject>` component.
.. _asterias-install-rabbitmq:
.. _cyclades-install-rabbitmq:
RabbitMQ
````````
RabbitMQ is used as a generic message broker for asterias. It should be
RabbitMQ is used as a generic message broker for cyclades. It should be
installed on two seperate :ref:`QUEUE <QUEUE_NODE>` nodes in a high availability
configuration as described here:
......@@ -165,7 +165,7 @@ The values set for the user and password must be mirrored in the
.. todo:: Document an active-active configuration based on the latest version
of RabbitMQ.
.. _asterias-install-vncauthproxy:
.. _cyclades-install-vncauthproxy:
vncauthproxy
````````````
......@@ -212,7 +212,7 @@ Alternatively, build and install Debian packages.
.. todo:: Mention vncauthproxy bug, snf-vncauthproxy, inability to install using pip
.. todo:: kpap: fix installation commands
.. _asterias-install-nfdhcpd:
.. _cyclades-install-nfdhcpd:
NFDHCPD
```````
......@@ -236,7 +236,7 @@ to NFDHCPD's state directory, usually ``/var/lib/nfdhcpd``.
.. todo:: soc: document NFDHCPD installation, settle on KVM ifup script
.. _asterias-install-snfimage:
.. _cyclades-install-snfimage:
snf-image
`````````
......@@ -244,7 +244,7 @@ snf-image
Install the :ref:`snf-image <snf-image>` Ganeti OS provider for image
deployment.
For :ref:`asterias <asterias>` to be able to launch VMs from specified
For :ref:`cyclades <cyclades>` to be able to launch VMs from specified
Images, you need the snf-image OS Provider installed on *all* Ganeti nodes.
Please see `https://code.grnet.gr/projects/snf-image/wiki`_
......@@ -262,7 +262,7 @@ synnefo components
******************
You need to install the appropriate synnefo software components on each node,
depending on its type, see :ref:`Architecture <asterias-architecture>`.
depending on its type, see :ref:`Architecture <cyclades-architecture>`.
Most synnefo components have dependencies on additional Python packages.
The dependencies are described inside each package, and are setup
......@@ -278,38 +278,38 @@ Nodes of type :ref:`APISERVER <APISERVER_NODE>`
Components
:ref:`snf-common <snf-common>`,
:ref:`snf-webproject <snf-webproject>`,
:ref:`snf-asterias-app <snf-asterias-app>`
:ref:`snf-cyclades-app <snf-cyclades-app>`
Nodes of type :ref:`GANETI-MASTER <GANETI_MASTER>` and :ref:`GANETI-NODE <GANETI_NODE>`
Components
:ref:`snf-common <snf-common>`,
:ref:`snf-asterias-ganeti-tools <snf-asterias-ganeti-tools>`
:ref:`snf-cyclades-ganeti-tools <snf-cyclades-ganeti-tools>`
Nodes of type :ref:`LOGIC <LOGIC_NODE>`
Components
:ref:`snf-common <snf-common>`,
:ref:`snf-webproject <snf-webproject>`,
:ref:`snf-asterias-app <snf-asterias-app>`.
:ref:`snf-cyclades-app <snf-cyclades-app>`.
Configuration
-------------
This section targets the configuration of the prerequisites for asterias,
This section targets the configuration of the prerequisites for cyclades,
and the configuration of the associated synnefo software components.
synnefo components
******************
asterias uses :ref:`snf-common <snf-common>` for settings.
cyclades uses :ref:`snf-common <snf-common>` for settings.
Please refer to the configuration sections of
:ref:`snf-webproject <snf-webproject>`,
:ref:`snf-asterias-app <snf-asterias-app>`,
:ref:`snf-asterias-ganeti-tools <snf-asterias-ganeti-tools>` for more
:ref:`snf-cyclades-app <snf-cyclades-app>`,
:ref:`snf-cyclades-ganeti-tools <snf-cyclades-ganeti-tools>` for more
information on their configuration.
Ganeti
``````
Set ``GANETI_NODES``, ``GANETI_MASTER_IP``, ``GANETI_CLUSTER_INFO`` based on
your :ref:`Ganeti installation <asterias-install-ganeti>` and change the
your :ref:`Ganeti installation <cyclades-install-ganeti>` and change the
`BACKEND_PREFIX_ID`` setting, using an custom ``PREFIX_ID``.
Database
......@@ -349,6 +349,6 @@ RabbitMQ
````````
Change ``RABBIT_*`` settings to match your :ref:`RabbitMQ setup
<asterias-install-rabbitmq>`.
<cyclades-install-rabbitmq>`.
.. include:: ../../Changelog
......@@ -8,7 +8,7 @@ It is meant for users wishing to make calls to the REST API directly.
The :ref:`kamaki <http://docs.dev.grnet.gr/kamaki>` command-line client
and associated python library can be used instead of making direct calls to
:ref:`asterias <asterias>`.
:ref:`cyclades <cyclades>`.
Overview
========
......
.. _asterias-developer-guide:
.. _cyclades-developer-guide:
===============
Developer Guide
===============
This is the asterias developer guide.
This is the cyclades developer guide.
It is intended for developers, wishing to implement new functionality
inside :ref:`asterias <asterias>`.
inside :ref:`cyclades <cyclades>`.
It assumes thorough familiarity with the :ref:`asterias-admin-guide`.
It assumes thorough familiarity with the :ref:`cyclades-admin-guide`.
Building a dev environment
--------------------------
......@@ -105,7 +105,7 @@ synnefo source
.. code-block:: console
(synnefo-env)$ cd snf-asterias-app
(synnefo-env)$ cd snf-cyclades-app
(synnefo-env)$ python setup.py develop -N
* Initialize database:
......@@ -147,7 +147,7 @@ Development tips
South Database Migrations
-------------------------
.. _asterias-dev-initialmigration:
.. _cyclades-dev-initialmigration:
Initial Migration
*****************
......@@ -190,7 +190,7 @@ Schema migrations
Do not use the syncdb management command. It can only be used the first time
and/or if you drop the database and must recreate it from scratch. See
:ref:`asterias-dev-initialmigration`.
:ref:`cyclades-dev-initialmigration`.
Every time you make changes to the database and data migration is not required
......
.. _asterias:
.. _cyclades:
Asterias Service
----------------
......@@ -10,11 +10,11 @@ Asterias is the the synnefo Compute Service and implements OpenStack Compute API
.. toctree::
:maxdepth: 2
asterias-admin-guide
asterias-api-guide
asterias-admin-tools
asterias-dev-guide
asterias-upgrade
cyclades-admin-guide
cyclades-api-guide
cyclades-admin-tools
cyclades-dev-guide
cyclades-upgrade
.. src/design
.. src/dev
.. src/user
......
......@@ -14,14 +14,14 @@ synnefo comprises the following major components:
.. toctree::
:maxdepth: 1
asterias (name TBD): Compute Service <asterias>
cyclades (name TBD): Compute Service <cyclades>
pithos+: File storage service <http://docs.dev.grnet.gr/pithos>
plankton: Image registry <http://docs.dev.grnet.gr/asterias/plankton>
plankton: Image registry <http://docs.dev.grnet.gr/cyclades/plankton>
archipelagos: Volume storage service <http://docs.dev.grnet.gr/archipelagos>
astakos: Identity management module <http://docs.dev.grnet.gr/astakos>
aquarium: Billing module <http://docs.dev.grnet.gr/aquarium>
image: Secure image deployment tool <snf-image>
kamaki: Command-line cloud management tool <http://docs.dev.grnet.gr/asterias/kamaki>
kamaki: Command-line cloud management tool <http://docs.dev.grnet.gr/cyclades/kamaki>
Indices and tables
------------------
......
......@@ -5,7 +5,7 @@ snf-image
=========
:ref:`snf-image <snf-image>` is the secure image deployment tool used
by the synnefo's Compute Service, :ref:`asterias <asterias>`.
by the synnefo's Compute Service, :ref:`cyclades <cyclades>`.
Currently, it is implemented as an OS definition inside Ganeti.
......
import sys, os
project = u'snf-asterias-ganeti-tools'
project = u'snf-cyclades-ganeti-tools'
copyright = u'2012, GRNET'
version = '0.8'
release = '0.8'
......@@ -29,7 +29,7 @@ SYNNEFO_PROJECTS = {
'snf-webproject': 'dev',
'snf-common': 'dev',
'snf-image': 'dev',
'snf-asterias-app': 'dev'
'snf-cyclades-app': 'dev'
}
for name, ver in SYNNEFO_PROJECTS.iteritems():
......
.. _snf-asterias-ganeti-tools:
.. _snf-cyclades-ganeti-tools:
Component snf-asterias-ganeti-tools
Component snf-cyclades-ganeti-tools
===================================
synnefo component :ref:`snf-asterias-ganeti-tools <snf-asterias-ganeti-tools>` is a set of
synnefo component :ref:`snf-cyclades-ganeti-tools <snf-cyclades-ganeti-tools>` is a set of
tools that need to be installed on all Ganeti nodes:
* :ref:`event daemon <eventd>`
......@@ -15,7 +15,7 @@ tools that need to be installed on all Ganeti nodes:
Event daemon
------------
synnefo component :ref:`snf-asterias-ganeti-tools <snf-asterias-ganeti-tools>` includes
synnefo component :ref:`snf-cyclades-ganeti-tools <snf-cyclades-ganeti-tools>` includes
``snf-ganeti-eventd``, the synnefo-specific Ganeti event daemon.
It monitors the Ganeti job queue and produces notifications to the rest of
the synnefo infrastructure over AMQP whenever a Ganeti job makes progress.
......@@ -27,7 +27,7 @@ the synnefo infrastructure over AMQP whenever a Ganeti job makes progress.
Hook
----
synnefo component :ref:`snf-asterias-ganeti-tools <snf-asterias-ganeti-tools>` defines
synnefo component :ref:`snf-cyclades-ganeti-tools <snf-cyclades-ganeti-tools>` defines
a synnefo-specific hook, running inside Ganeti.
.. _progress_monitor:
......@@ -42,10 +42,10 @@ A small Python tool to monitor the progress of image deployment.
Package source
--------------
The source for component :ref:`snf-asterias-ganeti-tools <snf-asterias-ganeti-tools>`
lives under ``snf-asterias-ganeti-tools/`` at ``git://code.grnet.gr/git/synnefo``,
The source for component :ref:`snf-cyclades-ganeti-tools <snf-cyclades-ganeti-tools>`
lives under ``snf-cyclades-ganeti-tools/`` at ``git://code.grnet.gr/git/synnefo``,
also accessible at
`code.grnet.gr <https://code.grnet.gr/projects/synnefo/repository/revisions/master/show/snf-asterias-ganeti-tools>`_.
`code.grnet.gr <https://code.grnet.gr/projects/synnefo/repository/revisions/master/show/snf-cyclades-ganeti-tools>`_.
Package installation
--------------------
......@@ -53,13 +53,13 @@ Package installation
.. todo:: kpap: verify instructions for installation from source.
Use ``pip`` to install the latest version of the package from source,
or request a specific version as ``snf-asterias-ganeti-tools==x.y.z``.
or request a specific version as ``snf-cyclades-ganeti-tools==x.y.z``.
.. code-block:: console
pip install snf-asterias-ganeti-tools -f https://docs.dev.grnet.gr/pypi
pip install snf-cyclades-ganeti-tools -f https://docs.dev.grnet.gr/pypi
On Debian Squeeze, install the ``snf-asterias-ganeti-tools`` Debian package.
On Debian Squeeze, install the ``snf-cyclades-ganeti-tools`` Debian package.
Package configuration
---------------------
......@@ -97,9 +97,9 @@ on :ref:`GANETI-MASTER <GANETI_MASTER>`, e.g.:
Package settings
----------------
Component :ref:`snf-asterias-ganeti-tools <snf-asterias-ganeti-tools>` requires the following
Component :ref:`snf-cyclades-ganeti-tools <snf-cyclades-ganeti-tools>` requires the following
settings, as managed by :ref:`snf-common <snf-common>`:
.. literalinclude:: ../../../snf-asterias-ganeti-tools/synnefo/settings.py
.. literalinclude:: ../../../snf-cyclades-ganeti-tools/synnefo/settings.py
.. todo:: make sure the settings are included properly.
......@@ -29,7 +29,7 @@ SYNNEFO_PROJECTS = {
'snf-webproject': 'dev',
'snf-common': 'dev',
'snf-image': 'dev',
'snf-asterias-app': 'dev'
'snf-cyclades-app': 'dev'
}
for name, ver in SYNNEFO_PROJECTS.iteritems():
......
......@@ -29,7 +29,7 @@ SYNNEFO_PROJECTS = {
'snf-webproject': 'dev',
'snf-common': 'dev',
'snf-image': 'dev',
'snf-asterias-app': 'dev'
'snf-cyclades-app': 'dev'
}
for name, ver in SYNNEFO_PROJECTS.iteritems():
......
......@@ -5,7 +5,7 @@ Component snf-webproject
synnefo component :ref:`snf-webproject <snf-webproject>` defines
a Django project in which the various other synnefo components
(:ref:`snf-asterias-app <snf-asterias-app>`,
(:ref:`snf-cyclades-app <snf-cyclades-app>`,
:ref:`snf-pithos-app <snf-pithos-app>`, etc.) may run.
It provides a standard mechanism for every synnefo software component to modify
......
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