Revision abfaa6d9 docs/setup.rst
| b/docs/setup.rst | ||
|---|---|---|
| 13 | 13 |
|
| 14 | 14 |
Kamaki has to be configured for a specific Synnefo deployment, with an |
| 15 | 15 |
authentication url and user token pair. Users should also pick an alias to name |
| 16 |
the cloud configuration. This can be any single word, e.g. "default", "mycloud" |
|
| 16 |
the cloud configuration. This can be any single word, e.g., "default", "mycloud"
|
|
| 17 | 17 |
or whatever suits kamaki users. |
| 18 | 18 |
|
| 19 | 19 |
.. code-block:: console |
| 20 |
|
|
| 20 |
|
|
| 21 | 21 |
$ kamaki config set cloud.<cloud alias>.url <cloud-authentication-URL> |
| 22 | 22 |
$ kamaki config set cloud.<cloud alias>.token myt0k3n== |
| 23 | 23 |
|
| ... | ... | |
| 28 | 28 |
|
| 29 | 29 |
$ kamaki config set default_cloud <cloud alias> |
| 30 | 30 |
|
| 31 |
Since Synnefo version 0.14, a synnefo cloud UI offers a single authentication |
|
| 32 |
URL, which should be set as the cloud URL for kamaki. All service-specific URLs |
|
| 33 |
are retrieved and handled automatically by kamaki, through this URL. Users of |
|
| 34 |
synnefo clouds >=0.14 are advised against using any service-specific URLs. |
|
| 31 |
Since version 0.14, Synnefo supports a single authentication URL for retrieving |
|
| 32 |
all API endpoints. This URL is retrieved from the Synnefo Web UI and should be |
|
| 33 |
set as the cloud URL for kamaki. All service-specific URLs are retrieved and |
|
| 34 |
handled automatically by kamaki, through this URL. Users of Synnefo clouds |
|
| 35 |
>=0.14 are advised against using any service-specific URLs. |
|
| 35 | 36 |
|
| 36 | 37 |
Migrating from kamaki 0.8.X to 0.9 |
| 37 | 38 |
---------------------------------- |
| 38 | 39 |
|
| 39 |
This section refers to running installations of kamaki version <= 0.8.X To |
|
| 40 |
This section refers to running installations of kamaki version <= 0.8.X. To
|
|
| 40 | 41 |
check the current kamaki version: |
| 41 | 42 |
|
| 42 | 43 |
.. code-block:: console |
| ... | ... | |
| 65 | 66 |
... rescue history.file => global.history_file |
| 66 | 67 |
... DONE |
| 67 | 68 |
The following information will NOT be preserved: |
| 68 |
global.account =
|
|
| 69 |
global.account = |
|
| 69 | 70 |
global.data_log = on |
| 70 | 71 |
user.account = exampleuser@example.com |
| 71 | 72 |
user.url = https://accounts.okeanos.grnet.gr |
| ... | ... | |
| 163 | 164 |
|
| 164 | 165 |
.. code-block:: console |
| 165 | 166 |
|
| 166 |
$ kamaki config getcloud
|
|
| 167 |
$ kamaki config getcloud |
|
| 167 | 168 |
cloud.default.url = https://example.com/astakos.identity/v2.0/ |
| 168 | 169 |
cloud.default.url = myd3f4u1770k3n== |
| 169 | 170 |
cloud.devel.url = https://devel.example.com/astakos/identity/v2.0/ |
| ... | ... | |
| 190 | 191 |
|
| 191 | 192 |
$ kamaki --cloud=devel user authenticate |
| 192 | 193 |
... |
| 193 |
user :
|
|
| 194 |
user : |
|
| 194 | 195 |
id : 725d5de4-1bab-45ac-9e98-38a60a8c543c |
| 195 | 196 |
name : Devel User |
| 196 | 197 |
$ |
| 197 | 198 |
$ kamaki --cloud=testing user authenticate |
| 198 | 199 |
... |
| 199 |
user :
|
|
| 200 |
user : |
|
| 200 | 201 |
id : 4ed5d527-bab1-ca54-89e9-c345c8a06a83 |
| 201 | 202 |
name : Testing User |
| 202 | 203 |
$ |
| 203 | 204 |
$ kamaki --cloud=default user authenticate |
| 204 | 205 |
... |
| 205 |
user :
|
|
| 206 |
user : |
|
| 206 | 207 |
id : 4d3f4u17-u53r-4u7h-451n-4u7h3n7ic473 |
| 207 | 208 |
name : Default User |
| 208 | 209 |
$ |
| 209 | 210 |
$ kamaki user authenticate |
| 210 | 211 |
... |
| 211 |
user :
|
|
| 212 |
user : |
|
| 212 | 213 |
id : 4d3f4u17-u53r-4u7h-451n-4u7h3n7ic473 |
| 213 | 214 |
name : Default User |
| 214 | 215 |
$ |
| ... | ... | |
| 227 | 228 |
* Can be switched on/off in kamaki configuration file: `colors = on/off` |
| 228 | 229 |
* Has not been tested on non unix / linux based platforms |
| 229 | 230 |
|
| 230 |
* mock
|
|
| 231 |
* mock |
|
| 231 | 232 |
* For kamaki contributors only |
| 232 | 233 |
* Allow unit tests to run on kamaki.clients package |
| 233 | 234 |
* Needs mock version 1.X or better |
| ... | ... | |
| 245 | 246 |
There are two kinds of configuration options: |
| 246 | 247 |
|
| 247 | 248 |
* kamaki-related (global) |
| 248 |
interface settings and constants of the kamaki internal mechanism, e.g. |
|
| 249 |
interface settings and constants of the kamaki internal mechanism, e.g.,
|
|
| 249 | 250 |
colors in the output, maximum threads per connection, custom logging or |
| 250 | 251 |
history files, etc. |
| 251 | 252 |
|
| 252 | 253 |
* cloud-related |
| 253 | 254 |
information needed to connect and use one or more clouds. There are some |
| 254 |
mandatory options (URL, token) and some advanced / optional (e.g. |
|
| 255 |
mandatory options (URL, token) and some advanced / optional (e.g.,
|
|
| 255 | 256 |
service-specific URL overrides or versions) |
| 256 | 257 |
|
| 257 | 258 |
Kamaki comes with preset default values to all kamaki-releated configuration |
| ... | ... | |
| 319 | 320 |
semantics: |
| 320 | 321 |
|
| 321 | 322 |
* kamaki config get cloud[.<cloud alias>[.option]] |
| 322 |
* cloud
|
|
| 323 |
* cloud |
|
| 323 | 324 |
list all clouds and their settings |
| 324 | 325 |
* cloud.<cloud alias> |
| 325 | 326 |
list settings of the cloud aliased as <cloud alias>. If no |
| ... | ... | |
| 354 | 355 |
.. note:: users of kamaki < 0.9 can use kamaki 0.9.X to automatically convert |
| 355 | 356 |
their old configuration files to the new config file version (>= 3.0). To |
| 356 | 357 |
do this, follow `these instructions <#migrating-from-kamaki-0-8-x-to-0-9>`_ |
| 357 |
|
|
| 358 |
|
|
| 358 | 359 |
A simple way to create the configuration file is to set a configuration option |
| 359 | 360 |
using the kamaki config command. For example: |
| 360 | 361 |
|
| ... | ... | |
| 384 | 385 |
cloud cloud. Kamaki will not be able to run without setting the url and token |
| 385 | 386 |
values to that section. |
| 386 | 387 |
|
| 387 |
More clouds can be created on the side of the default cloud, e.g using the |
|
| 388 |
More clouds can be created on the side of the default cloud, e.g., using the
|
|
| 388 | 389 |
examples at the `multiple clouds guide <#multiple-clouds>`_ :: |
| 389 | 390 |
|
| 390 | 391 |
[cloud "devel"] |
| ... | ... | |
| 511 | 512 |
|
| 512 | 513 |
$ kamaki livetest all |
| 513 | 514 |
|
| 514 |
a specific test (e.g. astakos):: |
|
| 515 |
a specific test (e.g., astakos)::
|
|
| 515 | 516 |
|
| 516 | 517 |
$ kamaki livetest astakos |
| 517 | 518 |
|
| 518 |
or a specific method from a service (e.g. astakos authenticate):: |
|
| 519 |
or a specific method from a service (e.g., astakos authenticate)::
|
|
| 519 | 520 |
|
| 520 | 521 |
$ kamaki livetest astakos authenticate |
| 521 | 522 |
|
Also available in: Unified diff