Commit 95253a10 authored by Kostas Papadimitriou's avatar Kostas Papadimitriou
Browse files

Update cyclades documentation

parent 21f9aa33
......@@ -9,13 +9,64 @@ It implements OpenStack Compute API v1.1 + synnefo extensions.
.. todo:: list synnefo components needed by cyclades
.. _cyclades-introduction:
Cyclades Introduction
=====================
Cyclades is the Compute/Network software component of *synnefo*. Its design combines a Google
Ganeti backend for VM cluster management, with a Python/Django implementation of
the user-visible API at the frontend. We opted to reuse Ganeti as a VM
management solution in an effort not to re-invent the wheel; Ganeti is scalable
and proven software infrastructure for managing VMs in production environments,
and GRNET already had long experience with it, using it to provide VMs to
Network Operation Centers. The synnefo team is involved in Ganeti development,
contributing patches upstream.
Basing our work on Ganeti, we build on a solid, mature core which undertakes
most of the low-level VM management operations, e.g., handling of VM creations,
migrations among physical nodes, and handling of node downtimes; the design and
implementation of the end-user API is orthogonal to VM handling at the backend.
Building on Ganeti gave us a head start, allowing us to focus on creating a
custom cloud management layer, accesible over a consistent, clean end-user API
implementation, and an intuitive Web-based UI. Overall, the software stack is
as follows:
.. image:: images/synnefo-software-stack.png
With *Cyclades*, users have access to VMs powered by KVM, running Linux and
Windows guests on Debian hosts and using Google Ganeti for VM cluster
management. The VMs are accessible by the end-user over the Web or
programmatically (OpenStack Compute API v1.1). Users have full control over
their VMs: they can create new ones, start them, shutdown, reboot, and destroy
them. For the configuration of their VMs they can select number of CPUs, size of
RAM and system disk, and operating system from pre-defined Images including
popular Linux distros (Fedora, Debian, Ubuntu) and MS-Windows Server 2008 R2.
There is an Out-of-Band console over VNC for troubleshooting.
The REST API for VM management, being OpenStack Compute v. 1.1 compatible, can
interoperate with 3rd party tools and client libraries. GRNET has added custom
extensions for yet-unsupported functionality. It has been implemented in Python,
using the Django framework, from scratch.
The *Cyclades* UI is written in Javascript/jQuery and runs entirely on the client
side for maximum reponsiveness. It is just another API client; all UI operations
happen with asynchronous calls over the API.
The networking functionality includes dual IPv4/IPv6 connectivity for each VM,
easy, platform-provided firewalling either through an array of pre-configured
firewall profiles, or through a roll-your-own firewall inside the VM. Users may
create multiple private, virtual L2 networks, so that they construct arbitrary
network topologie, e.g., to deploy VMs in multi-tier configurations. The
networking functionality is exported all the way from the backend to the API and
the UI.
.. _cyclades-architecture:
Cyclades Architecture
=====================
.. todo:: document the overall cyclades architecture
Nodes in an cyclades deployment belong in one of the following types.
For every type, we list the services that execute on corresponding nodes.
Throughout this guide, `node` refers to a physical machine in the deployment.
......
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