Skip to content

Commit

Permalink
VH 1295 - Support multi architecture docker deployment (#612)
Browse files Browse the repository at this point in the history
<!-- Thanks for the contribution, this is awesome. -->

# PR Details
## Description

In this PR
- Updated the MySQL to 8.0 to support multi-architecture.
- Removed architecture based configuration folders.
- Updated the initialization and MySQL scripts to support both
architectures.

<!--- Describe your changes in detail -->

## Related Issue

<!--- This project only accepts pull requests related to open issues -->
<!--- If suggesting a new feature or change, please discuss it in an
issue first -->
<!--- If fixing a bug, there should be an issue describing it with steps
to reproduce -->
<!--- Please link to the issue here: -->
[VH-1295](https://usdot-carma.atlassian.net/browse/VH-1295)
## Motivation and Context

<!--- Why is this change required? What problem does it solve? -->

## How Has This Been Tested?

<!--- Please describe in detail how you tested your changes. -->
<!--- Include details of your testing environment, and the tests you ran
to -->
<!--- see how your change affects other areas of the code, etc. -->
The updated initialization script has been tested manually on both kinds
of devices to validate the update.
## Types of changes

<!--- What types of changes does your code introduce? Put an `x` in all
the boxes that apply: -->

- [ ] Defect fix (non-breaking change that fixes an issue)
- [x] New feature (non-breaking change that adds functionality)
- [ ] Breaking change (fix or feature that cause existing functionality
to change)

## Checklist:

<!--- Go over all the following points, and put an `x` in all the boxes
that apply. -->
<!--- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->

- [ ] I have added any new packages to the sonar-scanner.properties file
- [x] My change requires a change to the documentation.
- [x] I have updated the documentation accordingly.
- [x] I have read the **CONTRIBUTING** document.
[V2XHUB Contributing
Guide](https://github.com/usdot-fhwa-OPS/V2X-Hub/blob/develop/Contributing.md)
- [ ] I have added tests to cover my changes.
- [x] All new and existing tests passed.
  • Loading branch information
DokurOmkar authored May 29, 2024
1 parent 326bac2 commit 610d77e
Show file tree
Hide file tree
Showing 19 changed files with 28 additions and 706 deletions.
15 changes: 3 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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>)

Expand Down
29 changes: 22 additions & 7 deletions configuration/README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
## Deployment Configuration
### Introduction
This directory contains deployment configurations for deploying V2X-Hub on both ARM64(arm64) and x86(amd64) architectures.
## 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 directory corresponding to your computer’s processor (1) or (2):
Once downloaded, navigate to the configuration directory:
```
cd ~/V2X-Hub/configuration/arm64/
cd ~/V2X-Hub/configuration/amd64/
cd ~/V2X-Hub/configuration/
```
Run the initialization script:
```
./initialization.sh
sudo ./initialization.sh
```
Follow the prompts during installation.

Expand Down Expand Up @@ -40,3 +42,16 @@ Close the Privacy Error tab and wait for the initial V2X Hub tab to finish loadi
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..
37 changes: 0 additions & 37 deletions configuration/amd64/mysql/add_v2xhub_user.bash

This file was deleted.

60 changes: 0 additions & 60 deletions configuration/arm64/docker-compose.yml

This file was deleted.

60 changes: 0 additions & 60 deletions configuration/arm64/initialization.sh

This file was deleted.

Loading

0 comments on commit 610d77e

Please sign in to comment.