code.grnet.gr Git - kamaki/blob - docs/setup.rst

   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 Quick Setup
   7 -----------
   8
   9 The set up settings of the present paragraph are the only ones needed to have kamaki up and running all its client services.
  10
  11 It is essential for users to get a configuration token (okeanos.grnet.gr users go `here <https://accounts.okeanos.grnet.gr/im/>`_) and provide it to kamaki:
  12
  13 .. code-block:: console
  14     :emphasize-lines: 1
  15
  16     Example 1.1: Set user token to myt0k3n==
  17
  18     $ kamaki set token myt0k3n==
  19
  20 To use the storage service, a user should also provide the corresponding user-name:
  21
  22 .. code-block:: console
  23     :emphasize-lines: 1
  24
  25     Example 1.2: Set user name to user@domain.com
  26
  27     $ kamaki set account user@domain.com
  28
  29 Optional features
  30 -----------------
  31
  32 For installing any all of the following, consult the `kamaki installation guide <installation.html#install-progress-and-or-ansicolors-optional>`_
  33
  34 * ansicolors
  35     * Make command line / console user interface responses prettier with text formating (colors, bold, etc.)
  36     * Can be switched on/off in kamaki configuration file: colors=on/off
  37
  38 * progress
  39     * Attach progress bars to various kamaki commands (e.g. kamaki store upload)
  40     * Since version 0.6.1 kamaki "requires" progress version 1.0.2 or better
  41
  42 Any of the above features can be installed at any time before or after kamaki installation.
  43
  44 Configuration options
  45 ---------------------
  46
  47 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.
  48
  49 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.
  50
  51 Using multiple setups
  52 ^^^^^^^^^^^^^^^^^^^^^
  53
  54 Kamaki setups are stored in configuration files. By default, a Kamaki installation stores options in *.kamakirc* file located at the user home directory.
  55
  56 If a user needs to switch between different setups, Kamaki can explicitly load configuration files with the --config option:
  57
  58 .. code-block:: console
  59
  60     $ kamaki --config <custom_config_file_path> [other options]
  61
  62 Using many different configuration files for different cloud services is encouraged.
  63
  64 Modifying options at runtime
  65 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  66
  67 All kamaki commands can be used with the -o option in order to override configuration options at runtime. For example::
  68
  69 .. code-block:: console
  70
  71     $ kamaki store list -o global.account=anotheraccount -o global.token=aT0k3n==
  72
  73 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.
  74
  75 Editing options
  76 ^^^^^^^^^^^^^^^
  77
  78 Kamaki config command allows users to see and manage all configuration options.
  79
  80 * kamaki config list
  81     lists all configuration options currently used by a Kamaki installation
  82
  83 * kamaki config get <group.option>
  84     show the value of a specific configuration option. Options must be of the form group.option
  85
  86 * kamaki config set <group.option> <value>
  87     set the group.option to value
  88
  89 * kamaki config delete <group.option>
  90     delete a configuration option
  91
  92 The above commands cause option values to be permanently stored in the Kamaki configuration file.
  93
  94 Editing the configuration file
  95 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  96
  97 The configuration file is a simple text file that can be created by the user.
  98
  99 A simple way to create the configuration file is to set a configuration option using the kamaki config command. For example:
 100
 101 .. code-block:: console
 102
 103     $ kamaki config set account myusername@mydomain.com
 104
 105 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.
 106
 107 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::
 108
 109     [store]
 110     url=https://okeanos.grnet.gr/pithos
 111     account=myaccount@mydomain.com
 112
 113 two configuration options are created: *store.url* and *store.account*. These values will be loaded at every future kamaki execution.
 114
 115 Available options
 116 ^^^^^^^^^^^^^^^^^
 117
 118 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.
 119
 120 * global.colors <on|off>
 121     enable / disable colors in command line based uis. Requires ansicolors, otherwise it is ignored
 122
 123 * global.account <account name>
 124     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
 125
 126 * global.token <user authentication token>
 127
 128 * store.cli <UI command specifications for store>
 129     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.
 130
 131 * store.url <OOS storage or Pithos+ service url>
 132     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.
 133
 134 * store.account <account name>
 135     if set, it overrides possible global.account option for store level commands.
 136
 137 * compute.url <OOS compute or Cyclades service url>
 138     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.
 139
 140 * cyclades.cli <UI command specifications for cyclades>
 141     a special package that is used to load cyclades commands to kamaki UIs. Don't touch this unless you know what you are doing.
 142
 143 * flavor.cli <UI command specifications for VM flavors>
 144     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.
 145
 146 * network.cli <UI command specifications for virtual networks>
 147     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.
 148
 149 * image.url <Plankton image service url>
 150     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.
 151
 152 * image.cli <UI command specifications for Plankton and Cyclades image service>
 153     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.
 154
 155 * astakos.url <Astakos authentication service url>
 156     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.
 157
 158 * astakos.cli <UI command specifications for Astakos authentication service>
 159     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.
 160
 161 * history.file <history file path>
 162     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
 163
 164 Hidden features
 165 ^^^^^^^^^^^^^^^
 166
 167 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::
 168
 169     [test]
 170     cli=test_cli
 171
 172 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.