Revision 7a3439cf

b/docs/admin-guide.rst
5 5

  
6 6
This is the complete Synnefo Administrator's Guide.
7 7

  
8
Quick Installation
9
==================
10

  
11
The quick installation guide describes how to install the whole synnefo stack
12
in just two physical nodes, for testing purposes. This guide is useful to those
13
interested in deploying synnefo in large scale, as a starting point that will
14
help them get familiar with the synnefo components and overall architecture, as
15
well as the interconnection between different services. Such an installation,
16
also provides a quick preview of the basic synnefo features, although we would
17
like to think that synnefo unveils its real power while scaling.
18

  
19
| :ref:`Administrator's quick installation guide <quick-install-admin-guide>`
20
| This guide will walk you through a complete installation using debian packages.
21

  
22 8
Common administrative tasks
23 9
===========================
24 10

  
......
156 142

  
157 143
.. code-block:: console
158 144

  
159
   $ snf-manage user modify 42 --type ADMIN
145
   $ snf-manage user-modify 42 --type ADMIN
160 146

  
161 147

  
162 148
Adding Astakos "Terms of Use"
......
176 162

  
177 163
.. code-block:: console
178 164

  
179
   $ snf-manage addterms /usr/share/synnefo/sample-terms.html
165
   $ snf-manage term-add /usr/share/synnefo/sample-terms.html
180 166

  
181 167
Your terms have been successfully added and you will see the corresponding link
182 168
appearing in the Astakos web pages' footer.
b/docs/index.rst
45 45
Synnefo Guides
46 46
==============
47 47

  
48
There are 3 guides for Synnefo. The Administrator's Guide targets system
49
administrators, who want to deploy Synnefo on small or large installations. The
50
Developer's Guide targets developers, who want to build on top of Synnefo and so
51
describes all the different types of interfaces Synnefo provides to the external
52
world. The Integrator's Guide targets developers, who want to actually
53
extend/modify/change Synnefo itself, so describes Synnefo's indepth architecture
54
and the internals of Synnefo components.
48
There are 4 guides for Synnefo.
49

  
50
The quick installation guide describes how to install the whole synnefo stack
51
in just two physical nodes, for testing purposes. This guide is useful to those
52
interested in deploying synnefo in large scale, as a starting point that will
53
help them get familiar with the synnefo components and overall architecture, as
54
well as the interconnection between different services. Such an installation,
55
also provides a quick preview of the basic synnefo features, although we would
56
like to think that synnefo unveils its real power while scaling.
57

  
58
The Administrator's Guide targets system administrators, who want to dive into
59
more details and common tasks regarding Synnefo. The Developer's Guide targets
60
developers, who want to build on top of Synnefo and so describes all the
61
different types of interfaces Synnefo provides to the external world. The
62
Integrator's Guide targets developers, who want to actually
63
extend/modify/change Synnefo itself, so describes Synnefo's indepth
64
architecture and the internals of Synnefo components.
65

  
66
.. toctree::
67
   :maxdepth: 1
68

  
69
   Quick Installation Guide <quick-install-admin-guide>
55 70

  
56 71
.. toctree::
57 72
   :maxdepth: 2
b/docs/quick-install-admin-guide.rst
1539 1539
Add the Ganeti backend
1540 1540
----------------------
1541 1541

  
1542
In our installation we assume that we only have one Ganeti cluster. Cyclades can
1543
manage multiple Ganeti backends, but for the purpose of this guide, we won't get
1544
into more detail regarding mulitple backends.
1545

  
1546
By default, when you install Cyclades, it sets up a dummy first backend. You can
1547
see it by running:
1542
In our installation we assume that we only have one Ganeti cluster, the one we
1543
setup earlier in the ``/etc/synnefo/20-snf-cyclades-app-backend.conf`` file.
1544
Cyclades will set up this backend automatically by looking at the above
1545
configuration file. You can see everything has been setup correctly by running:
1548 1546

  
1549 1547
.. code-block:: console
1550 1548

  
1551 1549
   $ snf-manage backend-list
1552 1550

  
1553
We modify this backend to reflect our already setup Ganeti cluster:
1551
If something is not set correctly, you can modify the backend with the
1552
``snf-manage backend-modify`` command. If something has gone wrong, you could
1553
modify the backend to reflect the Ganeti installation by running:
1554 1554

  
1555 1555
.. code-block:: console
1556 1556

  
1557 1557
   $ snf-manage backend-modify --clustername "ganeti.node1.example.com"
1558
                               --username=cyclades
1559
                               --password=example_rapi_passw0rd
1558
                               --user=cyclades
1559
                               --pass=example_rapi_passw0rd
1560 1560
                               1
1561 1561

  
1562 1562
``clustername`` denotes the Ganeti-cluster's name. We provide the corresponding
1563 1563
domain that resolves to the master IP, than the IP itself, to ensure Cyclades
1564 1564
can talk to Ganeti even after a Ganeti master-failover.
1565 1565

  
1566
``username`` and ``password`` denote the RAPI user's username and the RAPI
1567
user's password. We set the above to reflect our :ref:`RAPI User setup
1568
<rapi-user>`. The port is already set to the default RAPI port; you need to
1569
change it, only if you have changed it in your Ganeti cluster setup.
1566
``user`` and ``pass`` denote the RAPI user's username and the RAPI user's
1567
password. We set the above to reflect our :ref:`RAPI User setup <rapi-user>`.
1568
The port is already set to the default RAPI port; you need to change it, only
1569
if you have changed it in your Ganeti cluster setup.
1570 1570

  
1571 1571
Once we setup the first backend to point at our Ganeti cluster, we update the
1572 1572
Cyclades backends status by running:
......
1575 1575

  
1576 1576
   $ snf-manage backend-update-status
1577 1577

  
1578
Add the Public Network
1578
Cyclades can manage multiple Ganeti backends, but for the purpose of this
1579
guide,we won't get into more detail regarding mulitple backends. If you want to
1580
learn more please see /*TODO*/.
1581

  
1582
Add a Public Network
1579 1583
----------------------
1580 1584

  
1585
Cyclades supports different Public Networks on different Ganeti backends.
1581 1586
After connecting Cyclades with our Ganeti cluster, we need to setup the Public
1582
Network:
1587
Network for this Ganeti backend (`id = 1`):
1583 1588

  
1584 1589
.. code-block:: console
1585 1590

  
......
1589 1594
                               --gateway6=2001:648:2FFC:1322::1
1590 1595
                               --public --dhcp --type=PUBLIC_ROUTED
1591 1596
                               --name=public_network
1597
                               --backend-id=1
1592 1598

  
1593 1599
This will create the Public Network on both Cyclades and the Ganeti backend. To
1594 1600
make sure everything was setup correctly, also run:
......
1596 1602
.. code-block:: console
1597 1603

  
1598 1604
   $ snf-manage reconcile-networks
1599
   $ snf-manage reconcile-pools
1600 1605

  
1601 1606
You can see all available networks by running:
1602 1607

  
1603 1608
.. code-block:: console
1604 1609

  
1605
   $ snf-manage listnetworks
1610
   $ snf-manage network-list
1606 1611

  
1607 1612
and inspect each network's state by running:
1608 1613

  

Also available in: Unified diff