Merge pull request #7 from Pansanel/master

Documentation updates

Author: Pansanel

README.md

@@ -1,5 +1,5 @@
 # Cloudkeeper-OS
-Cloudkeeper-OS is the OpenStack backend for [Cloudkeeper](https://github.com/the-cloudkeeper-project/cloudkeeper). It is using OpenStack Python and gRPC Python libraries.
+Cloudkeeper-OS is an OpenStack backend for [Cloudkeeper](https://github.com/the-cloudkeeper-project/cloudkeeper). It interacts with the OpenStack Image Service ([Glance](https://docs.openstack.org/glance)) to manage images representing [EGI AppDB](https://appdb.egi.eu/browse/cloud) Appliances. Cloudkeeper-OS runs as a server listening for [gRPC](https://grpc.io/) communication, usually from Cloudkeeper.
 
 ## Requirements
 * Python >= 2.7
@@ -10,41 +10,51 @@ Cloudkeeper-OS is the OpenStack backend for [Cloudkeeper](https://github.com/the
 * python-oslo-config
 * python-oslo-log
 
-# Installation
+## Installation
 
+### From source
 To install Cloudkeeper-OS, clone the project and run the ```setup.py``` script:
 ```
 $ git clone https://github.com/the-cloudkeeper-project/cloudkeeper-os.git
 $ cd cloudkeeper-os
 $ python setup.py install
+$ mkdir /etc/cloudkeeper-os
+$ cp etc/cloudkeeper-os.conf.sample /etc/cloudkeeper-os/cloudkeeper-os.conf
+$ cp etc/cloudkeeper-os/voms.json /etc/cloudkeeper-os/voms.json
 ```
 
-## Configuration
+Create the ```/usr/lib/systemd/system/cloudkeeper-os.service``` systemd service file with the following content to manage the cloudkeeper-os daemon:
+```
+[Unit]
+Description=OpenStack Cloudkeeper Backend
+After=syslog.target network.target
+
+[Service]
+Type=simple
+User=root
+ExecStart=/usr/bin/cloudkeeper-os
+PrivateTmp=true
+
+[Install]
+WantedBy=multi-user.target
+```
+
+### Using RPMs
 
-Once the backend is installed, you can generate the configuration file using:
+First, download the repo file from the [cloudkeeper-os repository](http://grand-est.fr/resources/software/cloudkeeper-os/repofiles/centos7/cloudkeeper-os.repo) and place it in the ```/etc/yum.repos.d``` directory. Then execute the following commands:
 ```
-mkdir /etc/cloudkeeper-os
-oslo-config-generator --config-file etc/cloudkeeper-os/cloudkeeper-os-config-generator.conf --output /etc/cloudkeeper-os/cloudkeeper-os.conf
+$ yum update
+$ yum install cloudkeeper-os
 ```
 
-The generated configuration file has several sections and has a descritpion for each option. Most of the options have default values.  You should check at least the following parameters in the ```keystone_authtoken``` section:
+## Configuration
+
+The ```cloudkeeper-os.conf``` configuration file has several sections and has a descritpion for each option. Most of the options have default values.  You should check at least the following parameters in the ```keystone_authtoken``` section:
 
 * username
 * password
 * auth_url
 
-In addition, you should have a JSON file containing the map between the VO and the OpenStack project's name:
-```
-{
-    "dteam": {
-        "tenant": "EGI_dteam"
-    },
-    "fedcloud.egi.eu": {
-        "tenant": "EGI_FCTF"
-    },
-    "ops": {
-        "tenant": "EGI_ops"
-    }
-}
-```
+In addition, you have to edit the ```voms.json``` JSON file to map correctly the VO and the OpenStack project's name. Note that you can use the same JSON file as for the ```keystone-voms``` component, by setting the ```mapping_file``` parameter with the right path in the ```cloudkeeper-os.conf``` file.
 
+To take into account the modifications, do not forget to restart the cloudkeeper-os service.

etc/cloudkeeper-os/voms.json

@@ -0,0 +1,8 @@
+{
+    "dteam": {
+        "tenant": "EGI_dteam"
+    },
+    "ops": {
+        "tenant": "EGI_ops"
+    }
+}