Update documentation

apiary.apib

@@ -2,8 +2,8 @@ FORMAT: 1A
 HOST: https://store.lab.fiware.org/
 TITLE: FIWARE Business API Ecosystem Open API Specification
 DATE: 23 January 2017
-VERSION: v7.8.0
-PREVIOUS_VERSION: v7.6.0
+VERSION: v8.0.0
+PREVIOUS_VERSION: v7.8.0
 APIARY_PROJECT: fiwaretmfbizecosystem
 SPEC_URL: https://fiwareckanextensions.docs.apiary.io/#
 GITHUB_SOURCE: https://github.com/FIWARE-TMForum

doc/configuration-guide.rst

@@ -243,6 +243,16 @@ In addition, these settings can be configured using the following environment va
     BAE_CB_PAYPAL_CLIENT_ID=client_id
     BAE_CB_PAYPAL_CLIENT_SECRET=client_secret
 
+The charging backend component can be configured to expect or not the user access token to be propagated
+from the business logic proxy component, depending on the use case and the expected plugins to be installed.
+This can be configured with the following setting: ::
+
+    PROPAGATE_TOKEN = True
+
+This setting can be also configured using the environment as follows: ::
+
+    export BAE_CB_PROPAGATE_TOKEN=true
+
 Moreover, the Charging Backend is the component that activates the purchased services. In this regard, the Charging Backend
 has the possibility of signing its acquisition notifications with a certificate, so the external system being offered can
 validate that is the Charging Backend the one making the request. To use this functionality it is needed to configure the
@@ -382,7 +392,7 @@ role has to be granted to users within IdM organizations.
 
 The *isLegacy* flag is used to specify whether the configured IDM is version 6 or lower, by default this setting is false. 
 
-The OAuth2 settings cane be configured using the environment as follows: ::
+The OAuth2 settings can be configured using the environment as follows: ::
 
     export BAE_LP_OAUTH2_SERVER=https://account.lab.fiware.org
     export BAE_LP_OAUTH2_CLIENT_ID=client_id
@@ -394,6 +404,26 @@ The OAuth2 settings cane be configured using the environment as follows: ::
 
     export BAE_LP_OAUTH2_IS_LEGACY=false
 
+Starting from version 8.0.0 the BAE supports multiple external IDPs to be configured in order to allow organizations
+to login using their own IDP, when registered in a trust provider like iShare. To enable such feature the following setting
+needs to be configured: ::
+
+    config.extLogin = true;
+
+This setting can be also configured using the environment as follows: ::
+
+    export BAE_LP_EXT_LOGIN=true
+
+In addition, it is possible to configure whether the proxy component should propagate user access token
+to the backend components (charging backend, RSS and APIs), depending on the use case and the plugins
+installed. To configure such setting, the following is used: ::
+
+    config.propagateToken = true;
+
+That can be configured using the environment as follows: ::
+
+    export BAE_LP_PROPAGATE_TOKEN=true
+
 Moreover, the Proxy uses MongoDB for maintaining some info, such as the current shopping cart of a user. you can configure
 the connection to MongoDB by updating the following setting: ::
 

doc/docker-guide.rst

@@ -2,7 +2,7 @@
 Docker Deployment Guide
 =======================
 
-This guide covers the deployment of the Business API Ecosystem version 7.8.0 using the Docker images provided in docker hub.
+This guide covers the deployment of the Business API Ecosystem version 8.0.0 using the Docker images provided in docker hub.
 
 As stated, the Business API Ecosystem in made up of a set of different components which work jointly in order to provide
 the functionality. In this regard the following images has been defined:
@@ -46,7 +46,7 @@ file deploys the whole system and databases (A running version of this file can
                 - MYSQL_DATABASE=RSS
 
         charging:
-            image: fiware/biz-ecosystem-charging-backend:v7.8.0
+            image: fiware/biz-ecosystem-charging-backend:v8.0.0
             links:
                 - mongo
             depends_on:
@@ -102,7 +102,7 @@ file deploys the whole system and databases (A running version of this file can
             - BAE_CB_AUTHORIZE_SERVICE=http://proxy.docker:8004/authorizeService/apiKeys
 
         proxy:
-            image: fiware/biz-ecosystem-logic-proxy:v7.8.0
+            image: fiware/biz-ecosystem-logic-proxy:v8.0.0
             links:
                 - mongo
                 - elasticsearch
@@ -191,7 +191,7 @@ file deploys the whole system and databases (A running version of this file can
                 - MYSQL_HOST=mysql
 
         rss:
-            image: fiware/biz-ecosystem-rss:v7.8.0
+            image: fiware/biz-ecosystem-rss:v8.0.0
             restart: always
             ports:
                 - 9999:8080

doc/index.rst

@@ -26,7 +26,7 @@ In particular, the Business API Ecosystem is made of the following components:
 * *Business Ecosystem RSS*: Is in charge of distributing the revenues originated by the usage of a given service among the involved stakeholders. In particular, it focuses on distributing part of the revenue generated by a service between the Business API Ecosystem instance provider and the Service Provider(s) responsible for the service. With the term "service" we refer to both final applications and backend application services (typically exposed through an API). Note that, in the case of composite services, more than one service provider may have to receive a share of the revenues.
 * *Business Ecosystem Logic Proxy*: Acts as the endpoint for accessing the Business API Ecosystem. On the one hand, it orchestrates the APIs validating user requests, including authentication, authorization, and the content of the request from a business logic point of view. On the other hand, it serves a web portal that can be used to interact with the system.
 
-The current documentation covers the Business API Ecosystem version 7.8.0, corresponding to FIWARE release 7. Any feedback on this document is highly welcomed, including bugs,
+The current documentation covers the Business API Ecosystem version 8.0.0, corresponding to FIWARE release 8. Any feedback on this document is highly welcomed, including bugs,
 typos or things you think should be included but aren't. Please send them to the "Contact Person" email that appears in the 
 `Catalogue page for this GEi`_. Or create an issue at `GitHub Issues`_
 
@@ -37,11 +37,11 @@ typos or things you think should be included but aren't. Please send them to the
 Index
 =====
 
-:doc:`installation-administration-guide`
-  The guide for maintainers that explains how to install it.
-
 :doc:`docker-guide`
-  The guide for maintainers that explains how to use Docker for deploying it
+  The guide for maintainers that explains how to use Docker for deploying it (Recomended)
+
+:doc:`installation-administration-guide`
+  The guide for maintainers that explains how to install it manually.
 
 :doc:`configuration-guide`
   The guide for administrations which explains the different configuration options

doc/installation-administration-guide.rst

@@ -2,7 +2,7 @@
 Installation and Administration Guide
 =====================================
 
-This guide covers the installation of the Business API Ecosystem v7.8.0 from the sources available in GitHub, installing manually
+This guide covers the installation of the Business API Ecosystem v8.0.0 from the sources available in GitHub, installing manually
 the software dependencies and using the existing scripts for setting up the system.
 
 The current version of the software has been tested under Ubuntu 15.10, Ubuntu 16.04, Ubuntu 18.04, Debian 7, Debian 8,
@@ -398,7 +398,7 @@ The first step for installing the RSS component is downloading it and moving to
 
     $ git clone https://github.com/FIWARE-TMForum/business-ecosystem-rss.git
     $ cd business-ecosystem-rss
-    $ git checkout v7.8.0
+    $ git checkout v8.0.0
 
 Then, the next step is coping, *database.properties* and *oauth.properties* files to its default location at */etc/default/rss* ::
 
@@ -445,7 +445,7 @@ The first step for installing the charging backend component is downloading it a
 
     $ git clone https://github.com/FIWARE-TMForum/business-ecosystem-charging-backend.git
     $ cd business-ecosystem-charging-backend
-    $ git checkout v7.8.0
+    $ git checkout v8.0.0
 
 Once the code has been downloaded, it is recommended to create a virtualenv for installing python dependencies (This is not mandatory). ::
 
@@ -577,7 +577,7 @@ The first step for installing the logic proxy component is downloading it and mo
 
     $ git clone https://github.com/FIWARE-TMForum/business-ecosystem-logic-proxy.git
     $ cd business-ecosystem-logic-proxy
-    $ git checkout v7.8.0
+    $ git checkout v8.0.0
 
 Once the code has been downloaded, Node dependencies can be installed with the provided script as follows ::
 

doc/user-guide.rst

@@ -97,6 +97,13 @@ You can *Edit* or *Remove* the contact medium by clicking on the corresponding b
 Admin
 =====
 
+If the external IDPs feature is enabled, admins should login in the system with the local IDPs by directly accessing
+to the login URL in the browser: ::
+
+   https://[marketurl]/login
+
+If the external IDP is disabled, the login button will use the local IDP.
+
 If the user of the Business API Ecosystem is an admin, he will be able to access the *Administration* section of the
 web portal. This section is located in the user menu.
 
@@ -137,6 +144,26 @@ Then edit the corresponding fields and click on *Update*.
 .. image:: ./images/user/cat7.png
    :align: center
 
+Manage IDPs
+-----------
+
+If the external IDPs option is enabled, *admins* are authorized to register them using the *Administration* section.
+
+To list existing IDPs access to *IDPs*:
+
+.. image:: ./images/admin/idps1.png
+   :align: center
+
+.. image:: ./images/admin/idps2.png
+   :align: center
+
+To register a new IDP click in *New*. In the displayed form, fill the *IDP EORI* with the EORI given to the IDP
+by the trust provider (i.e iShare). Provide a name and an optional description and fill *Server* with the URL
+of the IDP.
+
+.. image:: ./images/admin/idps3.png
+   :align: center
+
 Seller
 ======