Statistics
| Branch: | Tag: | Revision:

root / docs / setup.rst @ d88ba587

History | View | Annotate | Download (7.6 kB)

1
Setup
2
=====
3

    
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

    
6
Optional features
7
-----------------
8

    
9
For installing any all of the following, consult the `kamaki installation guide <installation.html#install-progress-and-or-ansicolors-optional>`_
10

    
11
* ansicolors
12
    * Make command line / console user interface responses prettier with text formating (colors, bold, etc.)
13
    * Can be switched on/off in kamaki configuration file: colors=on/off
14

    
15
* progress 
16
    * Attach progress bars to various kamaki commands (e.g. kamaki store upload)
17
    * Since version 0.6.1 kamaki "requires" progress version 1.0.2 or better
18

    
19
Any of the above features can be installed at any time before or after kamaki installation.
20

    
21
Configuration options
22
---------------------
23

    
24
Kamaki comes with preset default values to all configuration options. All vital configuration 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.
25

    
26
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.
27

    
28
Using multiple setups
29
^^^^^^^^^^^^^^^^^^^^^
30

    
31
Kamaki setups are stored in configuration files. By default, a Kamaki installation stores options in *.kamakirc* file located at the user home directory.
32

    
33
If a user needs to switch between different setups, Kamaki can explicitly load configuration files with the --config option:
34

    
35
.. code-block:: console
36

    
37
    $ kamaki --config <custom_config_file_path> [other options]
38

    
39
Using many different configuration files for different cloud services is encouraged.
40

    
41
Modifying options at runtime
42
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
43

    
44
All kamaki commands can be used with the -o option in order to override configuration options at runtime. For example::
45

    
46
.. code-block:: console
47

    
48
    $ kamaki store list -o global.account=anotheraccount -o global.token=aT0k3n==
49

    
50
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.
51

    
52
Editing options
53
^^^^^^^^^^^^^^^
54

    
55
Kamaki config command allows users to see and manage all configuration options.
56

    
57
* kamaki config list
58
    lists all configuration options currently used by a Kamaki installation
59

    
60
* kamaki config get <group.option>
61
    show the value of a specific configuration option. Options must be of the form group.option
62

    
63
* kamaki config set <group.option> <value>
64
    set the group.option to value
65

    
66
* kamaki config delete <group.option>
67
    delete a configuration option
68

    
69
The above commands cause option values to be permanently stored in the Kamaki configuration file.
70

    
71
Editing the configuration file
72
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
73

    
74
The configuration file is a simple text file that can be created by the user.
75

    
76
A simple way to create the configuration file is to set a configuration option using the kamaki config command. For example:
77

    
78
.. code-block:: console
79

    
80
    $ kamaki config set account myusername@mydomain.com
81

    
82
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.
83

    
84
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::
85

    
86
    [store]
87
    url=https://okeanos.grnet.gr/pithos
88
    account=myaccount@mydomain.com
89

    
90
two configuration options are created: *store.url* and *store.account*. These values will be loaded at every future kamaki execution.
91

    
92
Available options
93
^^^^^^^^^^^^^^^^^
94

    
95
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.
96

    
97
* global.colors <on|off>
98
    enable / disable colors in command line based uis. Requires ansicolors, otherwise it is ignored
99

    
100
* global.account <account name>
101
    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
102

    
103
* global.token <user authentication token>
104

    
105
* store.cli <UI command specifications for store>
106
    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.
107

    
108
* store.url <OOS storage or Pithos+ service url>
109
    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.
110

    
111
* store.account <account name>
112
    if set, it overrides possible global.account option for store level commands.
113

    
114
* compute.url <OOS compute or Cyclades service url>
115
    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.
116

    
117
* cyclades.cli <UI command specifications for cyclades>
118
    a special package that is used to load cyclades commands to kamaki UIs. Don't touch this unless you know what you are doing.
119

    
120
* flavor.cli <UI command specifications for VM flavors>
121
    a special package that is used to load cyclades VM flavor commands to kamaki UIs. Don't touch this unless you know what you are doing.
122

    
123
* network.cli <UI command specifications for virtual networks>
124
    a special package that is used to load cyclades virtual network commands to kamaki UIs. Don't touch this unless you know what you are doing.
125

    
126
* image.url <Plankton image service url>
127
    the url of the Plankton service. Set to Okeanos.grnet.gr Plankton service be default. Users should set a different value if they need to use a different service.
128

    
129
* image.cli <UI command specifications for Plankton and Cyclades image service>
130
    a special package that is used to load image-related commands to kamaki UIs. Don't touch this unless you know what you are doing.
131

    
132
* astakos.url <Astakos authentication service url>
133
    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.
134

    
135
* astakos.cli <UI command specifications for Astakos authentication service>
136
    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.
137

    
138
* history.file <history file path>
139
    the path of a simple file for inter-session kamaki history. Make sure kamaki is executed in a context where this file is accessible for reading and writing. Kamaki automatically creates the file if it doesn't exist
140

    
141
Hidden features
142
^^^^^^^^^^^^^^^
143

    
144
Since version 0.6.1 kamaki contains a test suite for the kamaki.clients API. The test suite can be activated with the following option on the configuration file::
145

    
146
    [test]
147
    cli=test_cli
148

    
149
After that, users can run "kamaki test" commands to unit-test the prepackaged client APIs. Unit-tests are still experimental and there is a high probability of false alarms due to some of the expected values being hard-coded in the testing code.