Commit e8f9d16b authored by Vangelis Koukis's avatar Vangelis Koukis
Browse files

Improvements to documentation

parent fcda074a
.. _snf-asterias-admin-guide:
.. _asterias-admin-guide:
===================
Administrator Guide
......@@ -35,7 +35,7 @@ Changelogs
.. todo:: describe prerequisites -- e.g., Debian
.. todo:: describe setup of nginx, flup, synnefo packages, etc.
.. _snf-asterias-architecture:
.. _asterias-architecture:
Architecture
------------
......@@ -338,7 +338,7 @@ to NFDHCPD's state directory, usually ``/var/lib/nfdhcpd``.
Install the :ref:`snf-image <snf-image>` Ganeti OS provider for image
deployment.
For :ref:`asterias <snf-asterias>` to be able to launch VMs from specified
For :ref:`asterias <asterias>` 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`_
......@@ -356,7 +356,7 @@ synnefo components
******************
You need to install the appropriate synnefo software components on each node,
depending on its type, see :ref:`Architecture <snf-asterias-architecture>`.
depending on its type, see :ref:`Architecture <asterias-architecture>`.
Most synnefo components have dependencies on additional Python packages.
The dependencies are described inside each package, and are setup
......
......@@ -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 <snf-asterias>`.
:ref:`asterias <asterias>`.
Overview
========
......
.. _snf-asterias-developer-guide:
.. _asterias-developer-guide:
===============
Developer Guide
......@@ -7,9 +7,9 @@ Developer Guide
This is the asterias developer guide.
It is intended for developers, wishing to implement new functionality
inside :ref:`asterias <snf-asterias>`.
inside :ref:`asterias <asterias>`.
It assumes thorough familiarity with the :ref:`snf-asterias-admin-guide`.
It assumes thorough familiarity with the :ref:`asterias-admin-guide`.
It contains development-specific ammendments to the basic installation steps
outlined in `installation guide <installation>`, and development-specific
......@@ -92,24 +92,26 @@ synnefo source
* Clone the repository of the synnefo software components you wish
to work on, e.g.:
.. code-block:: console
(synnefo-env)$ git clone https://code.grnet.gr/git/synnefo synnefo
.. code-block:: console
(synnefo-env)$ git clone https://code.grnet.gr/git/synnefo synnefo
* Install the software components you wish to work on inside the
virtualenv, in development mode:
.. code-block:: console
(synnefo-env)$ cd snf-asterias-app
(synnefo-env)$ python setup.py develop -N
* Initialize database::
(synnefo-env)$ snf-manage syndb
(synnefo-env)$ snf-manage migrate
(synnefo-env)$ snf-manage loaddata users flavors images
.. code-block:: console
(synnefo-env)$ cd snf-asterias-app
(synnefo-env)$ python setup.py develop -N
* Initialize database:
.. code-block:: console
(synnefo-env)$ snf-manage syndb
(synnefo-env)$ snf-manage migrate
(synnefo-env)$ snf-manage loaddata users flavors images
Development tips
****************
......@@ -141,7 +143,7 @@ Development tips
South Database Migrations
-------------------------
.. _snf-asterias-dev-initialmigration:
.. _asterias-dev-initialmigration:
Initial Migration
*****************
......@@ -178,7 +180,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:`snf-asterias-dev-initialmigration`.
:ref:`asterias-dev-initialmigration`.
Every time you make changes to the database and data migration is not required
......@@ -289,7 +291,7 @@ must write the script manually. The process is the following:
(*) 0003_rename_credit_wallet
.. seealso::
More information and more thorough examples can be found in the South web site.
More information and more thorough examples can be found in the South web site,
http://south.aeracode.org/
Test coverage
......
.. _snf-asterias:
.. _asterias:
Asterias Service
----------------
......
......@@ -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 <snf-asterias>`.
by the synnefo's Compute Service, :ref:`asterias <asterias>`.
Currently, it is implemented as an OS definition inside Ganeti.
......
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