Fi network_create in documentation
[kamaki] / README.Upgrade
index b3d11e9..3f401eb 100644 (file)
@@ -1,40 +1,55 @@
-This document describes changes and steps to upgrade from kamaki 0.7.X to kamaki 0.8
-
-This document refers to users who:
-- use the kamaki command line
-- load configuration options with the kamaki.cli.config
-
-Notable changes:
-- Make progress (>= 1.1) module a requirement (was a suggestion)
-- log http requests to ~/.kamaki.log
-- Rename some command groups:
-    store --> file
-    astakos --> user
-- Rename some mandatory configuration options:
-    astakos.url --> user.url,
-    store.url --> file.url
-Note: if the above config options are not changed, users can still use file and user commands, due to backword support for old command options. Support for astakos and store configuration options will not continue in version 0.9
-- Do not require <cmd group>.cli (cli specification) field in configuration file, use it only to override default values.
-- Change the naming convention for cli specifications by loosing the _cli suffix:
-    <cmd group>_cli --> <cmd group>
-- Seperate kamaki image commands based on whether they make requests to Plankton or Cyclades.
-    Plankton image commands: kamaki image <action>
-    Cyclades image commands: kamaki image compute <action>
-- Rename: kamaki image public --> kamaki image list
-- Change letter case for recursive download runtime argument:
-    kamaki store download -r <container>:<path> [local destination]
-    -->
-    kamaki file download -R <container>:<path> [local destination]
-
-
-Suggested upgrade method:
-1. Backup the .kamakirc file (usually stored as ~/.kamakirc). E.g.:
-    cp ~/.kamakirc ~/tmp/.kamakirc.bu
-2. Upgrade kamaki (refer to your installation method). E.g. if installed from pypi:
-    pip install --upgrade kamaki
-3. Download the script bellow:
-    For Linux, OS X, *nix, systems that run bash:
-        https://code.grnet.gr/attachments/download/2493/kamaki0.7to0.8.sh
-    For windows:
-        https://code.grnet.gr/attachments/download/2497/kamaki0.7to0.8.bat
-and run it from command line. This script will modify the default .kamakirc file in order to comply with version 0.8
+This document describes changes and steps to upgrade from kamaki 0.11 to
+kamaki 0.12
+
+1. Update the kamaki configuration with these commands:
+  $ kamaki config delete network_cli
+  $ kamaki config delete ip_cli
+
+2. Upgrade shell scripts to use the new syntax:
+    positional arguments are removed, except if refering to the objects
+    e.g., kamaki server info SERVER_ID
+    but not kamaki server create NAME IMAGE FLAVOR
+    Use mandatory non-positional arguments
+    e.g., kamaki server create --name=NAME --image-id=IMAGE_ID --flavor-id=FLAVOR_ID
+          kamaki image register --name=NAME --location=IMAGE_LOCATION
+
+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.