Revision 8b5be818 docs/index.rst

b/docs/index.rst
64 64 
Synnefo Guides
65 65 
==============
66 66 

  		





  67
  
  
    
There are 4 guides for Synnefo.


  		





  
  67
  
    
There are 3 guides for Synnefo.


  		





  68
  68
  
    

  		





  69
  69
  
    
.. For the really impatient snf-deploy tool allows you to install all software


  		





  70
  70
  
    
.. components from scratch (creating locally kvm based Virtual Machines) or to an


  		





  ......




  72
  72
  
    
.. configuration, vanilla debian squeeze and installed ssh keys). Please note that


  		





  73
  73
  
    
.. this should be used only for testing or demo installations because most of the


  		





  74
  74
  
    
.. times the prerequisites cannot be satisfied due to the underlying


  		





  75
  
  
    
.. infrastructure complexity (especially as far as networks is conserned).


  		





  
  75
  
    
.. infrastructure complexity (especially as far as networks is concerned).


  		





  76
  76
  
    

  		





  77
  77
  
    
The quick installation guide describes how to install the whole Synnefo stack


  		





  78
  78
  
    
in just two physical nodes, for testing purposes. This guide is useful to those


  		





  79
  79
  
    
interested in deploying Synnefo in large scale, as a starting point that will


  		





  80
  80
  
    
help them get familiar with the Synnefo components and overall architecture, as


  		





  81
  81
  
    
well as the interconnection between different services. Such an installation,


  		





  82
  
  
    
also provides a quick preview of the basic Synnefo features, although we would


  		





  83
  
  
    
like to think that Synnefo's real power unveils while scaling.


  		





  
  82
  
    
also provides a quick preview of the basic Synnefo features, although we like to


  		





  
  83
  
    
think that Synnefo's real power unveils while scaling.


  		





  84
  84
  
    

  		





  85
  85
  
    
The Administrator's Guide targets system administrators, who want to dive into


  		





  86
  86
  
    
more details and common tasks regarding Synnefo. For the experienced Synnefo


  		





  87
  
  
    
administrator, there is also a section that describes how to deploy Synnefo in


  		





  88
  
  
    
large scale with a corresponding guide.


  		





  
  87
  
    
administrator, there is also a section that describes how to do scale-out


  		





  
  88
  
    
Synnefo deployments with corresponding examples. This targets large scale


  		





  
  89
  
    
installations of Synnefo.


  		





  89
  90
  
    

  		





  90
  91
  
    
The Developer's Guide targets developers, who want to build on top of Synnefo


  		





  91
  92
  
    
and so describes all the different types of interfaces Synnefo provides to the


  		





  92
  
  
    
external world. The Integrator's Guide targets developers, who want to actually


  		





  93
  
  
    
extend/modify/change Synnefo itself, so describes Synnefo's indepth


  		





  94
  
  
    
architecture and the internals of Synnefo components (currently out-of-date!).


  		





  
  93
  
    
external world. Also documents all Synnefo external REST APIs.


  		





  
  94
  
    

  		





  
  95
  
    
.. The Integrator's Guide targets developers, who want to actually


  		





  
  96
  
    
.. extend/modify/change Synnefo itself, so describes Synnefo's indepth


  		





  
  97
  
    
.. architecture and the internals of Synnefo components (currently out-of-date!).


  		





  95
  98
  
    

  		





  96
  99
  
    

  		





  97
  100
  
    
.. toctree::


  		





  ......




  104
  107
  
    

  		





  105
  108
  
    
   Administrator's Guide <admin-guide>


  		





  106
  109
  
    
   Developer's Guide <dev-guide>


  		





  107
  
  
    
   Integrator's Guide <intgrt-guide>


  		





  108
  110
  
    

  		





  109
  111
  
    

  		





  110
  112
  
    
List of all Synnefo components


  		












Also available in:
  Unified diff