Revision 7ae842c2 docs/setup.rst
| b/docs/setup.rst | ||
|---|---|---|
| 18 | 18 |
|
| 19 | 19 |
$ kamaki set token myt0k3n== |
| 20 | 20 |
|
| 21 |
To use the storage service, a user should also provide the corresponding user-name: |
|
| 22 |
|
|
| 23 |
.. code-block:: console |
|
| 24 |
:emphasize-lines: 1 |
|
| 25 |
|
|
| 26 |
Example 1.2: Set user name to user@domain.com |
|
| 27 |
|
|
| 28 |
$ kamaki set store.account user@domain.com |
|
| 29 |
|
|
| 30 | 21 |
Optional features |
| 31 | 22 |
----------------- |
| 32 | 23 |
|
| ... | ... | |
| 73 | 64 |
|
| 74 | 65 |
will invoke *kamaki store list* with the specified options, but the initial global.account and global.token values will be restored to initial values afterwards. |
| 75 | 66 |
|
| 67 |
.. note:: on-the-fly calls to store require users to explicetely provide the account uuid corresponding to this token. The account is actually the uuid field at the response of the following call:: |
|
| 68 |
|
|
| 69 |
$kamaki astakos authenticate aT0k3n== |
|
| 70 |
|
|
| 76 | 71 |
Editing options |
| 77 | 72 |
^^^^^^^^^^^^^^^ |
| 78 | 73 |
|
| ... | ... | |
| 101 | 96 |
|
| 102 | 97 |
.. code-block:: console |
| 103 | 98 |
|
| 104 |
$ kamaki config set account myusername@mydomain.com
|
|
| 99 |
$ kamaki config set token myT0k3N==
|
|
| 105 | 100 |
|
| 106 |
In the above example, if the kamaki configuration file does not exist, it will be created with all the default values plus the *global.account* option set to *myusername@mydomain.com* value.
|
|
| 101 |
In the above example, if the kamaki configuration file does not exist, it will be created with all the default values plus the *global.token* option set to *myT0k3n==* value.
|
|
| 107 | 102 |
|
| 108 | 103 |
The configuration file is formatted so that it can be parsed by the python ConfigParser module. It consists of command sections that are denoted with brackets. Every section contains variables with values. For example:: |
| 109 | 104 |
|
| 110 | 105 |
[store] |
| 111 | 106 |
url=https://okeanos.grnet.gr/pithos |
| 112 |
account=myaccount@mydomain.com
|
|
| 107 |
token=my0th3rT0k3n==
|
|
| 113 | 108 |
|
| 114 |
two configuration options are created: *store.url* and *store.account*. These values will be loaded at every future kamaki execution.
|
|
| 109 |
two configuration options are created: *store.url* and *store.token*. These values will be loaded at every future kamaki execution.
|
|
| 115 | 110 |
|
| 116 | 111 |
Available options |
| 117 | 112 |
^^^^^^^^^^^^^^^^^ |
| 118 | 113 |
|
| 119 |
The [global] group is treated by kamaki as a generic group for arbitrary options, and it is used as a super-group for vital Kamaki options, namely account, token, url, cli. This feature does not work for types of configuration options. For example if global.account option is set and store.account option is not set, store services will use the global.account option instead. In case of conflict, the most specific options override the global ones.
|
|
| 114 |
The [global] group is treated by kamaki as a generic group for arbitrary options, and it is used as a super-group for vital Kamaki options, namely token, url, cli. In case of conflict, the most specific options overrides the global ones.
|
|
| 120 | 115 |
|
| 121 | 116 |
* global.colors <on|off> |
| 122 | 117 |
enable / disable colors in command line based uis. Requires ansicolors, otherwise it is ignored |
| 123 | 118 |
|
| 124 |
* global.account <account name> |
|
| 125 |
the username or user email that is user to connect to the cloud service. It can be omitted if provided as a service-specific option |
|
| 126 |
|
|
| 127 | 119 |
* global.token <user authentication token> |
| 128 | 120 |
|
| 129 | 121 |
* store.cli <UI command specifications for store> |
| ... | ... | |
| 132 | 124 |
* store.url <OOS storage or Pithos+ service url> |
| 133 | 125 |
the url of the OOS storage or Pithos+ service. Set to Okeanos.grnet.gr Pithos+ storage service by default. Users should set a different value if they need to use a different storage service. |
| 134 | 126 |
|
| 135 |
* store.account <account name> |
|
| 136 |
if set, it overrides possible global.account option for store level commands. |
|
| 137 |
|
|
| 138 | 127 |
* store.token <token> |
| 139 | 128 |
it set, it overrides possible global.token option for store level commands |
| 140 | 129 |
|
Also available in: Unified diff