Merge remote-tracking branch 'origin' into fix-MAP

.github/workflows/sonar-scanner.yml

@@ -3,6 +3,7 @@ on:
     branches:
       - develop
       - master
+      - "release/*"
   pull_request:
     types: [opened, synchronize, reopened]
 name: Sonar Workflow
@@ -13,6 +14,9 @@ jobs:
       image: ubuntu:jammy-20230126
     steps:
       - name: Install curl, zip, git, gcovr
+        # Installing gcovr for unit test code coverage
+        # Installing git for checkout action
+        # installing curl/zip for sonar-cpp action
         run: |
           apt update
           export DEBIAN_FRONTEND=noninteractive

README.md

@@ -43,18 +43,9 @@ V2X Hub is a communication, computation, and processing platform for V2I applica
 	* Aggregation of vehicle weather data for efficient communication to Transportation Management Entity for weather-responsive traffic management.
 	* Multi-Modal Intelligent Traffic Signal Systems (MMITSS) “intersection level” functions including J2735 Intersection Geometry (MAP) and J2735 Signal Phase and Timing (SPaT) broadcast manager, equipped vehicle tracker, priority request server, and interface to traffic signal controller.
 
-# Simulation Setup
-To support execution in a simulated environment, V2X-Hub is in the process of integrating with CDASim, a Co-Simulation tool built as an extension of Eclipse Mosiac. This extension will incorporate integration with several other platforms including CARMA-Platform and CARLA. The setup for this simply requires setting environment variables inside the V2X-Hub docker container.
- * **SIMULATION_MODE** – Environment variable for enabling simulation components for V2X-Hub. If set to "true" or "TRUE" simulation components will be enable. Otherwise, simulation components will not be enabled.
- * **KAFKA_BROKER_ADDRESS** – Environment variable for storing Kafka broker connection string (including port).
- * **TIME_SYNC_TOPIC** – Environment variable for storing Kafka time sync topic.
- * **SIMULATION_IP** – Environment variable for storing IP address of CDASim application.
- * **SIMULATION_REGISTRATION_PORT** – Environment variable for storing port on CDASim that handles registration attempts.
- * **TIME_SYNC_PORT** – Environment varaible for storing port for receiving time sync messages from CDASim.
- * **V2X_PORT** – Environment variable for storing port for receiving v2x messages from CDASim
- * **SIM_V2X_PORT** – Environment variable for storing port for sending v2x messages to CDASim
- * **LOCAL_IP** – Environment variable for storing local IP of V2X Hub.
- * **INFRASTRUCTURE_ID** – Environment variable for storing infrastructure id of V2X Hub..
+## Deployment Configuration
+The instructions for deployment and configuration are located here: [Instructions](<configuration/README.md>)
+
 ## Release Notes
 The current version and release history of the V2X Hub software platform can be found here: [Release Notes](<docs/Release_notes.md>)
 

configuration/README.md

@@ -0,0 +1,57 @@
+## Introduction
+This directory contains deployment and configuration instructions for deploying V2X-Hub on both ARM64(arm64) and x86(amd64) architectures.
+
+> [!NOTE]
+> Separate deployment files/configurations are no longer necessary for arm64 and x86 deployments.
+
+### Deployment Instructions
+Once downloaded, navigate to the configuration directory:
+```
+cd ~/V2X-Hub/configuration/
+```
+Run the initialization script:
+```
+sudo ./initialization.sh
+```
+Follow the prompts during installation.
+
+You will be prompted to create a mysql_password and mysql_root_password. You may make the passwords whatever you like, but you will need to remember them.
+```
+Example: ivp
+```
+You will also be prompted to create a V2X Hub username and password. You may make these whatever you’d like, but will need to use them to log into the web UI. Example:
+```
+Username: v2xadmin
+
+Password: V2xHub#321
+```
+You will then need to enter the mysql_password you created in step 5a:
+```
+Example: ivp
+```
+After installation is complete, the script will automatically open a web browser with two tabs.
+
+Navigate to the tab labeled as “Privacy Error” and select the “Advanced” button.
+
+Click on “proceed to 127.0.0.1 (unsafe)”
+
+Note: This page will not do anything when clicking proceed
+
+Close the Privacy Error tab and wait for the initial V2X Hub tab to finish loading
+
+Enter the login credentials you created in step 5b and login.
+
+Installation complete!
+
+### Simulation Setup
+To support execution in a simulated environment, V2X-Hub is in the process of integrating with CDASim, a Co-Simulation tool built as an extension of Eclipse Mosiac. This extension will incorporate integration with several other platforms including CARMA-Platform and CARLA. The setup for this simply requires setting environment variables inside the V2X-Hub docker container.
+ * **SIMULATION_MODE** – Environment variable for enabling simulation components for V2X-Hub. If set to "true" or "TRUE" simulation components will be enable. Otherwise, simulation components will not be enabled.
+ * **KAFKA_BROKER_ADDRESS** – Environment variable for storing Kafka broker connection string (including port).
+ * **TIME_SYNC_TOPIC** – Environment variable for storing Kafka time sync topic.
+ * **SIMULATION_IP** – Environment variable for storing IP address of CDASim application.
+ * **SIMULATION_REGISTRATION_PORT** – Environment variable for storing port on CDASim that handles registration attempts.
+ * **TIME_SYNC_PORT** – Environment varaible for storing port for receiving time sync messages from CDASim.
+ * **V2X_PORT** – Environment variable for storing port for receiving v2x messages from CDASim
+ * **SIM_V2X_PORT** – Environment variable for storing port for sending v2x messages to CDASim
+ * **LOCAL_IP** – Environment variable for storing local IP of V2X Hub.
+ * **INFRASTRUCTURE_ID** – Environment variable for storing infrastructure id of V2X Hub..