Synnefo » ./kamaki

Quick Setup

-----------

Kamaki has to be configured for a specific Synnefo deployment, with an

authentication url and user token pair. Users should also pick an alias to name

.. code-block:: console

Since version 0.14, Synnefo supports a single authentication URL for retrieving

all API endpoints. This URL is retrieved from the Synnefo Web UI and should be

set as the cloud URL for kamaki. All service-specific URLs are retrieved and

This section refers to running installations of kamaki version <= 0.8.X. To

check the current kamaki version:

Existing kamaki users should convert their configuration files to v9. To do

that, kamaki 0.9 can inspect the configuration file and suggests a list of

.. code-block:: console

    :emphasize-lines: 1

    Overwrite file /home/exampleuser/.kamakirc ? [Y, y]

At this point, we should examine the kamaki output. Most options are renamed to

Let's take a look at the discarded options:

    meaningless and therefore omitted.

* `global.data_log` option has never been a valid kamaki config option.

.. code-block:: console

    :emphasize-lines: 1

The following refers to users of multiple Synnefo and/or Open Stack

deployments. In the following, a Synnefo or Open Stack cloud deployment will

Once a user has retrieved one URL/token pair per cloud, it is time to assign a

For example, let the user have access to two clouds with the following authentication information ::

    authentication token: my73571ng70k3n==

.. note:: the cloud alias is arbitrary and decided by the user. It is just a

The user should let kamaki know about these setups:

.. code-block:: console

     cloud.default.url = https://example.com/astakos.identity/v2.0/

     cloud.devel.url = https://devel.example.com/astakos/identity/v2.0/

     cloud.devel.token = myd3v3170k3n==

     cloud.testing.url = https://testing.example.com/astakos/identity/v2.0/

        name       :  Default User

    $

the **- - cloud** option.

Optional features

-----------------

    * Allow unit tests to run on kamaki.clients package

    * Needs mock version 1.X or better

Any of the above features can be installed at any time before or after kamaki

installation.

* kamaki-related (global)

    interface settings and constants of the kamaki internal mechanism, e.g.,

* cloud-related

    information needed to connect and use one or more clouds. There are some

Modifying options at runtime

^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. code-block:: console

will invoke *kamaki file list* with the specified options, but the initial

global.pithos_container values will not be modified.

Editing options

^^^^^^^^^^^^^^^

Kamaki config command allows users to see and manage all configuration options.

* kamaki config list

* kamaki config get <group.option>

    show the value of a specific configuration option. Options must be of the

* kamaki config set <group.option> <value>

    *global*.

* kamaki config delete <group.option>

    *global*

The above commands cause option values to be permanently stored in the Kamaki configuration file.

        delete the <option> and its value from the cloud cloud aliased as

        <cloud alias>

    .. code-block:: console

        $ kamaki config get default_cloud

Editing the configuration file

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The configuration file is a simple text file that can be created by the user.

A simple way to create the configuration file is to set a configuration option

using the kamaki config command. For example:

    url =

    token =

Available options

^^^^^^^^^^^^^^^^^

settings, namely command cli specifications, the thread limit, console colors,

history and log files, log detail options and pithos-specific options.

    allow kamaki to log http data (by default, it logs only method, URL and

    headers)

* global.file_cli <UI command specifications for file>

    a special package that is used to load storage commands to kamaki UIs.

    Don't touch this unless if you know what you are doing.

Additional features

^^^^^^^^^^^^^^^^^^^

    [global]

    livetest_cli=livetest

or with this kamaki command::

Here is a list of settings needed:

* for astakos client::

    * livetest.astakos_details = <A file with an authentication output>

        To create this file, pipeline the output of an authentication command

        .. code-block:: console

            $ kamaki user authenticate -j > astakos.details

    * livetest.astakos_id = <The valid unique user id of the testing user>

* for image client:

        To create this file, pipeline the output of an image metadata command

        .. code-block:: console

* for flavors (part of the compute client):

    * livetest.flavor_details = <A file with the flavor details>

        To create this file, pipeline the output of a flavor info command

        .. code-block:: console

    $ kamaki livetest all

The unit testing system

"""""""""""""""""""""""

Kamaki container a set of finegrained unit tests for the kamaki.clients

package. This set is not used when kamaki is running. Instead, it is aimed to

`Going Agile <developers/extending-clients-api.html#going-agile>`_ entry at the

`developers section <developers/extending-clients-api.html>`_.