Commit fa0fa721 authored by Giorgos Verigakis's avatar Giorgos Verigakis
Browse files

Add documentation material from old wiki

parent cf6e8419
......@@ -6,12 +6,16 @@
Kamaki project documentation
============================
Kamaki is a simple, yet intuitive, command-line tool for managing clouds. Run
.. image:: /images/kamaki-logo.png
./kamaki is a simple, yet intuitive, command-line tool for managing clouds. Run
it without arguments to see a list of available commands.
It is an initial implementation of the OpenStack Compute API, v1.1, with custom
extensions specific to the Synnefo IaaS cloud management software.
./kamaki is open source and released under a 2-clause BSD Licence.
**Warning:** Kamaki is still a work in progress and can not yet authenticate
with *Nova*.
......@@ -21,6 +25,7 @@ Contents:
.. toctree::
:maxdepth: 2
overview
client
......
Overview
========
History
-------
Here, at the `Greek Research and Technology Network <http://grnet.gr/default.asp?pid=1&la=2>`_, we have been developing an IaaS
cloud management software called **synnefo** (or **+nefo**) that is accessed and managed
via the OpenStack Compute API v1.1. We have also recently deployed synnefo in one of our
datacenters to provide the `~okeanos <http://okeanos.grnet.gr/>`_ IaaS service to the Greek Research and Academic
Community (currenty in alpha testing phase).
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.
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.
Who uses ./kamaki?
------------------
./kamaki is currently used internally in GRNET by the development team to test the synnefo
software, by the deployment team who operates the ~okeanos service and by all the alpha
testers using the ~okeanos service and want to access the service from the command line.
Contributing and helping out
----------------------------
For the ./kamaki to improve and be useful to others too, your help is very important.
Any contributions and bug reports will be highly appreciated. Using ./kamaki and sending
us feedback is also a good start.
Community & Support
-------------------
For any problems you may bump into while using ./kamaki or for help from the development
team please refer to the following links:
* Feedback: kamaki-feedback@lists.grnet.gr
* Bug-reports: kamaki-bugs@lists.grnet.gr
* Support: kamaki-support@lists.grnet.gr
* Appear on the ./kamaki users section: kamaki-users@lists.grnet.gr
Please be sure to have read the Documentation and check the known `issues <https://code.grnet.gr/projects/kamaki/issues>`_ before
contacting the team.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment