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

   1 Overview
   2 ========
   3
   4 History
   5 -------
   6
   7 Kamaki was created in 2011 by the `Synnefo <http://www.synnefo.org>`_
   8 development team at 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.
  18
  19 Kamaki was originally conceived as a handy tool for the developers of *Synnefo*
  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
  22 of Synnefo.
  23
  24 Kamaki has been designed to act as a command line client as well as a python
  25 library for client developers. It is widely used in various Synnefo and okeanos
  26 components. Third parties are also encouraged to use the kamaki library for
  27 developing their own python-based cloud applications.
  28
  29 As Synnefo became a full, scalable and stable cloud solution, kamaki also
  30 evolved to an intuitive, multipurpose tool, available to a wider user base.
  31 For example, it is used as the main Pithos+ client in Linux and other Unix-like
  32 environments. It can be easily set up in all popular platforms, including
  33 recent Linux, OS X and Windows releases.
  34
  35 Who uses *kamaki*?
  36 ------------------
  37
  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
  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 `GRNET ~okeanos` service
  46
  47 * as the main `Pithos+` client in Linux and other Unix-like environments, as
  48     well as in windows and osx by users with a preference for command line
  49
  50 * by third-party `Synnefo` deployers for testing and debugging their setup
  51
  52 * as an API library for other components in the Synnefo universe ((`burnin`,
  53     `image-creator`) or external applications
  54
  55 Community & Support
  56 -------------------
  57
  58 The *kamaki* development team values your help and depends on community
  59 feedback for the evolution of new features. Any contributions and bug reports
  60 are highly appreciated.
  61
  62 For any problems you may bump into while using *kamaki* or for help from the
  63 development team please contact us at::
  64
  65 * Users list: synnefo@googlegroups.com
  66 * Developers list: synnefo-devel@googlegroups.com