-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.11 to
+kamaki 0.12
-Configuration file
-------------------
-Kamaki 0.9 uses a redesigned configuration file. The new configuration file
-version is v3.
+1. Update the kamaki configuration with these commands:
+ $ kamaki config delete network_cli
+ $ kamaki config delete ip_cli
-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.
+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
-A sample configuration file:
+Config 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
+Kamaki v0.9 will have a new config file with the following format:
-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.
+ [global]
+ default_cloud = some_cloud
+ ... more kamaki-related settings ...
-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.
+ [cloud "some_cloud"]
+ url = https://some/cloud/single/authentication/url
+ token = user_token==
-For example, instead of this:
+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
- [global]
- token = myu53r70k3n==
+How to convert the config file
+------------------------------
- [user]
- url = https://astakos.example.com/
+To convert an old config file, backup the old one and then run:
- [file]
- url = https://pithos.example.com/pithos/v1
- container = image
+ kamaki -c <config file path> user authenticate
- [image]
- url = https://image.example.com/plankton/v1
+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.
-the new configuration file may look like this:
+If you are sure about the changes, press 'y'.
- [global]
- pithos_container = image
+Kamaki should raise an error, demanding an authentication URL and/or token.
- [remote "default"]
- url = https://astakos.example.com/astakos/identity/v2.0/
- token = myu53r70k3n==
+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 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.
+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.
projects / kamaki / blobdiff