From: Stavros Sachtouris <saxtouri@admin.grnet.gr>
Date: Wed, 12 Jun 2013 12:22:02 +0000 (+0300)
Subject: Create Upgrade notes regarding the config files
X-Git-Tag: 0.9rc4~12
X-Git-Url: https://code.grnet.gr/git/kamaki/commitdiff_plain/76dada179cf9f8ce30916c34ab3cec8c93de81f6?ds=sidebyside

Create Upgrade notes regarding the config files
---

diff --git a/README.Upgrade b/README.Upgrade
index 1b2d990..6735a9a 100644
--- a/README.Upgrade
+++ b/README.Upgrade
@@ -1,3 +1,44 @@
-This document describes changes and steps to upgrade from kamaki 0.9.X to
-kamaki 0.10
+This document describes changes and steps to upgrade from kamaki 0.8.X to
+kamaki 0.9
+
+Config file
+-----------
+
+Kamaki v0.9 will have a new config file with the following format:
+
+  [global]
+  default_cloud = some_cloud
+  ... more kamaki-related settings ...
+
+  [cloud "some_cloud"]
+  url = https://some/cloud/single/authentication/url
+  token = user_token==
+
+For more information on the exact format of the kamaki global variables, see
+the respective documentation page:
+http://www.synnefo.org/docs/kamaki/latest/setup.html#available-options
+
+How to convert the config file
+------------------------------
+
+To convert an old config file, backup the old one and then run:
+
+  kamaki -c <config file path> user authenticate
+
+Kamaki will automatically inspect the file and suggest a list of convertions,
+namely renamings and discards. Take a look at the list of discarded values,
+write down the ones that might be usefull.
+
+If you are sure about the changes, press 'y'.
+
+Kamaki should raise an error, demanding an authentication URL and/or token.
+
+First, you need to go to the clouds UI and find the authentication URL and
+token. Then you should think of a name for your cloud, e.g. "mycloud". Now,
+feed kamaki with this information:
+
+kamaki -c <config file path> config set cloud.mycloud.url <URL>
+kamaki -c <config file path> config set cloud.mycloud.token <token>
+
+Now the configuration file should be kamaki 0.9 ready.