Commit e3a1d743 authored by Stavros Sachtouris's avatar Stavros Sachtouris

Documentation updates

parent f5d9bc54
......@@ -92,17 +92,17 @@ Showcase: Pick an image and list the properties
* list all available images *
[image]:list
1395fdfb-51b4-419f-bb02-f7d632860611 (Ubuntu Desktop LTS)
1580deb4-edb3-4496-a27f-7a246c4c0528 (Ubuntu Desktop)
18a82962-43eb-4b32-8e28-8f8880af89d7 (Kubuntu LTS)
6aa6eafd-dccb-422d-a904-67fe2bdde87e (Debian Desktop)
6b5681e4-7502-46ae-b1e9-9fd837932095 (maelstrom)
78262ee7-949e-4d70-af3a-85360c3de57a (Windows Server 2012)
86bc2414-0fb3-4898-a637-240292243302 (Fedora)
926ab1c5-2d85-49d4-aebe-0fce712789b9 (Windows Server 2008)
b2dffe52-64a4-48c3-8a4c-8214cc3165cf (Debian Base)
baf2321c-57a0-4a69-825d-49f49cea163a (CentOS)
c1d27b46-d875-4f5c-b7f1-f39b5af62905 (Kubuntu)
1395fdfb-51b4-419f-bb02-f7d632860611 Ubuntu Desktop LTS
1580deb4-edb3-4496-a27f-7a246c4c0528 Ubuntu Desktop
18a82962-43eb-4b32-8e28-8f8880af89d7 Kubuntu LTS
6aa6eafd-dccb-422d-a904-67fe2bdde87e Debian Desktop
6b5681e4-7502-46ae-b1e9-9fd837932095 maelstrom
78262ee7-949e-4d70-af3a-85360c3de57a Windows Server 2012
86bc2414-0fb3-4898-a637-240292243302 Fedora
926ab1c5-2d85-49d4-aebe-0fce712789b9 Windows Server 2008
b2dffe52-64a4-48c3-8a4c-8214cc3165cf Debian Base
baf2321c-57a0-4a69-825d-49f49cea163a CentOS
c1d27b46-d875-4f5c-b7f1-f39b5af62905 Kubuntu
* Get properties of image with id b2dffe52-64a4-48c3-8a4c-8214cc3165cf *
[image]:properties b2dffe52-64a4-48c3-8a4c-8214cc3165cf
......@@ -166,17 +166,17 @@ Showcase: Create a server
* List all available images *
[server]:/image list
1395fdfb-51b4-419f-bb02-f7d632860611 (Ubuntu Desktop LTS)
1580deb4-edb3-4496-a27f-7a246c4c0528 (Ubuntu Desktop)
18a82962-43eb-4b32-8e28-8f8880af89d7 (Kubuntu LTS)
6aa6eafd-dccb-422d-a904-67fe2bdde87e (Debian Desktop)
6b5681e4-7502-46ae-b1e9-9fd837932095 (maelstrom)
78262ee7-949e-4d70-af3a-85360c3de57a (Windows Server 2012)
86bc2414-0fb3-4898-a637-240292243302 (Fedora)
926ab1c5-2d85-49d4-aebe-0fce712789b9 (Windows Server 2008)
b2dffe52-64a4-48c3-8a4c-8214cc3165cf (Debian Base)
baf2321c-57a0-4a69-825d-49f49cea163a (CentOS)
c1d27b46-d875-4f5c-b7f1-f39b5af62905 (Kubuntu)
1395fdfb-51b4-419f-bb02-f7d632860611 Ubuntu Desktop LTS
1580deb4-edb3-4496-a27f-7a246c4c0528 Ubuntu Desktop
18a82962-43eb-4b32-8e28-8f8880af89d7 Kubuntu LTS
6aa6eafd-dccb-422d-a904-67fe2bdde87e Debian Desktop
6b5681e4-7502-46ae-b1e9-9fd837932095 maelstrom
78262ee7-949e-4d70-af3a-85360c3de57a Windows Server 2012
86bc2414-0fb3-4898-a637-240292243302 Fedora
926ab1c5-2d85-49d4-aebe-0fce712789b9 Windows Server 2008
b2dffe52-64a4-48c3-8a4c-8214cc3165cf Debian Base
baf2321c-57a0-4a69-825d-49f49cea163a CentOS
c1d27b46-d875-4f5c-b7f1-f39b5af62905 Kubuntu
* See details of flavor with id 1 *
[server]:/flavor info 1
......@@ -207,7 +207,7 @@ Showcase: Create a server
* wait for server to build (optional) *
[server]:wait 11687
Server 11687 still in BUILD mode ||||||||||||||||| | 80% - 3s
Server 11687 still in BUILD mode ||||||||||||||||| | 80%
Server 11687 is now in ACTIVE mode
.. Note:: In kamaki shell, / is used to access top-level command groups while working in command group contexts
......
......@@ -60,7 +60,7 @@ copyright = u'2012, GRNET'
# The short X.Y version.
version = '0.6'
# The full version, including alpha/beta/rc tags.
release = '0.6.2'
release = '0.6.3'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
......
......@@ -7,7 +7,7 @@ Since version 0.6 it is safe to use threaded connections.
The Connection package uses httplib, standard python threads and a connection pooling mechanism.
.. note:: in versions 0.6.0 to 0.6.1 the GRNET Synnefo *snf-common* package is used for its connection pooling module. Since version 0.6.2 the underlying pooling mechanism is packed in a new GRNET package called *objpool*, which is now used instead of snf-common.
.. note:: Since version 0.6.2 the underlying pooling mechanism is packed in a new GRNET package called *objpool*.
.. automodule:: kamaki.clients.connection
:members:
......
......@@ -22,20 +22,22 @@ Add the following to apt sources list
As root, append one of the following to */etc/apt/sources.list*:
* Debian Stable (kamaki 0.6.2)::
* Debian Stable::
deb http://apt.dev.grnet.gr/ squeeze main
deb http://apt2.dev.grnet.gr stable/
* Ubuntu (kamaki 0.6.2)::
* Ubuntu::
deb http://apt.dev.grnet.gr/ precise main
deb http://ppa.launchpad.net/grnet/synnefo/ubuntu <UBUNTU_VERSION> main
deb-src http://ppa.launchpad.net/grnet/synnefo/ubuntu <UBUNTU_VERSION> main
where <UBUNTU_VERSION> is the system Ubuntu version (e.g. precise)
Update
""""""
.. note:: make sure the GPG public key for the GRNET dev team is added:
* In Debian, make sure the GPG public key for the GRNET dev team is added:
.. code-block:: console
......@@ -43,6 +45,15 @@ Update
otherwise *apt-get update* will produce GPG warnings.
* In Ubuntu, make sure the correct PPA signing key is installed:
.. code-block:: console
$ sudo apt-get install python-software-properties
$ sudo add-apt-repository ppa:grnet/synnefo
Finally:
.. code-block:: console
$ sudo apt-get update
......@@ -51,13 +62,7 @@ Update
Install kamaki
""""""""""""""
.. note:: **versions 0.6.0 - 0.6.1 only:**
The *snf-common* package (available at synnefo apt repository) will be automatically installed as a dependency.
.. note:: **versions 0.6.2 and on:**
Since version 0.6.2, *objpool* replaces *snf-common*. The objpool package is also available at synnefo repository and is automatically installed as a dependency. The *snf-common* dependency is removed.
.. note:: The objpool package is available at synnefo repositories and is automatically installed as a dependency.
.. code-block:: console
......@@ -103,19 +108,6 @@ A more detailed example of using virtual env can be found at the `snf-image-crea
Install objpool (was: snf-common)
"""""""""""""""""""""""""""""""""
.. note:: **versions 0.6.0 - 0.6.1 only**
Package snf-common is part of the synnefo project and used to be a kamaki dependency in versions from 0.6.0 to 0.6.1 to provide a connection pooling mechanism. Users who still run 0.6.0 or 0.6.1 may need to manually install the snf-common package:
.. code-block:: console
$ git clone http://code.grnet.gr/git/synnefo
$ cd synnefo/snf-common
$ ./setup build install
$ cd -
**Version 0.6.2 and on:**
Since 0.6.2, kamaki is based on python-objpool. The objpool package is easy to install from source (even on windows platforms):
.. code-block:: console
......@@ -128,7 +120,7 @@ Since 0.6.2, kamaki is based on python-objpool. The objpool package is easy to i
Install kamaki
""""""""""""""
Kamaki can be downloaded from `here <https://code.grnet.gr/projects/kamaki/files>`_, where users can pick the version they prefer and unzip it locally:
Kamaki can be downloaded from `this location <https://code.grnet.gr/projects/kamaki/files>`_, where users can pick the version they prefer and unzip it locally:
.. code-block:: console
......@@ -143,6 +135,7 @@ or it can be downloaded directly from the git repository:
and then installed by the setup script:
.. code-block:: console
$ cd kamaki
$ ./setup build install
......
......@@ -175,7 +175,7 @@ Since version 0.6.1 kamaki contains a test suite for the kamaki.clients API. The
After that, users can run "kamaki test" commands to unit-test the prepackaged client APIs. Unit-tests are still experimental and there is a high probability of false alarms due to some of the expected values being hard-coded in the testing code.
In version 0.6.3, a quotaholder client is introduced as an advanced feature. Quotaholder client is mostly used as a client library for accessing a synnefo quota service, but it can also be allowed as a kamaki command set, but setting the quotaholder.cli and quotaholder.url methods:
Since version 0.6.3, a quotaholder client is introduced as an advanced feature. Quotaholder client is mostly used as a client library for accessing a synnefo quota service, but it can also be allowed as a kamaki command set, but setting the quotaholder.cli and quotaholder.url methods:
[quotaholder]
cli=quotaholder_cli
......
......@@ -270,7 +270,7 @@ The astakos-authenticate command in example 3.4.1 run against an explicitly prov
Interactive shell
-----------------
Kamaki interactive shell is details in this section
Kamaki interactive shell is detailed in this section
Command Contexts
^^^^^^^^^^^^^^^^
......@@ -477,11 +477,10 @@ It is often the case that a user who works in the context command, needs to crea
[server]:/flavor list
...
20. AFLAVOR
43 AFLAVOR
SNF:disk_template: drbd
cpu : 4
disk : 10
id : 43
ram : 2048
[server]:/image list
......@@ -493,7 +492,7 @@ It is often the case that a user who works in the context command, needs to crea
[server]:create 'my debian' 43 6aa6eafd-dccb-67fe2bdde87e
...
An other example (4.3.2) showcases how to acquire and modify configuration settings from a different context. In this scenario, the user token expires at server side while the user is working. When that happens, the system responds with an *(401) UNAUTHORIZED* message. The user can acquires a new token (with a browser) which has to be set to kamaki.
An other example (4.3.2) showcases how to acquire and modify configuration settings from a different context. In this scenario, the user token expires at server side while the user is working. When that happens, the system responds with an *(401) UNAUTHORIZED* message. The user can acquire a new token (with a browser) which has to be set to kamaki.
.. code-block:: console
:emphasize-lines: 1
......@@ -519,6 +518,8 @@ An other example (4.3.2) showcases how to acquire and modify configuration setti
1. pithos (10MB, 2 objects)
2. trash (0B, 0 objects)
.. note:: actual kamaki error messages are more helpful and descriptive.
The following example compares some equivalent calls that run *astakos-authenticate* after a *store-list* 401 failure.
.. code-block:: console
......@@ -617,9 +618,9 @@ Permanent history is implemented as a command group and is common to both the on
Scripting
^^^^^^^^^
Since version 6.2, the history-load feature allows the sequential execution of previously run kamaki commands in kamaki shell.
Since version 6.2, the history-run feature allows the sequential execution of previously run kamaki commands in kamaki shell.
The following kamaki sequence copies and downloads a file from mycontainer1, uploads it to mycontainer2, then undo the proccess and repeats it with history-load
The following kamaki sequence copies and downloads a file from mycontainer1, uploads it to mycontainer2, then undo the proccess and repeats it with history-run
.. code-block:: console
:emphasize-lines: 1,12,19,32
......@@ -663,7 +664,7 @@ The following kamaki sequence copies and downloads a file from mycontainer1, upl
store upload mylocalfile mycontainer2:myfile
Upload completed
The above strategy is still very primitive. Users are advised to take advantage of their os shell scripting capabilities and combine them with kamaki one-command for powerful scripting. Still, the history-load functionality might prove handy for kamaki shell users.
The above strategy is still very primitive. Users are advised to take advantage of their os shell scripting capabilities and combine them with kamaki one-command for powerful scripting. Still, the history-run functionality might prove handy for kamaki shell users.
Tab completion
^^^^^^^^^^^^^^
......
......@@ -31,4 +31,4 @@
# interpreted as representing official policies, either expressed
# or implied, of GRNET S.A.
__version__ = '0.6.2'
__version__ = '0.6.3'
......@@ -34,7 +34,7 @@
# or implied, of GRNET S.A.
from setuptools import setup
from sys import version_info
#from sys import version_info
import collections
import kamaki
......
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