Synnefo

.. todo:: turn all of the following to links to the documentation, with

   with intersphinx links.

   compute (name TBD): Compute Service <src/compute.rst>

.. _snf-compute-admin-guide:

This is the snf-compute administrator guide.

the synnefo components necessary to deploy the Compute Service. It also covers

maintenance issues, e.g., upgrades of existing deployments.

Compute architecture

    Node types needed for a complete deployment of snf-compute,

    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 snf-compute, either from source packages or the provided

    packages for Debian Squeeze.

Configuration

    Configuration of the various software components comprising an snf-compute

Upgrades

Changelogs

Architecture

------------

truth for the servicing of API requests by snf-compute.

A WEBAPP node runs the web application provided by the synnefo component

:ref:`snf-app <snf-app>`.

API Guide

*********

.. todo:: Document the relation of the API to the OpenStack API v1.1.

This is the guide to the REST API of the synnefo Compute Service.

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:`snf-compute <snf-compute>`.

* It is not defined if requests for invalid URLs should return 404 or a Fault.

  We return a BadRequest Fault.

* It is not defined if requests with a wrong HTTP method should return 405 or a

  Fault. We return a BadRequest Fault.

* We only support JSON Requests and JSON/XML Responses. XML Requests are not

  supported for now.

* Deployment note: "To prevent abuse, HTTP sessions have a timeout of 20

  seconds before being closed."

* We only support the changes-since parameter in **List Servers** and **List

  Images**.

* We assume that garbage collection of deleted servers will only affect servers

  deleted ``POLL_TIME`` seconds in the past or earlier. Else we lose the

  information of a server getting deleted.

* We hardcode the ``updated`` field in versions list

* ``hostId`` is always empty.

* ``affinityId`` is not returned.

* ``progress`` is always returned.

* ``self`` and ``bookmark`` atom links are not returned.

* **Create Server** ignores ``personality`` of requests.

* **List Servers** returns just ``id`` and ``name`` if details are not

  requested.

* **List Servers** can return 304 (even though not explicitly stated) when

  ``changes-since`` is given.

**Example List Servers: JSON**

.. code-block:: javascript

**Error Response Codes**: computeFault (400, 500), serviceUnavailable (503),

unauthorized (401), badRequest (400), itemNotFound (404), overLimit (413)

This operation returns URLs to graphs showing CPU and Network statistics. A

``refresh`` attribute is returned as well that is the recommended refresh rate

of the stats for the clients.

**Example Get Server Stats Response: JSON**:

.. code-block:: javascript

**Example Get Network Details Response: XML**:

.. code-block:: xml

**Example Action Start: JSON**:

.. code-block:: javascript

**Example Action Shutdown: JSON**:

.. code-block:: javascript

**Example Action Console: JSON**:

.. code-block:: javascript

**Example Action Console Response: JSON**:

.. code-block:: javascript

**Example Action Console Response: XML**:

.. code-block:: xml

**Error Response Codes**: computeFault (400, 500), serviceUnavailable (503),

unauthorized (401), badRequest (400), badMediaType(415), itemNotFound (404),

buildInProgress (409), overLimit (413)

The firewallProfile function sets a firewall profile for the public interface

of a server.

**Example Action firewallProfile: JSON**:

.. code-block:: javascript

* ``self`` and ``bookmark`` atom links are not returned.

* **List Flavors** returns just ``id`` and ``name`` if details is not requested.

* ``progress`` is always returned.

* ``self`` and ``bookmark`` atom links are not returned.

* **List Images** returns just ``id`` and ``name`` if details are not requested.

* **List Images** can return 304 (even though not explicitly stated) when

  ``changes-since`` is given. 

* **List Images** does not return deleted images when ``changes-since`` is given.

* **Update Server Metadata** and **Update Image Metadata** will only return the

  metadata that were updated (some could have been skipped).

A Server can connect to one or more networks identified by a numeric id. Each

user has access only to networks created by himself. When a network is deleted,

all connections to it are deleted. Likewise, when a server is deleted, all

connections of that server are deleted.

There is a special **public** network with the id *public* that can be accessed

at */networks/public*. All servers are connected to **public** by default and

this network can not be deleted or modified in any way.

**Error Response Codes**: computeFault (400, 500), serviceUnavailable (503),

unauthorized (401), badRequest (400), overLimit (413)

**Example Networks List Response: JSON (detail)**:

.. code-block:: javascript

**Example Networks List Response: XML (detail)**:

.. code-block:: xml

**Error Response Codes**: computeFault (400, 500), serviceUnavailable (503),

unauthorized (401), badMediaType(415), badRequest (400), overLimit (413)

**Example Create Network Request: JSON**:

.. code-block:: javascript

**Example Create Network Response: JSON**:

.. code-block:: javascript

**Example Create Network Response: XML**:

.. code-block:: xml

**Error Response Codes**: computeFault (400, 500), serviceUnavailable (503),

unauthorized (401), badRequest (400), itemNotFound (404), overLimit (413)

**Example Get Network Details Response: JSON**:

.. code-block:: javascript

**Error Response Codes**: computeFault (400, 500), serviceUnavailable (503),

unauthorized (401), badRequest (400), badMediaType(415), itemNotFound (404),

overLimit (413) 

.. code-block:: javascript

**Error Response Codes**: computeFault (400, 500), serviceUnavailable (503),

unauthorized (401), itemNotFound (404), unauthorized (401), overLimit (413) 

**Error Response Codes**: computeFault (400, 500), serviceUnavailable (503),

unauthorized (401), badRequest (400), badMediaType(415), itemNotFound (404),

overLimit (413)

**Example Action Add: JSON**:

.. code-block:: javascript

**Error Response Codes**: computeFault (400, 500), serviceUnavailable (503),

unauthorized (401), badRequest (400), badMediaType(415), itemNotFound (404),

overLimit (413)

**Example Action Remove: JSON**:

.. code-block:: javascript

.. _snf-compute:

Compute Service

----------------

The Compute Service implements the OpenStack Compute API v1.1.

.. todo:: document the Compute Service.

.. toctree::

   :maxdepth: 2

   admin-guide

   api

..   src/design

..   src/dev

..   src/user

..   src/api

..   src/install

..   src/configuration

..   src/deployment

..   src/admin

..   src/admin_tools

..   src/develop

..   src/api

..   src/plankton

..   src/storage

..   src/upgrade

..   src/changelog

Indices and tables

==================

* :ref:`genindex`

* :ref:`modindex`

* :ref:`search`