Synnefo

.. _scale-up:

.. _physical-node-roles:

* **NS**: A nameserver serving all other Synnefo nodes and resolving Synnefo FQDNs

The `snf-deploy` tool allows you to automatically deploy Synnefo.

You can use `snf-deploy` to deploy Synnefo, in two ways:

1. Create a virtual cluster on your local machine and then deploy on that cluster.

2. Deploy on a pre-existent cluster of physical nodes.

Currently, `snf-deploy` is mostly useful for testing/demo installations and is not

recommended for production environment Synnefo deployments. If you want to deploy

Synnefo in production, please read first the :ref:`Admin's quick installation

guide <quick-install-admin-guide>` and then the :ref:`Admin's guide

<admin-guide>`.

If you use `snf-deploy` you will setup an up-and-running Synnefo installation, but

the end-to-end functionality will depend on your underlying infrastracture (e.g.

is nested virtualization enabled in your PC, is the router properly configured, do

nodes have fully qualified domain names, etc.). In any way, it will enable you to

get a grasp of the Web UI/API and base funtionality of Synnefo and also provide a

proper configuration that you can afterwards consult while reading the Admin

guides to set up a production environment that will scale up and use all available

features (e.g. RADOS, Archipelago, etc).

`snf-deploy` is a debian package that should be installed locally and allows you

to install Synnefo on remote nodes (if you go for (2)), or spawn a cluster of VMs

on your local machine using KVM and then install Synnefo on this cluster (if you

go for (1)). To this end, here we will break down our description into three

sections:

a. `snf-deploy` configuration

b. Creating a virtual cluster (needed for (1))

c. Synnefo deployment (either on virtual nodes created on section b, or on

   remote physical nodes)

If you go for (1) you will need to walk through all the sections. If you go for

(2), you should skip section (b), since you only need sections (a) and (c).

Before getting any further we should mention the roles that `snf-deploy` refers

to. The roles are described :ref:`here <physical-node-roles`. Note that multiple

roles can co-exist in the same node (virtual or physical).

Currently, `snf-deploy` recognizes the following combined roles:

* **astakos** = **WEBSERVER** + **ASTAKOS**

* **pithos** = **WEBSERVER** + **PITHOS**

* **cyclades** = **WEBSERVER** + **CYCLADES**

* **db** = **ASTAKOS_DB** + **PITHOS_DB** + **CYCLADES_DB**

the following independent roles:

* **cms** = **CMS**

* **mq** = **MQ**

* **ns** = **NS**

* **client** = **CLIENT**

* **router**: The node to do any routing and NAT needed

The above define the roles relative to the Synnefo components. However, in

order to have instances up-and-running, at least one backend must be associated

with Cyclades. Backends are Ganeti clusters each with multiple

**GANETI_NODE**s. Please note that these nodes may be the same as the ones used

for the previous roles. To this end, `snf-deploy` also recognizes:

* **ganeti_backend** = **G_BACKEND** = All available nodes of a specific backend

* **ganeti_master** = **GANETI_MASTER**

Finally, it recognizes the group role:

* **existing_nodes** = **SYNNEFO** + (N x **G_BACKEND**)

In the future, `snf-deploy` will recognize all the independent roles of a scale

out deployment as stated in the :ref:`scale up section <scale-up>`. When that's

done it won't need to introduce its own roles (stated here with lowercase) but

rather use the scale out ones (stated with uppercase on the admin guide).

Configuration (a)

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

All configuration of `snf-deploy` happens by editting the following files under

``/etc/snf-deploy``:

Virtual Cluster Creation (b)

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

Synnefo Installation (c)

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

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

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

snf-deploy as a DevTool

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