Revision fa479dc3 docs/overview.rst

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

  
7
Here, at the *Greek Research and Technology Network*, we have been developing an IaaS cloud management software called **synnefo** (or **+nefo**) that is accessed and managed via an extended OpenStack Compute API v1.1. Synnefo has been deployed in many environments to cover multiple needs. For example, the `~okeanos <http://okeanos.grnet.gr>`_ IaaS service, running in our data centers, is used to offer services for the Greek Research and Academic Community.
8

  
9
From the early start, we needed a simple command-line tool to test the OpenStack API. That's why we developed *kamaki*, which proved to be powerful and intuitive enough, to be used not only for testing purposes but also as a complete Openstack Compute API v1.1 client, able to manage our cloud from the command line.
10

  
11
Once it proved so useful to us, we decided to open the source, so the community can benefit from it, and *kamaki* can benefit from the community too.
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 is based on and extents OpenStack.
12
Synnefo has been deployed in many environments to cover multiple needs. The
13
most notable, 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.
17

  
18
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
21
of Synnefo.
22

  
23
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
components. Third parties are also encouraged to use the kamaki library for
26
developing their own python-based cloud-client applications.
27

  
28
As Synnefo became a full, scalable and stable cloud solution, kamaki also
29
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
environments. It can be easily set up in all popular platforms, including
32
recent Linux, OS X and Windows releases.
12 33

  
13 34
Who uses *kamaki*?
14 35
------------------
15 36

  
16
Kamaki is targeted to new and advanced users who need an intuitive managerial console tool to manage a local or remote synnefo cloud installation.
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)
40

  
41
*kamaki* is currently used
17 42

  
18
*kamaki* is currently used (i) internally by the Synnefo development team to test the synnefo software, (ii) by the deployment team which operates the GRNET ~okeanos service and (iii) by the testers using the ~okeanos service or other synnefo installations and want to access the services from command line.
43
* internally by the Synnefo development team to test the synnefo software,
19 44

  
20
What's more, (iv) *kamaki* clients API is used in synnefo as an API for accessing remote services as well as (v) for building manager tools of various synnefo functions (e.g. image registration).
45
* by the deployment team which operates the GRNET ~okeanos service
21 46

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

  
49
* by third party Synnefo deploys who need to test and debug their cloud setup
50

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

  
23 53
Contributing and helping out
24 54
----------------------------
25 55

  
26
The *kamaki* development team values your help and depends on community feedback for feature evolution. Any contributions and bug reports will be highly appreciated. Using *kamaki* and sending us feedback is also a good start.
27

  
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.
28 58

  
29 59
Community & Support
30 60
-------------------

Also available in: Unified diff