Revision 9dc6159f

b/README.Upgrade
1
This document describes changes and steps to upgrade from kamaki 0.8.X to kamaki 0.9
1
This document describes changes and steps to upgrade from kamaki 0.8.X to
2
kamaki 0.9
3

  
4
Configuration file
5
------------------
6
Kamaki 0.9 uses a redesigned configuration file. The new configuration file
7
version is v3.
8

  
9
The new file consists of at least two groups: global and remote "default". The
10
global field holds all settings releated to kamaki client and cli
11
functionality. The remote "default" field holds authentication information for
12
connecting to the cloud.
13

  
14
A sample configuration file:
15

  
16
  # Kamaki configuration file v3 (kamaki >= v0.9)
17
  [global]
18
  colors = on
19

  
20
  [remote "default"]
21
  url = https://astakos.example.com/astakos/identity/v2.0/
22
  token = myu53r70k3n==
23

  
24
How to convert an old configuration file
25
----------------------------------------
26
When loading a kamaki command, kamaki inspect the configuration file. If the
27
configuration file is judged to be a valid v3 kamaki configuration file, the
28
kamaki command will be executed normally. Otherwise, kamaki will attempt to
29
convert the file.
30

  
31
Step 1: backup the kamaki configuraiton file ( usually $HOME/.kamakirc )
32

  
33
Step 2: Run a cloud kamaki command. We suggest the following:
34

  
35
  kamaki user authenticate
36

  
37
Step 3: Kamaki will create a list of suggested modifications. Users may permit
38
or deny these changes (y or n). To convert the file, press y .
39

  
40
In case of a denial, kamaki will exit. Otherwise the configuration file will
41
be converted.
42

  
43
Kamaki attempts to preserve as much information as possible, by performing
44
option renames and moving values under the correct groups. In any case,
45
kamaki prints on console all actions, whether modifications or deletions, so
46
that no information is lost.
47

  
48
Single authentication url
49
-------------------------
50
Since Synnefo version 0.14, cloud clients can be authenticated onb a single
51
URL, which is common for the whole cloud system. The authentication mechanism
52
provides all information nessecary for running any available cloud service.
53

  
54
Kamaki takes advantage of this feature, requiring users to remove all
55
service-specific settings and using a single authentication URL,token pair for
56
the whole cloud. This affects all CLI users, whether they use cyclades,
57
plankton or pithos.
58

  
59
For example, instead of this:
60

  
61
  [global]
62
  token = myu53r70k3n==
63

  
64
  [user]
65
  url = https://astakos.example.com/
66

  
67
  [file]
68
  url = https://pithos.example.com/pithos/v1
69
  container = image
70

  
71
  [image]
72
  url = https://image.example.com/plankton/v1
73

  
74
the new configuration file may look like this:
75

  
76
  [global]
77
  pithos_container = image
78

  
79
  [remote "default"]
80
  url = https://astakos.example.com/astakos/identity/v2.0/
81
  token = myu53r70k3n==
82

  
83
Kamaki will use the default url to authenticate the synnefo user and then it
84
will automatically retrieve the astakos, image and pithos urls needed for the
85
rest of the operations.
2 86

  
b/README.rst
1 1
README
2 2
=======
3 3

  
4
./kamaki is a simple, yet intuitive, command-line tool/interactive shell for managing clouds.
4
./kamaki is a multipurpose, interactive command-line tool and also a client
5
development API for managing clouds.
6

  
7
As a development API, it is an initial implementation of the Synnefo API
8
( http://www.synnefo.org cloud management software extends OpenStack ), while
9
preserving compatibility with the OpenStack API.
5 10

  
6
It is an initial implementation of the OpenStack Compute API v1.1, with custom
7
extensions specific to the Synnefo IaaS (www.synnefo.org) cloud management software.
b/docs/developers/code.rst
9 9
user
10 10
^^^^
11 11

  
12
.. automodule:: kamaki.cli.commands.user
12
.. automodule:: kamaki.cli.commands.astakos
13 13
    :members:
14 14
    :undoc-members:
15 15

  
b/docs/index.rst
8 8

  
9 9
.. image:: /images/kamaki-logo.png
10 10

  
11
./kamaki is a simple, yet intuitive, multipurpose, interactive command-line tool and client API for managing clouds.
11
./kamaki is a multipurpose, interactive command-line tool and also a client development API for managing clouds.
12 12

  
13
As a develpment API is an initial implementation of an OpenStack inspired API designed for the `Synnefo IaaS <http://www.synnefo.org/>`_ cloud management software.
13
As a development API, it is an initial implementation of the Synnefo API (`Synnefo IaaS <http://www.synnefo.org/>`_ cloud management software extends OpenStack), while preserving compatibility with the OpenStack API.
14 14

  
15 15
./kamaki is open source and released under a 2-clause BSD License.
16 16

  
b/kamaki/cli/commands/cyclades.py
408 408
class server_metadata_set(_init_cyclades, _optional_json):
409 409
    """Set / update server(VM) metadata
410 410
    Metadata should be given in key/value pairs in key=value format
411
    For example:
412
        /server metadata set <server id> key1=value1 key2=value2
411
    For example: /server metadata set <server id> key1=value1 key2=value2
413 412
    Old, unreferenced metadata will remain intact
414 413
    """
415 414

  
b/kamaki/clients/pithos/__init__.py
381 381
        :param public: (bool)
382 382

  
383 383
        :param container_info_cache: (dict) if given, avoid redundant calls to
384
        server for container info (block size and hash information)
384
            server for container info (block size and hash information)
385 385
        """
386 386
        self._assert_container()
387 387

  
......
510 510
        :param public: (bool)
511 511

  
512 512
        :param container_info_cache: (dict) if given, avoid redundant calls to
513
        server for container info (block size and hash information)
513
            server for container info (block size and hash information)
514 514
        """
515 515
        self._assert_container()
516 516

  

Also available in: Unified diff