Revision abfaa6d9 docs/overview.rst

b/docs/overview.rst
4 4
History
5 5
-------
6 6

  
7
Kamaki was created on 2011 by the Synnefo (http://www.synnefo.org) development
8
team of the *Greek Research and Technology Network (GRNET)*, initially as an
9
internal project and later as a multipurpose tool for all users.
10

  
11
Synnefo is an IaaS system which implements and extents OpenStack. Synnefo has
12
been deployed in many environments to cover multiple needs. The most notable
13
deployment is probably the GRNET's
14
`~okeanos <http://okeanos.grnet.gr>`_ IaaS service, running in GRNET data
15
centers, is used to offer cloud services to the Greek Research and Academic
16
Community.
7
Kamaki was created in 2011 by the `Synnefo <http://www.synnefo.org>`_
8
development team of the *Greek Research and Technology Network (GRNET)*,
9
initially as an internal project and later as a multipurpose tool for all
10
users.
11

  
12
Synnefo is open source cloud software used to create massively scalable IaaS
13
clouds. It uses Google Ganeti for the low level VM management. It talks to
14
the outside world through the OpenStack APIs with extensions for advanced
15
operations. Synnefo is used by GRNET to power its
16
`~okeanos <http://okeanos.grnet.gr>`_ service, providing cloud services to the
17
whole Greek research and academic community. 
17 18

  
18 19
Kamaki was originally conceived as a handy tool for the developers of *Synnefo*
19
and the administrators of *Okeanos*. The initial purpose of kamaki was to
20
provide an easy to use command line client for accessing the various ReST APIs
20
and the administrators of *~okeanos*. The initial purpose of kamaki was to
21
provide an easy to use command-line client for accessing the various ReST APIs
21 22
of Synnefo.
22 23

  
23 24
Kamaki has been designed to act as a command line client as well as a python
24
library for client developers. It is widely used in various synnefo and okeanos
25
library for client developers. It is widely used in various Synnefo and okeanos
25 26
components. Third parties are also encouraged to use the kamaki library for
26 27
developing their own python-based cloud-client applications.
27 28

  
28 29
As Synnefo became a full, scalable and stable cloud solution, kamaki also
29 30
evolved to an intuitive, multipurpose tool, available to a wider user base.
30
For example, it is used as the main Pithos+ client at Linux and other Unix-like
31
For example, it is used as the main Pithos+ client in Linux and other Unix-like
31 32
environments. It can be easily set up in all popular platforms, including
32 33
recent Linux, OS X and Windows releases.
33 34

  
34 35
Who uses *kamaki*?
35 36
------------------
36 37

  
37
Kamaki is targeted to new and advanced users who need an intuitive managerial console tool to manage a local or remote synnefo cloud installation, without
38
excluding users who need to use just parts of the cloud system (e.g. only
39
Pihtos+ storage service or only Image services)
38
Kamaki is targeted to new and advanced users who need an intuitive
39
command-line tool for managing a local or remote Synnefo deployment.
40 40

  
41 41
*kamaki* is currently used
42 42

  
43
* internally by the Synnefo development team to test the synnefo software,
43
* internally by the Synnefo development team to test the Synnefo software,
44 44

  
45
* by the deployment team which operates the GRNET ~okeanos service
45
* by the deployment team which operates GRNET's ~okeanos service
46 46

  
47
* as the main Pithos+ client at Linux and other Unix-like environments
47
* as the main Pithos+ client in Linux and other Unix-like environments
48 48

  
49
* by third party Synnefo deploys who need to test and debug their cloud setup
49
* by third-party Synnefo deployers for testing and debugging their setup
50 50

  
51 51
* as an API library for other components in the Synnefo universe.
52 52

  
53
Contributing and helping out
54
----------------------------
55

  
56
The *kamaki* development team values your help and depends on community feedback for feature evolution. Any contributions and bug reports will be
57
highly appreciated.
58

  
59 53
Community & Support
60 54
-------------------
61 55

  
62
For any problems you may bump into while using *kamaki* or for help from the development team please contact us at::
56
The *kamaki* development team values your help and depends on community
57
feedback for the evolution of new features. Any contributions and bug reports
58
are highly appreciated.
59

  
60
For any problems you may bump into while using *kamaki* or for help from the
61
development team please contact us at::
63 62

  
64 63
* Users list: synnefo@googlegroups.com
65 64
* Developers list: synnefo-devel@googlegroups.com
66

  
67
Bug reports and feedback are also highly appreciated.

Also available in: Unified diff