Document the Upgrade notes for v0.9

diff --git a/README.Upgrade b/README.Upgrade
index 21391cf..3bf7fbf 100644 (file)
--- a/README.Upgrade
+++ b/README.Upgrade
@@ -1,2 +1,86 @@
-This document describes changes and steps to upgrade from kamaki 0.8.X to kamaki 0.9
+This document describes changes and steps to upgrade from kamaki 0.8.X to
+kamaki 0.9
+
+Configuration file
+------------------
+Kamaki 0.9 uses a redesigned configuration file. The new configuration file
+version is v3.
+
+The new file consists of at least two groups: global and remote "default". The
+global field holds all settings releated to kamaki client and cli
+functionality. The remote "default" field holds authentication information for
+connecting to the cloud.
+
+A sample configuration file:
+
+  # Kamaki configuration file v3 (kamaki >= v0.9)
+  [global]
+  colors = on
+
+  [remote "default"]
+  url = https://astakos.example.com/astakos/identity/v2.0/
+  token = myu53r70k3n==
+
+How to convert an old configuration file
+----------------------------------------
+When loading a kamaki command, kamaki inspect the configuration file. If the
+configuration file is judged to be a valid v3 kamaki configuration file, the
+kamaki command will be executed normally. Otherwise, kamaki will attempt to
+convert the file.
+
+Step 1: backup the kamaki configuraiton file ( usually $HOME/.kamakirc )
+
+Step 2: Run a cloud kamaki command. We suggest the following:
+
+  kamaki user authenticate
+
+Step 3: Kamaki will create a list of suggested modifications. Users may permit
+or deny these changes (y or n). To convert the file, press y .
+
+In case of a denial, kamaki will exit. Otherwise the configuration file will
+be converted.
+
+Kamaki attempts to preserve as much information as possible, by performing
+option renames and moving values under the correct groups. In any case,
+kamaki prints on console all actions, whether modifications or deletions, so
+that no information is lost.
+
+Single authentication url
+-------------------------
+Since Synnefo version 0.14, cloud clients can be authenticated onb a single
+URL, which is common for the whole cloud system. The authentication mechanism
+provides all information nessecary for running any available cloud service.
+
+Kamaki takes advantage of this feature, requiring users to remove all
+service-specific settings and using a single authentication URL,token pair for
+the whole cloud. This affects all CLI users, whether they use cyclades,
+plankton or pithos.
+
+For example, instead of this:
+
+  [global]
+  token = myu53r70k3n==
+
+  [user]
+  url = https://astakos.example.com/
+
+  [file]
+  url = https://pithos.example.com/pithos/v1
+  container = image
+
+  [image]
+  url = https://image.example.com/plankton/v1
+
+the new configuration file may look like this:
+
+  [global]
+  pithos_container = image
+
+  [remote "default"]
+  url = https://astakos.example.com/astakos/identity/v2.0/
+  token = myu53r70k3n==
+
+Kamaki will use the default url to authenticate the synnefo user and then it
+will automatically retrieve the astakos, image and pithos urls needed for the
+rest of the operations.
 

diff --git a/README.rst b/README.rst
index 2d0aeea..4d90997 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -1,7 +1,10 @@
 README
 =======
 
-./kamaki is a simple, yet intuitive, command-line tool/interactive shell for managing clouds.
+./kamaki is a multipurpose, interactive command-line tool and also a client
+development API for managing clouds.
+
+As a development API, it is an initial implementation of the Synnefo API
+( http://www.synnefo.org cloud management software extends OpenStack ), while
+preserving compatibility with the OpenStack API.
 
-It is an initial implementation of the OpenStack Compute API v1.1, with custom
-extensions specific to the Synnefo IaaS (www.synnefo.org) cloud management software.

diff --git a/docs/developers/code.rst b/docs/developers/code.rst
index 2b07ae7..8d6d113 100644 (file)
--- a/docs/developers/code.rst
+++ b/docs/developers/code.rst
@@ -9,7 +9,7 @@ Command Specifications
 user
 ^^^^
 
-.. automodule:: kamaki.cli.commands.user
+.. automodule:: kamaki.cli.commands.astakos
     :members:
     :undoc-members:
 

diff --git a/docs/index.rst b/docs/index.rst
index 6065d18..e582bf5 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -8,9 +8,9 @@ Kamaki project documentation
 
 .. image:: /images/kamaki-logo.png
 
-./kamaki is a simple, yet intuitive, multipurpose, interactive command-line tool and client API for managing clouds.
+./kamaki is a multipurpose, interactive command-line tool and also a client development API for managing clouds.
 
-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.
+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.
 
 ./kamaki is open source and released under a 2-clause BSD License.
 

diff --git a/kamaki/cli/commands/cyclades.py b/kamaki/cli/commands/cyclades.py
index 48252ca..c3ab9b0 100644 (file)
--- a/kamaki/cli/commands/cyclades.py
+++ b/kamaki/cli/commands/cyclades.py
@@ -408,8 +408,7 @@ class server_metadata_list(_init_cyclades, _optional_json):
 class server_metadata_set(_init_cyclades, _optional_json):
     """Set / update server(VM) metadata
     Metadata should be given in key/value pairs in key=value format
-    For example:
-        /server metadata set <server id> key1=value1 key2=value2
+    For example: /server metadata set <server id> key1=value1 key2=value2
     Old, unreferenced metadata will remain intact
     """
 

diff --git a/kamaki/clients/pithos/__init__.py b/kamaki/clients/pithos/__init__.py
index 8ef2f14..dd3065f 100644 (file)
--- a/kamaki/clients/pithos/__init__.py
+++ b/kamaki/clients/pithos/__init__.py
@@ -381,7 +381,7 @@ class PithosClient(PithosRestClient):
         :param public: (bool)
 
         :param container_info_cache: (dict) if given, avoid redundant calls to
-        server for container info (block size and hash information)
+            server for container info (block size and hash information)
         """
         self._assert_container()
 
@@ -510,7 +510,7 @@ class PithosClient(PithosRestClient):
         :param public: (bool)
 
         :param container_info_cache: (dict) if given, avoid redundant calls to
-        server for container info (block size and hash information)
+            server for container info (block size and hash information)
         """
         self._assert_container()