Multi-server installation

What is multi-server installation

The multi-server installation is how to configure a FIWARE instance with multiple VMs. You can configure a FIWARE instance with a VM installed Keyrock and VMs installed other FIWARE GEs. The VM installed Keyrock is called a main VM. The VM installed other FIWARE GEs is called an additional VM.

Configuration parameters

You can specify configurations by editing the config.sh file.

Variable name	Description	Default value
MULTI_SERVER_KEYROCK	Keyrock URL. E.g. https://keyrock.exmaple.com	(empty)
MULTI_SERVER_ADMIN_EMAIL	An email address of an admin user for Keyrock. E.g. admin@example.com	(empty)
MULTI_SERVER_ADMIN_PASS	A password of an admin user for Keyrock.	(empty)
MULTI_SERVER_PEP_PROXY_USERNAME	A username for Wilma PEP Proxy.	(empty)
MULTI_SERVER_PEP_PASSWORD	A password for Wilma PEP Proxy.	(empty)
MULTI_SERVER_CLIENT_ID	A client id.	(empty)
MULTI_SERVER_CLIENT_SECRET	A client secret.	(empty)
MULTI_SERVER_ORION_HOST	Orion host when installing WireCloud. (Required) E.g. orion.exmaple.com	(empty)
MULTI_SERVER_QUANTUMLEAP_HOST	QuantumLeap host when installing WireCloud. (Optional) E.g. quantumleap.exmaple.com	(empty)
MULTI_SERVER_ORION_INTERNAL_IP	Orion internal IP address when installing IoT Agent or Perseo. (Required) E.g. 192.168.0.1	(empty)

How to setup

To get the basic variables for Multi-server installation, run the following command at a VM where Keyrock is installed. You can paste them in config.sh on another VM.

Request:

make multi-server

Response:

MULTI_SERVER_KEYROCK=https://keyrock.example.com
MULTI_SERVER_ADMIN_EMAIL=admin@example.com
MULTI_SERVER_ADMIN_PASS=JSyJiEVon6MIliBL

MULTI_SERVER_PEP_PROXY_USERNAME=pep_proxy_a3aff992-c3a2-4b39-8728-22eed803ccda
MULTI_SERVER_PEP_PASSWORD=pep_proxy_a00226e8-5c6e-47de-9137-40a9a932bda0

MULTI_SERVER_CLIENT_ID=1db4e864-851e-4b39-a952-ac70ca8f6bfc
MULTI_SERVER_CLIENT_SECRET=8cb45711-b992-4ef4-9eb4-cb6391d48b9a

Example

Configuration examples for multi-server installation are as shown:

Example 1

Keyrock and Orion are installed sepertally VMs.

VMs	FIWARE GEs
Main VM	Keyrock
Additonal VM	Orion

Configuration for a main VM

KEYROCK=keyrock
ORION=

Configuration for an additional VM

KEYROCK=
ORION=orion

MULTI_SERVER_KEYROCK=https://keyrock.example.com
MULTI_SERVER_ADMIN_EMAIL=admin@example.com
MULTI_SERVER_ADMIN_PASS=JSyJiEVon6MIliBL

MULTI_SERVER_PEP_PROXY_USERNAME=pep_proxy_a3aff992-c3a2-4b39-8728-22eed803ccda
MULTI_SERVER_PEP_PASSWORD=pep_proxy_a00226e8-5c6e-47de-9137-40a9a932bda0

MULTI_SERVER_CLIENT_ID=1db4e864-851e-4b39-a952-ac70ca8f6bfc
MULTI_SERVER_CLIENT_SECRET=8cb45711-b992-4ef4-9eb4-cb6391d48b9a

Example 2

Keyrock and Orion are installed in a main VM. WireCloud is installed in an additional VM.

VMs	FIWARE GEs
Main VM	Keyrock, Orion
Additonal VM	WireCloud

Configuration for a main VM

KEYROCK=keyrock
ORION=orion

Configuration for an additional VM

KEYROCK=
ORION=
WIRECLOUD=wirecloud
NGSIPROXY=ngsiproxy

MULTI_SERVER_KEYROCK=https://keyrock.example.com
MULTI_SERVER_ADMIN_EMAIL=admin@example.com
MULTI_SERVER_ADMIN_PASS=JSyJiEVon6MIliBL

MULTI_SERVER_PEP_PROXY_USERNAME=pep_proxy_a3aff992-c3a2-4b39-8728-22eed803ccda
MULTI_SERVER_PEP_PASSWORD=pep_proxy_a00226e8-5c6e-47de-9137-40a9a932bda0

MULTI_SERVER_CLIENT_ID=1db4e864-851e-4b39-a952-ac70ca8f6bfc
MULTI_SERVER_CLIENT_SECRET=8cb45711-b992-4ef4-9eb4-cb6391d48b9a

MULTI_SERVER_ORION_HOST=orion.exmaple.com

Example 3

Keyrock and Orion are installed in a main VM. Cygnus and PostgreSQL are installed in an additional VM.

VMs	FIWARE GEs
Main VM	Keyrock, Orion
Additonal VM	Cygnus, PostgreSQL

Configuration for a main VM

KEYROCK=keyrock
ORION=orion

Configuration for an additional VM

Expose the port of Cygnus with CYGNUS_EXPOSE_PORT=all so that Orion can notify Cygnus of context changes. You should close the exposed port using a network equipment such as firewall so that it is not accessible from the internet.

KEYROCK=
ORION=
CYGNUS=cygnus
CYGNUS_POSTGRES=true
CYGNUS_EXPOSE_PORT=all

MULTI_SERVER_KEYROCK=https://keyrock.example.com
MULTI_SERVER_ADMIN_EMAIL=admin@example.com
MULTI_SERVER_ADMIN_PASS=JSyJiEVon6MIliBL

MULTI_SERVER_PEP_PROXY_USERNAME=pep_proxy_a3aff992-c3a2-4b39-8728-22eed803ccda
MULTI_SERVER_PEP_PASSWORD=pep_proxy_a00226e8-5c6e-47de-9137-40a9a932bda0

MULTI_SERVER_CLIENT_ID=1db4e864-851e-4b39-a952-ac70ca8f6bfc
MULTI_SERVER_CLIENT_SECRET=8cb45711-b992-4ef4-9eb4-cb6391d48b9a

MULTI_SERVER_ORION_HOST=orion.exmaple.com

Specify a private IP Address of a VM where Cygnus is running when creating a subscription for Cygnus. The port for PostgreSQL is 5055.

ngsi create \
  --host "orion.example.com" \
  --service openiot \
  --path / \
  subscription \
  --description "Notify Cygnus of all context changes and store it into PostgreSQL" \
  --idPattern ".*" \
  --uri "http://192.168.0.2:5055/notify"

Example 4

Keyrock and Orion are installed in a main VM. IoT Agent for JSON is installed in an additional VM.

VMs	FIWARE GEs
Main VM	Keyrock, Orion
Additonal VM	IoT Agent for JSON over MQTT TLS

Configuration for a main VM

Expose the port 1026 of Orion with ORION_EXPOSE_PORT=all so that IoT Agent can access Orion.

KEYROCK=keyrock
ORION=orion
ORION_EXPOSE_PORT=all

Configuration for an additional VM

Set a private IP address of a VM where Orion is running to MULTI_SERVER_ORION_INTERNAL_IP. You should close the exposed port using a network equipment such as firewall so that it is not accessible from the internet.

KEYROCK=
ORION=
IOTAGENT_JSON=iotagent-json
MOSQUITTO=mosquitto
MQTT_TLS=true

MULTI_SERVER_KEYROCK=https://keyrock.example.com
MULTI_SERVER_ADMIN_EMAIL=admin@example.com
MULTI_SERVER_ADMIN_PASS=JSyJiEVon6MIliBL

MULTI_SERVER_PEP_PROXY_USERNAME=pep_proxy_a3aff992-c3a2-4b39-8728-22eed803ccda
MULTI_SERVER_PEP_PASSWORD=pep_proxy_a00226e8-5c6e-47de-9137-40a9a932bda0

MULTI_SERVER_CLIENT_ID=1db4e864-851e-4b39-a952-ac70ca8f6bfc
MULTI_SERVER_CLIENT_SECRET=8cb45711-b992-4ef4-9eb4-cb6391d48b9a

MULTI_SERVER_ORION_HOST=orion.exmaple.com

MULTI_SERVER_ORION_INTERNAL_IP=192.168.0.1