code.grnet.gr Git - kamaki/blob - docs/overview.rst

   1 Overview
   2 ========
   3
   4 History
   5 -------
   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.
  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.
  33
  34 Who uses *kamaki*?
  35 ------------------
  36
  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
  42
  43 * internally by the Synnefo development team to test the synnefo software,
  44
  45 * by the deployment team which operates the GRNET ~okeanos service
  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.
  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 Community & Support
  60 -------------------
  61
  62 For any problems you may bump into while using *kamaki* or for help from the development team please contact us at::
  63
  64 * Users list: synnefo@googlegroups.com
  65 * Developers list: synnefo-devel@googlegroups.com
  66
  67 Bug reports and feedback are also highly appreciated.