Skip to content

Latest commit

 

History

History
100 lines (67 loc) · 2.83 KB

README.md

File metadata and controls

100 lines (67 loc) · 2.83 KB
Raw

Deploying local instance of the Business API Ecosystem

Deploying local Business API Ecosystem (BAE) and Keyrock Identity Provider (IDP) instance with docker compose.

Remarks

The components reside in a docker network 'bae' created when using docker compose. Within this network, containers can communicate with each other.

This setup uses fixed IPs for each container within the subnet 10.2.0.0/16. Therefore make sure that no IPs are already being used in this subnet.

Deployment

The following describes how to configure and deploy the required containers for the databases:

  • MySQL
  • MongoDB
  • elasticsearch

the Keyrock IDP and the containers for the different BAE components of:

  • APIs
  • RSS
  • Charging Backend
  • Logic Proxy

This setup comes with a default configuration for running a standard instance of the BAE. The Keyrock database is initialized with an application 'Marketplace' for the BAE in order to use this Keyrock instance as a local IDP for login at the BAE via OAuth2.

To deploy all components, simply run:

docker-compose up -d

For stopping all containers:

docker-compose down

Configuration

Configuration is done via environment variables stored in the .env file and separate env files in the envs/ directory.

To change certain parameters, e.g., adding a configuration to participate in an i4Trust data space, make a copy of the default .env file

cp .env my.env

edit the my.env file according to your needs and then deploy all components with

docker-compose --env-file ./my.env up -d

Usage

BAE

As soon as the Logic Proxy component of the BAE (container name: 'bae-proxy') is healthy, you can open the marketplace start page on your host's browser by opening the URL: http://10.2.0.23:8004. Login is performed using the pre-configured Keyrock IDP. For a first test, hit the 'Sign in' button and enter the admin credentials:

Username: [email protected]
Password: admin

Authorize the Marketplace and then you are logged in as a user with admin priviliges on the BAE.

Note, that when enabling external IDPs from an i4Trust data space, you might also enable showing the 'Local Login' button with the ENV BAE_LP_SHOW_LOCAL_LOGIN, in order to be also able to use the locally configured Keyrock for login. If not, the local IDP can be used for login by directly entering http://10.2.0.23:8004/login at the host's browser.

Keyrock

You can also login directly at the Keyrock IDP by opening http://10.2.0.10:8080 within your browser and using the same admin credentials. When being logged in, you will find a pre-configured Application for the BAE (Marketplace). Within the Admin UI, you can add further users and authorize them for the BAE.