Baf 849/fleet management

.gitmodules

@@ -1,3 +1,6 @@
 [submodule "fleet-protocol"]
 	path = fleet-protocol
 	url = https://github.com/bringauto/fleet-protocol.git
+[submodule "scripts/fleet-init"]
+	path = scripts/fleet-init
+	url = https://github.com/bringauto/fleet-init.git

README.md

@@ -1,4 +1,3 @@
-
 # BringAuto virtual development platform
 
 It's intended to simplify development for [Fleet] and The Autonomy developers.
@@ -8,16 +7,21 @@ The system can be used by docker compose stored at the git root of this reposito
 There are multiple containers
 
 - VerneMQ MQTT broker (bringauto/vernemq)
-- Virtual Vehicle Utility - Mission module client implementation (it connects to Module Gateway and simulates an Mission module's autonomy device)
+- Virtual Vehicle Utility - Mission module client implementation (it connects to Module Gateway and simulates a Mission
+  module's autonomy device)
 - Virtual PLC - IO module client
 - Module Gateway - cpp implementation of Module Gateway with Mission, IO and example module support
 - External server - server implementation with Mission, IO and example module support
 - HTTP API Server - tool for communication with final endpoint, used by mission module
+- Integration layer - a bridge between the HTTP API and the Fleet Management API
+- Fleet Management API - an API that handles creating orders for cars and displaying their state
+- Virtual Fleet Management - application simulating Fleet Management. It creates orders for cars.
 - PostgreSQL database - storage of the HTTP API api keys and the messages sent via the API
 
 ## Fleet Protocol
 
 To read more about the system architecture look at Fleet Protocol v2 documentation:
+
 - [Summary]
 - [Fleet Protocol Requirements]
 - [Internal Client]
@@ -31,7 +35,7 @@ To read more about the system architecture look at Fleet Protocol v2 documentati
 - [HTTP API]
 - [HTTP API Wait Mechanism]
 
-To use Fleet Protocol v1, use the latest release on [GitHub](https://github.com/bringauto/etna/tree/v1.2.2).
+To use Fleet Protocol v1, use the latest v1 release on [GitHub](https://github.com/bringauto/etna/tree/v1.2.2).
 
 ## Requirements
 
@@ -40,63 +44,109 @@ To use Fleet Protocol v1, use the latest release on [GitHub](https://github.com/
 
 ## Usage
 
-
 Docker compose file has multiple profiles so the developer can disable/enable parts of the system he needs
 
 - all - start all containers including MQTT, virtual vehicle, daemon, and virtual fleet
 - without-module-gateway - do not start Module Gateway
 - without-external-server - do not start External Server
 - without-devices - do not start internal clients
+- without-fleet-management - do not start Virtual Fleet Management
 - core - start only internal clients and Module Gateway
 - virtual-vehicle-utility - start only Virtual Vehicle Utility
 - virtual-plc - start only Virtual PLC
 - mqtt - start only MQTT vernemq broker
 - module-gateway - start only Module Gateway
-- http-api -  start HTTP API server and the related PostgreSQL database
+- http-api - start HTTP API server and the related PostgreSQL database
 
-Now you can run `docker-compose --profile=<profile> up` where `profile` is the name of the profile above.
+Now you can run `docker compose --profile <profile> up` where `profile` is the name of the profile above.
 
 To run components with different arguments you can edit the configuration files placed under configuration/<component>
 
 ### HTTP API
-To show the OpenAPI specification (the service must be running), visit http://localhost:8080/openapi.json. 
-To explore the API endpoints and entities, visit http://localhost:8080/ui. More on Swagger UI is [here](https://swagger.io/tools/swagger-ui/).
 
-The HTTP API requires authentication via API keys. To access all its endpoints, you can use the key `StaticAccessKeyToBeUsedByDevelopersOnEtna`.
+To show the OpenAPI specification (the service must be running), visit http://localhost:8080/v2/protocol/openapi.json.
+To explore the API endpoints and entities, visit http://localhost:8080/v2/protocol/ui. More on Swagger UI
+is [here](https://swagger.io/tools/swagger-ui/).
+
+The HTTP API requires authentication via API keys. To access all its endpoints, you can use the
+key `ProtocolStaticAccessKey`.
+
+The database access information and message cleanup can be set in the `configuration/http-api/config.json` (this config
+overwrites the original config from the http-api image).
+
+### Fleet Management API
+
+To show the OpenAPI specification (the service must be running), visit http://localhost:8081/v2/management/openapi.json.
+To explore the API endpoints and entities, visit http://localhost:8081/v2/management/ui. More on Swagger UI
+is [here](https://swagger.io/tools/swagger-ui/).
+
+The Fleet Management API requires authentication via API keys. To access all its endpoints, you can use the
+key `ManagementStaticAccessKey`.
+
+The database access information and the number of stored states and orders can be set
+in `configuration/management-api/config.json` (this config overwrites the original config from the management-api
+image).
 
-The database access information and message cleanup can be set in the `configuration/http-api/config.json` (this config overwrites the original config from the http-api image).
+### Virtual Fleet Management
+
+Simulates the Fleet Management ([documentation](https://github.com/bringauto/virtual-fleet-management/blob/main/README.md).
+
+The Virtual Fleet Management uses `env` variables to set:
+- **ETNA_VFM_SCENARIO** : Changes the scenario that the Virtual Fleet Management will use.
+- **ETNA_VFM_CONFIG** : Changes the configuration of the Virtual Fleet Management.
+
+All the scenarios and configurations must be stored in the `configuration/virtual-fleet-management` directory, so the docker container has access to it.
+Both variables have default values, so the Virtual Fleet Management can be started without setting them.
+
+### Common Issues
+
+- external-server and module-gateway connect sequence
+    - mqtt tends to be unstable in some cases, which could lead to problems in ES and MG communication. Consider
+      changing the mqtt_timeout in ES config if there are connection problems (numbers greater than 15 and no multiples
+      of 15 should be used)
+- postgresql databases
+    - databases are created only on container creation (if you have an old container, it needs to be deleted)
+- http APIs
+    - by default API containers wait for the postgresql database to be available. If the database fails to initialize,
+      the containers won't start
 
 ## MQTT IP and Port
+
 The MQTT uses a standard plain (not encrypted) connection on port 1883 and an SSL encrypted connection on port 8883.
 
-There are [pregenerated certificate files] for both, server and client, however, it is not recommended to use those, and they are there for Etna to work out-of-box.
+There are [pregenerated certificate files] for both, server and client, however, it is not recommended to use those, and
+they are there for Etna to work out-of-box.
 
-If you generate new certificate files they must have the same name as the original, otherwise, you have to change the paths in file `configuration/mosquitto/mosquitto.conf`.
+If you generate new certificate files they must have the same name as the original, otherwise, you have to change the
+paths in file `configuration/mosquitto/mosquitto.conf`.
 
-> Directory `configuration/mosquitto/certs`, include files `cacert.pem` (certificate authority), `server.crt` (signed certificate for the server) and `server.key` (servers private key).
+> Directory `configuration/mosquitto/certs`, include files `cacert.pem` (certificate authority), `server.crt` (signed
+> certificate for the server) and `server.key` (servers private key).
 
 ## Topics to listen
 
 Each MQTT topic consist from `company_name` and `car_name`.
 
 BringAuto has the following MQTT topics
+
 - \<company_name>/\<vehicle_name>/module_gateway
 - \<company_name>/\<vehicle_name>/external_server
 
 where each variable can be changed by the .env file, variable names to be saved there are in parentheses.
+
 - `company_name` is by default set to "bringauto" (COMPANY)
 - `vehicle_name` is by default set to "virtual_vehicle" (VEHICLE_NAME)
 
-
 Actual MQTT topics to which developers can connect by default settings are:
+
 - bringauto/virtual_vehicle/module_gateway
 - bringauto/virtual_vehicle/external_server
 
-
 ## Logs
 
-Logs for each component can be found in the `docker_volumes` directory. 
-> The component directories are pre-created in the repository to avoid permission problems associated with docker volumes.
+Logs for each component can be found in the `docker_volumes` directory.
+> The component directories are pre-created in the repository to avoid permission problems associated with docker
+> volumes.
 
 In case of a problem please attach the `docker_volumes` directory to the Bug report.
 
@@ -105,25 +155,42 @@ In case of a problem please attach the `docker_volumes` directory to the Bug rep
 There are example scripts for sniffing communication and seeing the basics [scripts/]
 
 ## Bug solving
-If your mosquitto logs contain lines as below, make sure mosquitto.conf file uses LF line ending. (CRLF doesn't work)
+
+Docker container can have error similar to this: 
 ```
 Error: Invalid require_certificate value (false
 Error found at /mosquitto/config/mosquitto.conf:2.
 ```
+If this happens, make sure the mentioned file uses LF line ending. (CRLF doesn't work)
 
 [Fleet]: https://github.com/bringauto/fleet
+
 [Google Artifacts Registry]: https://console.cloud.google.com/artifacts/docker/bringauto-infrastructure/europe-west1/virtual-platform?hl=cs&project=bringauto-infrastructure
+
 [pregenerated certificate files]: configuration/mosquitto/certs
+
 [scripts/]: scripts/
+
 [Summary]: https://ref.bringautofleet.com/r/protocol/v2/2.0.1/summary
+
 [Fleet Protocol Requirements]: https://ref.bringautofleet.com/r/protocol/v2/2.0.1/protocol-requirements
+
 [Internal Client]: https://ref.bringautofleet.com/r/protocol/v2/2.0.1/internal-client
+
 [Module Gateway]: https://ref.bringautofleet.com/r/protocol/v2/2.0.1/module-gateway
+
 [External Server]: https://ref.bringautofleet.com/r/protocol/v2/2.0.1/external-server
+
 [Modules]: https://ref.bringautofleet.com/r/protocol/v2/2.0.1/modules
+
 [Message Structure]: https://ref.bringautofleet.com/r/protocol/v2/2.0.1/message-structure
-[Internal Client design]: https://ref.bringautofleet.com/r/protocol/v2/2.0.1/internal-client-design 
+
+[Internal Client design]: https://ref.bringautofleet.com/r/protocol/v2/2.0.1/internal-client-design
+
 [Module Gateway design]: https://ref.bringautofleet.com/r/protocol/v2/2.0.1/module-gateway-design
+
 [External Server design]: https://ref.bringautofleet.com/r/protocol/v2/2.0.1/external-server-design
+
 [HTTP API]: https://ref.bringautofleet.com/r/protocol/http-api/1.0.0/http-api
+
 [HTTP API Wait Mechanism]: https://ref.bringautofleet.com/r/protocol/http-api/1.0.0/wait-mechanism

configuration/external-server/config.json

@@ -3,7 +3,7 @@
   "car_name": "virtual_vehicle",
   "mqtt_address": "172.17.0.1",
   "mqtt_port": 1883,
-  "mqtt_timeout": 60,
+  "mqtt_timeout": 20,
   "timeout": 60,
   "send_invalid_command": false,
   "sleep_duration_after_connection_refused": 0.5,
@@ -15,7 +15,7 @@
       "lib_path": "/home/bringauto/modules/mission_module/lib/libmission-external-server-shared.so",
       "config": {
           "api_url": "http://http-api:8080/v2/protocol",
-          "api_key": "StaticAccessKeyToBeUsedByDevelopersOnEtna",
+          "api_key": "ProtocolStaticAccessKey",
           "max_requests_threshold_count": "5",
           "max_requests_threshold_period_ms": "1000",
           "delay_after_threshold_reached_ms": "500",
@@ -26,7 +26,7 @@
       "lib_path": "/home/bringauto/modules/io_module/lib/libio-external-server-shared.so",
       "config": {
         "api_url": "http://http-api:8080/v2/protocol",
-        "api_key": "StaticAccessKeyToBeUsedByDevelopersOnEtna",
+        "api_key": "ProtocolStaticAccessKey",
         "max_requests_threshold_count": "5",
         "max_requests_threshold_period_ms": "1000",
         "delay_after_threshold_reached_ms": "500",

configuration/http-api/config.json

@@ -5,7 +5,7 @@
             "port": 5432,
             "username": "postgres",
             "password": "1234",
-            "database_name": "postgres"
+            "database_name": "protocol_api"
         },
         "cleanup": {
             "timing_in_seconds": {
@@ -26,7 +26,6 @@
         "client_id": "",
         "client_secret_key": "",
         "scope": "",
-        "realm": "",
-        "keycloak_public_key_file": "config/keycloak.pem"
+        "realm": ""
     }
 }

configuration/integration-layer/config.json

@@ -0,0 +1,16 @@
+{
+    "protocol": {
+        "host": "http://http-api:8080/v2/protocol",
+        "api_key": "ProtocolStaticAccessKey",
+        "autonomy_device_id":
+        {
+            "module_id": 1,
+            "type": 1,
+            "role": "autonomy"
+        }
+    },
+    "management": {
+        "host": "http://management-api:8081/v2/management",
+        "api_key": "ManagementStaticAccessKey"
+    }
+}

configuration/integration-layer/logging.json

@@ -0,0 +1,89 @@
+{
+  "version": 1,
+  "disable_existing_loggers": false,
+  "formatters": {
+    "simple": {
+      "format": "[%(asctime)s.%(msecs)03d] [integration-layer] [%(levelname)s]\t %(message)s",
+      "datefmt": "%Y-%m-%d %H:%M:%S"
+    }
+  },
+  "handlers": {
+    "console": {
+      "class": "logging.StreamHandler",
+      "level": "DEBUG",
+      "formatter": "simple",
+      "stream": "ext://sys.stdout"
+    },
+    "file": {
+      "class": "logging.handlers.RotatingFileHandler",
+      "level": "DEBUG",
+      "formatter": "simple",
+      "filename": "/usr/src/app/log/fleet-management-integration-layer.log"
+    }
+  },
+  "loggers": {
+    "fleetman_integration.protocol.checker": {
+      "level": "DEBUG",
+      "handlers": [
+        "console",
+        "file"
+      ],
+      "propagate": false
+    },
+    "fleetman_integration.layer": {
+      "level": "DEBUG",
+      "handlers": [
+        "console",
+        "file"
+      ],
+      "propagate": false
+    },
+    "fleetman_integration.protocol.handler": {
+      "level": "DEBUG",
+      "handlers": [
+        "console",
+        "file"
+      ],
+      "propagate": false
+    },
+    "fleetman_integration.protocol.api_adapter": {
+      "level": "DEBUG",
+      "handlers": [
+        "console",
+        "file"
+      ],
+      "propagate": false
+    },
+    "fleetman_integration.management.checker": {
+      "level": "DEBUG",
+      "handlers": [
+        "console",
+        "file"
+      ],
+      "propagate": false
+    },
+    "fleetman_integration.management.handler": {
+      "level": "DEBUG",
+      "handlers": [
+        "console",
+        "file"
+      ],
+      "propagate": false
+    },
+    "fleetman_integration.management.api_adapter": {
+      "level": "DEBUG",
+      "handlers": [
+        "console",
+        "file"
+      ],
+      "propagate": false
+    }
+  },
+  "root": {
+    "level": "DEBUG",
+    "handlers": [
+      "console",
+      "file"
+    ]
+  }
+}