Revision 85e3803d docs/setup.rst
| b/docs/setup.rst | ||
|---|---|---|
| 1 |
Set up
|
|
| 2 |
======
|
|
| 1 |
Setup |
|
| 2 |
===== |
|
| 3 | 3 |
|
| 4 |
Kamaki is easy to install from source or as a package. Some ui features are optional and can be install seperately. Kamaki behavior can be configured in the kamaki config file.
|
|
| 4 |
Kamaki is easy to install from source or as a package. Some ui features are optional and can be install separately. Kamaki behavior can be configured in the kamaki config file.
|
|
| 5 | 5 |
|
| 6 | 6 |
Requirements |
| 7 | 7 |
------------ |
| ... | ... | |
| 31 | 31 |
|
| 32 | 32 |
Kamaki comes with preset default values to all configuration options. All vital configurion options are set to use the okeanos.grnet.gr cloud services. User information is not included and should be provided either through the kamaki config command or by editing the configuration file. |
| 33 | 33 |
|
| 34 |
Kamaki configuration options are vital for correct Kamaki behavior. An incorrect option may render some command groups disfunctional. There are two ways of managing configuration options: edit the config file or use the kamaki config command.
|
|
| 34 |
Kamaki configuration options are vital for correct Kamaki behavior. An incorrect option may render some command groups dysfunctional. There are two ways of managing configuration options: edit the config file or use the kamaki config command.
|
|
| 35 | 35 |
|
| 36 | 36 |
Using multiple setups |
| 37 | 37 |
^^^^^^^^^^^^^^^^^^^^^ |
| ... | ... | |
| 83 | 83 |
|
| 84 | 84 |
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. |
| 85 | 85 |
|
| 86 |
The configuration file is formated so that it can be parsed by the python Config Parser module. It consists of command sections that are denoted with brackets. Every section contains variables with values. For example:
|
|
| 86 |
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:
|
|
| 87 | 87 |
|
| 88 | 88 |
*[store]* |
| 89 | 89 |
*url=https://okeanos.grnet.gr/pithos* |
| ... | ... | |
| 94 | 94 |
Available options |
| 95 | 95 |
^^^^^^^^^^^^^^^^^ |
| 96 | 96 |
|
| 97 |
The [global] group is treated by kamaki as a generic group for arbitary options, and it is used as a super-group for vital Kamaki options like account, token, or url. 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 overide the global ones.
|
|
| 97 |
The [global] group is treated by kamaki as a generic group for arbitrary options, and it is used as a supergroup for vital Kamaki options like account, token, or url. 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.
|
|
| 98 | 98 |
|
| 99 | 99 |
* global.colors <on|off> |
| 100 |
enable/dissable colors in command line based uis. Requires ansicolors, otherwise it is ignored
|
|
| 100 |
enable/disable colors in command line based uis. Requires ansicolors, otherwise it is ignored |
|
| 101 | 101 |
|
| 102 | 102 |
* global.account <account name> |
| 103 |
the username or user email that is user to connect to the cloud service. It can be ommited if provided as a service-specific option
|
|
| 103 |
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
|
|
| 104 | 104 |
|
| 105 |
* global.token <user authedication token>
|
|
| 105 |
* global.token <user authentication token>
|
|
| 106 | 106 |
|
| 107 | 107 |
* store.cli <UI command specifications for store> |
| 108 | 108 |
a special package that is used to load storage commands to kamaki UIs. Don't touch this unless if you know what you are doing. |
| ... | ... | |
| 111 | 111 |
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. |
| 112 | 112 |
|
| 113 | 113 |
* store.account <account name> |
| 114 |
if set, it overides possible global.account option for store level commands. |
|
| 114 |
if set, it overrides possible global.account option for store level commands.
|
|
| 115 | 115 |
|
| 116 | 116 |
* compute.url <OOS compute or Cyclades service url> |
| 117 | 117 |
the url of the OOS compute or Cyclades service. Set to Okeanos.grnet.gr Cyclades IaaS service by default. Users should set a different value if they need to use a different IaaS service. |
| ... | ... | |
| 135 | 135 |
the url of the Astakos authentication service. Set to the Okeanos.grnet.gr Astakos service by default. Users should set a different value if they need to use a different service. |
| 136 | 136 |
|
| 137 | 137 |
* astakos.cli <UI command specifications for Astakos authentication service> |
| 138 |
a special package that is used to load astakos-related commands to kamaki UIs. Don't touch this unless you know what you are doing. |
|
| 138 |
a special package that is used to load astakos-related commands to kamaki UIs. Don't touch this unless you know what you are doing. |
|
Also available in: Unified diff