Merge branch 'release-0.9'
[kamaki] / README.Upgrade
1 This document describes changes and steps to upgrade from kamaki 0.8.X to
2 kamaki 0.9
3
4 Config file
5 -----------
6
7 Kamaki v0.9 will have a new config file with the following format:
8
9   [global]
10   default_cloud = some_cloud
11   ... more kamaki-related settings ...
12
13   [cloud "some_cloud"]
14   url = https://some/cloud/single/authentication/url
15   token = user_token==
16
17 For more information on the exact format of the kamaki global variables, see
18 the respective documentation page:
19 http://www.synnefo.org/docs/kamaki/latest/setup.html#available-options
20
21 How to convert the config file
22 ------------------------------
23
24 To convert an old config file, backup the old one and then run:
25
26   kamaki -c <config file path> user authenticate
27
28 Kamaki will automatically inspect the file and suggest a list of convertions,
29 namely renamings and discards. Take a look at the list of discarded values,
30 write down the ones that might be usefull.
31
32 If you are sure about the changes, press 'y'.
33
34 Kamaki should raise an error, demanding an authentication URL and/or token.
35
36 First, you need to go to the clouds UI and find the authentication URL and
37 token. Then you should think of a name for your cloud, e.g. "mycloud". Now,
38 feed kamaki with this information:
39
40 kamaki -c <config file path> config set cloud.mycloud.url <URL>
41 kamaki -c <config file path> config set cloud.mycloud.token <token>
42
43 Now the configuration file should be kamaki 0.9 ready.