Add documentation and examples for logging

[kamaki] / docs / setup.rst

Setup
=====

Kamaki is easy to install from source or as a package. Some advanced or ui features
are optional and can be installed separately. Kamaki behavior can be configured in
the kamaki config file.

Quick Setup
-----------

Existing kamaki users should consult the
`migration guide <#migrating-from-kamaki-0-8-x-to-0-9>`_ first.

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
the cloud configuration. This can be any single word, e.g. "default", "mycloud"
or whatever suits kamaki users.

.. code-block:: console
    
    $ kamaki config set cloud.<cloud alias>.url <cloud-authentication-URL>
    $ kamaki config set cloud.<cloud alias>.token myt0k3n==

If only one cloud is configured, kamaki automatically picks it as the default.
Otherwise, a default cloud should be specified:

.. code-block:: console

    $ kamaki config set default_cloud <cloud alias>

Since Synnefo version 0.14, a synnefo cloud UI offers a single authentication
URL, which should be set as the cloud URL for kamaki. All service-specific URLs
are retrieved and handled automatically by kamaki, through this URL. Users of
synnefo clouds >=0.14 are advised against using any service-specific URLs.

Migrating from kamaki 0.8.X to 0.9
----------------------------------

This section refers to running installations of kamaki version <= 0.8.X To
check the current kamaki version:

.. code-block:: console

    $ kamaki -V

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
config file transformations, which are performed automatically (after users'
permission). This mechanism is invoked when an API-related kamaki command is
fired. On example 2.1 we suggest using the `user authenticate` command to fire
the kamaki config file conversion mechanism.

.. code-block:: console
    :emphasize-lines: 1

    Example 2.1: Convert config file while authenticating user "exampleuser"

    $ kamaki user authenticate
    Config file format version >= 9.0 is required
    Configuration file: "/home/exampleuser/.kamakirc"
    but kamaki can fix this:
    Calculating changes while preserving information
    ... rescue global.token => cloud.default.token
    ... rescue config.cli => global.config_cli
    ... rescue history.file => global.history_file
    ... DONE
    The following information will NOT be preserved:
        global.account = 
        global.data_log = on
        user.account = exampleuser@example.com
        user.url = https://accounts.okeanos.grnet.gr
        compute.url = https://cyclades.okeanos.grnet.gr/api/v1.1
        file.url = https://pithos.okeanos.grnet.gr/v1
        image.url = https://cyclades.okeanos.grnet.gr/plankton

    Kamaki is ready to convert the config file to version 9.0
    Overwrite file /home/exampleuser/.kamakirc ? [Y, y]

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

Let's take a look at the discarded options:

* `global.account` and `user.account` are not used anymore.
    The same is true for the synonyms `store.account` and `pithos.account`.
    These options were used to explicitly set a user account or uuid to a
    pithos call. In the latest Synnefo version (>= 0.14), these features are
    meaningless and therefore omitted.

* `global.data_log` option has never been a valid kamaki config option.
    In this example, the user accidentally misspelled the term `log_data`
    (which is a valid kamaki config option) as `data_log`. To fix this, the
    user should set the correct option after the conversion is complete
    (Example 2.2).

Users should press *y* when they are ready. Kamaki has now modified the default
config file to conform with kamaki config file v3. Now users should rescue
unrescued information (if any).

.. code-block:: console
    :emphasize-lines: 1

    Example 2.2: Rescue misspelled log_data option

    $ kamaki config set log_data on

In order to convert more files, users may run kamaki with the -c option, which
runs kamaki with a different configuration file (Example 2.3) and apply the
steps described above.

.. code-block:: console
    :emphasize-lines: 1

    Example 2.3: Use kamaki to update a configuration file called ".myfilerc"

    $ kamaki -c .myfilerc user authenticate

Multiple clouds
---------------

The following refers to users of multiple Synnefo and/or Open Stack
deployments. In the following, a Synnefo or Open Stack cloud deployment will
frequently be called as a **cloud**.

Kamaki supports accessing multiple clouds from the same kamaki setup. Before
kamaki 0.9, this was possible only by using multiple config files. Since 0.9,
kamaki supports multiple clouds in the same configuration.

Each cloud corresponds to a Synnefo (or Open Stack) cloud deployment.
Since Synnefo version 0.14, each deployment offers a single point of
authentication, as an **authentication URL** and **token** pair. Users can
retrieve this information through the cloud UI.

Once a user has retrieved one URL/token pair per cloud, it is time to assign a
name to each cloud and let kamaki know about them.

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

    cloud alias: devel
    authentication URL: https://devel.example.com/astakos/identity/v2.0/
    authentication token: myd3v3170k3n==

    cloud alias: testing
    autentication URL: https://testing.example.com/astakos/identity/v2.0/
    authentication token: my73571ng70k3n==

.. note:: the cloud alias is arbitrary and decided by the user. It is just a
    name to call a cloud setup in the kamaki context.

The user should let kamaki know about these setups:

.. code-block:: console

    $ kamaki config set cloud.devel.url https://devel.example.com/astakos/identity/v2.0/
    $ kamaki config set cloud.devel.token myd3v3170k3n==
    $
    $ kamaki config set cloud.testing.url https://testing.example.com/astakos/identity/v2.0/
    $ kamaki config set cloud.testing.token my73571ng70k3n==
    $

To check if all settings are loaded, a user may list all clouds, as shown
bellow:

.. code-block:: console

    $ kamaki config getcloud 
     cloud.default.url = https://example.com/astakos.identity/v2.0/
     cloud.default.url = myd3f4u1770k3n==
     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/
     cloud.testing.token = my73571ng70k3n==
    $

or query kamaki for a specific cloud:

.. code-block:: console

    $ kamaki config get cloud.devel
     cloud.devel.url = https://devel.example.com/astakos/identity/v2.0/
     cloud.devel.token = myd3v3170k3n==
    $

Now kamaki can use any of these clouds, with the **- - cloud** attribute. If
the **- - cloud** option is ommited, kamaki will query the `default` cloud.

One way to test this, is the `user athenticate` command:

.. code-block:: console

    $ kamaki --cloud=devel user authenticate
     ...
     user          : 
        id         :  725d5de4-1bab-45ac-9e98-38a60a8c543c
        name       :  Devel User
    $
    $ kamaki --cloud=testing user authenticate
     ...
     user          : 
        id         :  4ed5d527-bab1-ca54-89e9-c345c8a06a83
        name       :  Testing User
    $
    $ kamaki --cloud=default user authenticate
     ...
     user          : 
        id         :  4d3f4u17-u53r-4u7h-451n-4u7h3n7ic473
        name       :  Default User
    $
    $ kamaki user authenticate
     ...
     user          : 
        id         :  4d3f4u17-u53r-4u7h-451n-4u7h3n7ic473
        name       :  Default User
    $

In interactive cell, the cloud is picked when invoking the shell, with
the **- - cloud** option.

Optional features
-----------------

For installing any or all of the following, consult the
`kamaki installation guide <installation.html#install-ansicolors>`_

* ansicolors
    * Add colors to command line / console output
    * Can be switched on/off in kamaki configuration file: `colors = on/off`
    * Has not been tested on non unix / linux based platforms

* mock 
    * For kamaki contributors only
    * Allow unit tests to run on kamaki.clients package
    * Needs mock version 1.X or better

* astakosclient
    * For advanced users mostly
    * Allows the use of a full astakos command line client

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

Configuration options
---------------------

There are two kinds of configuration options:

* kamaki-related (global)
    interface settings and constants of the kamaki internal mechanism, e.g.
    colors in the output, maximum threads per connection, custom logging or
    history files, etc.

* cloud-related
    information needed to connect and use one or more clouds. There are some
    mandatory options (URL, token) and some advanced / optional (e.g.
    service-specific URL overrides or versions)

Kamaki comes with preset default values to all kamaki-releated configuration
options. Cloud-related information is not included in presets and should be
provided by the user. Kamaki-related options can also be modified.

There are two ways of managing configuration options: edit the config file or
use the kamaki config command.

Using multiple configuration files
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Kamaki setups are stored in configuration files. By default, a Kamaki
installation stores options in *.kamakirc* file located at the user home
directory.

If a user needs to switch between different kamaki-related setups, Kamaki can
explicitly load configuration files with the **- - config** (or **- c**) option

.. code-block:: console

    $ kamaki --config <custom_config_file_path> [other options]

.. note:: For accessing multiple clouds, users do NOT need to create multiple
    configuration files. Instead, we suggest using a single configuration file
    with multiple cloud setups. More details can be found at the
    `multiple clouds guide <#multiple-clouds>`_.

Modifying options at runtime
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

All kamaki commands can be used with the -o option in order to override configuration options at runtime. For example::

.. code-block:: console

    $ kamaki file list -o global.pithos_container=anothercontainer

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
    lists all configuration options currently used by a Kamaki installation

* kamaki config get <group.option>
    show the value of a specific configuration option. Options must be of the
    form *group.option*. The term *option* is equivalent to *global.option*

* kamaki config set <group.option> <value>
    set the group.option to value. If no group is given, the defaults to
    *global*.

* kamaki config delete <group.option>
    delete a configuration option. If no group is given, the defaults to
    *global*

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

The commands above can also be used for **clouds** handling, using the `cloud.`
prefix. The cloud handling cases are similar but with slightly different
semantics:

* kamaki config get cloud[.<cloud alias>[.option]]
    * cloud 
        list all clouds and their settings
    * cloud.<cloud alias>
        list settings of the cloud aliased as <cloud alias>. If no
        special is configured, use the term `cloud.default`
    * cloud.<cloud alias>.<option>
        show the value of the specified option. If no special alias is
        configured, use `cloud.default.<option>`

* kamaki config set cloud.<cloud alias>.<option> <value>
    If the cloud alias <cloud alias> does not exist, create it. Then, create
    (or update) the option <option> of this cloud, by setting its value
    to <value>.

* kamaki config delete cloud.<cloud alias>[.<option>]
    * cloud.<cloud alias>
        delete the cloud alias <cloud alias> and all its options
    * cloud.<cloud alias>.<option>
        delete the <option> and its value from the cloud cloud aliased as
        <cloud alias>

.. note:: To see if a default cloud is configured, get the default_cloud value

    .. 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.

.. note:: users of kamaki < 0.9 can use kamaki 0.9.X to automatically convert
    their old configuration files to the new config file version (>= 3.0). To
    do this, follow `these instructions <#migrating-from-kamaki-0-8-x-to-0-9>`_
    
A simple way to create the configuration file is to set a configuration option
using the kamaki config command. For example:

.. code-block:: console

    $ kamaki config set global.log_file /home/exampleuser/logs/kamaki.log

In the above example, if the kamaki configuration file does not exist, it will
be created with all the default values plus the *global.log_file* option set to
`/home/exampleuser/logs/kamaki.log`

The configuration file is formatted so that it can be parsed by the python ConfigParser module. It consists of command sections that are denoted with brackets. Every section contains variables with values. For example::

    [global]
    log_file = /home/exampleuser/logs/kamaki.log
    max_threads = 7
    colors = off

    [cloud "default"]
    url =
    token =

A bunch of configuration options are created and set to their default options,
except the log_file option which is set to whatever the specified value.

The [cloud "default"] section is special and is used to configure the default
cloud cloud. Kamaki will not be able to run without setting the url and token
values to that section.

More clouds can be created  on the side of the default cloud, e.g using the
examples at the `multiple clouds guide <#multiple-clouds>`_ ::

    [cloud "devel"]
    url = https://devel.example.com/astakos/identity/v2.0/
    token = myd3v3170k3n==

    [cloud "testing"]
    url = https://testing.example.com/astakos/identity/v2.0/
    token = my73571ng70k3n==

Available options
^^^^^^^^^^^^^^^^^

The [global] group is treated by kamaki as a generic group for kamaki-related
settings, namely command cli specifications, the thread limit, console colors,
history and log files, log detail options and pithos-specific options.

* global.colors <on|off>
    enable / disable colors in command line based uis. Requires ansicolors, otherwise it is ignored

* global.log_file <logfile full path>
    set a custom location for kamaki logging. Default value is ~/.kamaki.log

* global.log_token <on|off>
    allow kamaki to log user tokens

* global.log_data <on|off>
    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.

* global.cyclades_cli <UI command specifications for cyclades>
    a special package that is used to load cyclades commands to kamaki UIs.
    Don't touch this unless you know what you are doing.

* global.flavor_cli <UI command specifications for VM flavors>
    a special package that is used to load cyclades VM flavor commands to
    kamaki UIs. Don't touch this unless you know what you are doing.

* global.network_cli <UI command specifications for virtual networks>
    a special package that is used to load cyclades virtual network commands to
    kamaki UIs. Don't touch this unless you know what you are doing.

* global.image_cli <UI command specs for Plankton or Compute image service>
    a special package that is used to load image-related commands to kamaki UIs. Don't touch this unless you know what you are doing.

* global.user_cli <UI command specs for Astakos authentication service>
    a special package that is used to load astakos-related commands to kamaki
    UIs. Don't touch this unless you know what you are doing.

* global.history_file <history file path>
    the path of a simple file for inter-session kamaki history. Make sure
    kamaki is executed in a context where this file is accessible for reading
    and writing. Kamaki automatically creates the file if it doesn't exist

Additional features
^^^^^^^^^^^^^^^^^^^

The livetest suite
""""""""""""""""""

Kamaki contains a live test suite for the kamaki.clients API, where "live"
means that the tests are performed against active services that up and running.
The live test package is named "livetest", it is accessible as kamaki.clients.
livetest and it is designed to check the actual relation between kamaki and
synnefo services.

The livetest suite can be activated with the following option on the configuration file::

    [global]
    livetest_cli=livetest

or with this kamaki command::

    kamaki config set livetest_cli livetest

In most tests, livetest will run as long as the default cloud is configured
correctly. Some commands, though, need some extra settings related to the cloud
the test is performed against, or the example files used in kamaki.

Here is a list of settings needed:

* for all tests::
    * livetest.testcloud = <the cloud alias this test will run against>

* for astakos client::
    * livetest.astakos_details = <A file with an authentication output>
        To create this file, pipeline the output of an authentication command
        with the -j option for raw jason output

        .. code-block:: console

            $ kamaki user authenticate -j > astakos.details

    * livetest.astakos_name = <The exact "real" name of testing user>
    * livetest.astakos_id = <The valid unique user id of the testing user>

* for image client:
    * livetest.image_details = <A file with the image's metadata>
        To create this file, pipeline the output of an image metadata command
        with the -j option for raw jason output

        .. code-block:: console

            $ kamaki image meta <img id> -j > img.details

    * livetest.image_id = <A valid image id used for testing>
    * livetest.image_local_path = <The local path of the testing image>

* 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
        with the -j option for raw jason output

        .. code-block:: console

            $ kamaki flavor info <flavor id> -j > flavor.details


After setup, kamaki can run all tests::

    $ kamaki livetest all

a specific test (e.g. astakos)::

    $ kamaki livetest astakos

or a specific method from a service (e.g. astakos authenticate)::

    $ kamaki livetest astakos authenticate

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
developers who debug or extent the kamaki clients library. For more
information, check the
`Going Agile <developers/extending-clients-api.html#going-agile>`_ entry at the
`developers section <developers/extending-clients-api.html>`_.