Revision 329753ae

b/docs/conf.py
51 51
# The short X.Y version.
52 52
version = '0.6'
53 53
# The full version, including alpha/beta/rc tags.
54
release = '0.6~rc1'
54
release = '0.6.1'
55 55

  
56 56
# The language for content autogenerated by Sphinx. Refer to documentation
57 57
# for a list of supported languages.
b/docs/connection.rst
3 3

  
4 4
An http connection package with connection pooling.
5 5

  
6
In version 0.6 and on it is safe to use parallel connections with greenlets.
6
In version 0.6 and on it is safe to use threaded connections.
7 7

  
8
It uses httplib and GRNet Synnefo snf-common packages. All pooling parameters are configures in the external snf-common package.
8
It uses httplib and GRNet Synnefo snf-common packages. Pooling parameters are configures in the external snf-common package.
9 9

  
10 10
.. automodule:: kamaki.clients.connection
11 11
    :members:
b/docs/man/kamaki.rst
81 81
history commands
82 82
****************
83 83

  
84
Show command user history, as stored in ~/.kamaki.history
84
Command user history, as stored in ~/.kamaki.history
85 85

  
86
* all       show user history
86 87
* clean     clean up history
87 88

  
88 89

  
......
105 106
* setmeta    update server metadata
106 107
* delmeta    delete server metadata
107 108
* stats      get server statistics
108
* wait: Wait for server to finish [BUILD, STOPPED, REBOOT, ACTIVE]
109
* wait       wait for server to finish [BUILD, STOPPED, REBOOT, ACTIVE]
109 110

  
110 111

  
111 112
flavor commands
......
124 125
* shared      list shared images
125 126
* delete      delete image
126 127
* register    register an image
128
* reregister  re-register an image (preserve and update properties)
127 129
* meta        get image metadata
128 130
* members     get image members
129 131
* addmember   add a member to an image
b/docs/overview.rst
4 4
History
5 5
-------
6 6

  
7
Here, at the
8
`Greek Research and Technology Network `_,
9
we have been developing an IaaS cloud management software called **synnefo**
10
(or **+nefo**) that is accessed and managed via an extended OpenStack Compute API v1.1. Synnefo has been deployed in many environments to cover multiple needs. For example, the `~okeanos `_ IaaS service, running in our datacenters, is used to offer services for the Greek Research and Academic Community.
7
Here, at the *Greek Research and Technology Network*, we have been developing an IaaS cloud management software called **synnefo** (or **+nefo**) that is accessed and managed via an extended OpenStack Compute API v1.1. Synnefo has been deployed in many environments to cover multiple needs. For example, the `~okeanos `_ IaaS service, running in our datacenters, is used to offer services for the Greek Research and Academic Community.
11 8

  
12 9
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.
13 10

  
......
34 31

  
35 32
* synnefo@lists.grnet.gr
36 33

  
37
Please be sure to have read the Documentation and check the known
38
`issues `_ before contacting the
39
team.
34
Please be sure to have read the Documentation and check the known issues before contacting the team.
40 35

  
b/docs/setup.rst
20 20
    * Can be switched on/off in kamaki configuration file: colors=on/off
21 21
    * Installation: pip install ansicolors
22 22

  
23
* progressbar
24
    * Attach progressbars to various kamaki commands (e.g. kamaki store upload)
23
* progress 
24
    * Attach progress bars to various kamaki commands (e.g. kamaki store upload)
25 25
    * Installation: pip install progressbar
26
    * Since version 0.6.1 kamaki "requires" progress version 1.0.2 or better
26 27

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

  
......
51 52

  
52 53
*kamaki store list -o global.account=anotheraccount -o global.token=aT0k3n==*
53 54

  
54
will call *kamaki store list* with the specified options, but the initial global.account and global.token values will be restored afterwards.
55
will invoke *kamaki store list* with the specified options, but the initial global.account and global.token values will be restored to initial values afterwards.
55 56

  
56 57
Editing options
57 58
^^^^^^^^^^^^^^^
......
67 68
* kamaki config set <group.option> <value>
68 69
    set the group.option to value
69 70

  
70
*kamaki config delete <group.option>
71
* kamaki config delete <group.option>
71 72
    delete a configuration option
72 73

  
73 74
The above commands cause option values to be permanently stored in the Kamaki configuration file.
......
75 76
Editing the configuration file
76 77
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
77 78

  
78
The configuration file is a simple text file that can be created by the user.d
79
The configuration file is a simple text file that can be created by the user.
79 80

  
80 81
A simple way to create the configuration file is to set a configuration option using the kamaki config command. For example:
81 82

  
......
94 95
Available options
95 96
^^^^^^^^^^^^^^^^^
96 97

  
97
The [global] group is treated by kamaki as a generic group for arbitrary options, and it is used as a supergroup for vital Kamaki options like account, token, or url. For example if global.account option is set and store.account option is not set, store services will use the global.account option instead. In case of conflict, the most specific options override the global ones.
98
The [global] group is treated by kamaki as a generic group for arbitrary options, and it is used as a supergroup for vital Kamaki options, namely account, token, url, cli. This feature does not work for types of configuration options. For example if global.account option is set and store.account option is not set, store services will use the global.account option instead. In case of conflict, the most specific options override the global ones.
98 99

  
99 100
* global.colors <on|off>
100 101
    enable/disable colors in command line based uis. Requires ansicolors, otherwise it is ignored
......
135 136
    the url of the Astakos authentication service. Set to the Okeanos.grnet.gr Astakos service by default. Users should set a different value if they need to use a different service.
136 137

  
137 138
* astakos.cli <UI command specifications for Astakos authentication service>
138
    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.
139
    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.
140

  
141
Hidden features
142
^^^^^^^^^^^^^^^
143

  
144
Since version 0.6.1 kamaki contains a test suite for the kamaki.clients API. The test suite can be activated with the following option on the configuration file:
145

  
146
[test]
147
cli=test_cli
148

  
149
After that, users can run "kamaki test" commands to unittest the prepackaged client APIs. Unittests 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.
b/kamaki/cli/argument.py
256 256
    def get_generator(self, message, message_len=25):
257 257
        if self.value:
258 258
            return None
259
        self.bar = IncrementalBar()
260 259
        try:
261
            self.bar.message = message.ljust(message_len)
260
            self.bar = IncrementalBar()
262 261
        except NameError:
263
            pass
262
            self.value = None
263
            return self.value
264
        self.bar.message = message.ljust(message_len)
264 265
        self.bar.suffix = '%(percent)d%% - %(eta)ds'
265 266

  
266 267
        def progress_gen(n):
b/setup.py
39 39
import kamaki
40 40

  
41 41

  
42
optional = ['ansicolors', 'progress']
42
optional = ['ansicolors', 'progress>=1.0.2']
43 43
required = ['snf-common>=0.10']
44 44

  
45 45
setup(

Also available in: Unified diff