Merge pull request #27 from usdot-jpo-ode/release/2024-q3

Merge Release/2024 q3 into master
usdot-jpo-ode · Oct 1, 2024 · 5872195 · 5872195
2 parents 5901c15 + 6c101ec
commit 5872195
Show file tree

Hide file tree

Showing 592 changed files with 36,953 additions and 14,055 deletions.
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -6,15 +6,31 @@
   "configurations": [
     {
       "command": "npm start",
-      "name": "Launch web app",
+      "name": "Launch web app with Intersection Data",
+      "request": "launch",
+      "cwd": "${workspaceFolder}/webapp",
+      "type": "node-terminal",
+      "preLaunchTask": "run-intersection"
+    },
+    {
+      "command": "npm start",
+      "name": "Launch web app without Intersection Data",
       "request": "launch",
       "cwd": "${workspaceFolder}/webapp",
       "type": "node-terminal",
       "preLaunchTask": "run-keycloak-and-postgres"
     },
+    {
+      "command": "npm start",
+      "name": "Launch web app with Full ConflictMonitor",
+      "request": "launch",
+      "cwd": "${workspaceFolder}/webapp",
+      "type": "node-terminal",
+      "preLaunchTask": "run-full-conflictmonitor"
+    },
     {
       "name": "Python: Flask",
-      "type": "python",
+      "type": "debugpy",
       "request": "launch",
       "stopOnEntry": false,
       "program": "${workspaceRoot}/services/api/src/main.py",
@@ -29,7 +45,7 @@
   "compounds": [
     {
       "name": "Debug Solution",
-      "configurations": ["Python: Flask", "Launch web app"]
+      "configurations": ["Python: Flask", "Launch web app with Intersection Data"]
     }
   ]
 }
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -22,5 +22,40 @@
   "[python]": {
     "editor.defaultFormatter": "ms-python.black-formatter",
     "editor.formatOnSave": true
-  }
+  },
+  "cSpell.words": [
+    "BOOTSTRAPSERVERS",
+    "cdot",
+    "cimms",
+    "collstats",
+    "conflictmonitor",
+    "conflictvisualizer",
+    "cviz",
+    "cvmanager",
+    "CVPEP",
+    "formik",
+    "geojsonconverter",
+    "healthcheck",
+    "inet",
+    "INITDB",
+    "inprog",
+    "keyfile",
+    "LOGLEVEL",
+    "MESSAGETYPE",
+    "millis",
+    "mongosh",
+    "pgdb",
+    "postgis",
+    "pytz",
+    "reduxjs",
+    "rsus",
+    "SASL",
+    "SNMP",
+    "svcs",
+    "TABLENAME",
+    "usdotjpoode",
+    "utctimestamp",
+    "wydot",
+    "Zabbix"
+  ]
 }
diff --git a/.vscode/tasks.json b/.vscode/tasks.json
@@ -14,6 +14,27 @@
       },
       "command": "${command:python.interpreterPath} -m pytest -v --cov-report xml:cov.xml --cov ."
     },
+    {
+      "label": "run-intersection",
+      "type": "docker-compose",
+      "dockerCompose": {
+        "up": {
+          "detached": true,
+          "build": true,
+          "services": [
+            "cvmanager_postgres",
+            "cvmanager_keycloak",
+            "kafka",
+            "kafka_init",
+            "conflictvisualizer_api",
+            "mongodb_container"
+          ]
+        },
+        "files": ["${workspaceFolder}/docker-compose.yml"],
+        "envFile": "${workspaceFolder}/.env"
+      },
+      "dependsOn": ["run-keycloak-and-postgres"]
+    },
     {
       "label": "run-keycloak-and-postgres",
       "type": "docker-compose",
@@ -26,6 +47,32 @@
         "files": ["${workspaceFolder}/docker-compose.yml"],
         "envFile": "${workspaceFolder}/.env"
       }
+    },
+    {
+      "label": "run-full-conflictmonitor",
+      "type": "docker-compose",
+      "dockerCompose": {
+        "up": {
+          "detached": true,
+          "build": true,
+          "services": [
+            "cvmanager_postgres",
+            "cvmanager_keycloak",
+            "kafka",
+            "kafka_init",
+            "ode",
+            "geojsonconverter",
+            "conflictmonitor",
+            "deduplicator",
+            "conflictvisualizer_api",
+            "mongodb_container",
+            "connect"
+          ]
+        },
+        "files": ["${workspaceFolder}/docker-compose-full-cm.yml"],
+        "envFile": "${workspaceFolder}/.env"
+      },
+      "dependsOn": ["run-keycloak-and-postgres"]
     }
   ]
 }
diff --git a/README.md b/README.md
@@ -48,13 +48,110 @@ The JPO CV Manager was originally developed for the Google Cloud Platform and a
 - Keycloak is used for the CV Manager webapp's authentication.
 - The Keycloak pod requires a `realm.json` file in the folder: `./resources/keycloak/` to startup with the proper configurations. It also requires a login theme that can be modified and generated using the [keycloakify](https://github.com/keycloakify/keycloakify) forked repository in resources/keycloak/keycloakify. The theme will be automatically generated when using the docker image provided but can also be built using instructions found in the keycloakify folder.
 
+### Intersection Data + ConflictMonitor Integration
+
+The CVManager now has the ability to manage, configure, and display data from connected intersections. Using the JPO-ODE ConflictMonitor and other JPO-ODE resources, intersection-specific data can be collected, processed, and analyzed. The CVManager has the ability to display the results of this analysis, show live message data, and configure intersection monitoring. This includes the following:
+
+- Displaying live MAPs, SPATs, and BSMs on a Mapbox map
+- Displaying archived MAPs, SPATs, and BSMs on a Mapbox map
+- Querying, downloading, and displaying events created by the ConflictMonitor
+- Querying, downloading, and displaying assessments of events created by the ConflictMonitor
+- Querying, managing, and displaying notifications created by the ConflictMonitor
+- Updating and managing configuration parameters controlling message analysis, assessments, and notifications
+
+More information on the ConflictMonitor and other services described above can be found here:
+
+- [jpo-conflictmonitor](https://github.com/usdot-jpo-ode/jpo-conflictmonitor)
+- [jpo-geojsonconverter](https://github.com/usdot-jpo-ode/jpo-geojsonconverter)
+- [jpo-ode](https://github.com/usdot-jpo-ode/jpo-ode)
+- [jpo-conflictvisualizer](https://github.com/usdot-jpo-ode/jpo-conflictvisualizer)
+
+**Ongoing Efforts**
+This feature is under active development. This is a joint effort involving combining the features of the existing CIMMS conflictvisualizer tools with the CVManager components, to enable connected vehicle and intersection analysis in one application.
+
+#### Local Development
+
+Ease of local development has been a major consideration in the integration of intersection data into the CVManager application. Through the use of public docker images and sample datasets, this process is relatively simple. The services required to show intersection data on the CVManager webapp are:
+
+- [jpo-conflictvisualizer (api)](https://github.com/usdot-jpo-ode/jpo-conflictvisualizer/tree/cvmgr-cimms-integration/api)
+  - Modified jpo-conflictvisualizer api which is able to utilize the cvmanager keycloak realm
+- kafka
+  - Base kafka image used to supply required topics to the conflictvisualizer api
+- kafka_init
+  - Kafka topic creation image, to create required topics for the conflictvisualizer api
+- MongoDB
+  - Base MongoDB image, with sample data, used to supply data to the conflictvisualizer api
+
+**Running a Simple Local Environment**
+
+1. Update your .env from the sample.env, all intersection-specific service variables are at the bottom.
+2. Build the docker-compose:
+
+```sh
+docker compose up -d
+```
+
+If any issues occur, try:
+
+```sh
+docker compose up --build -d
+```
+
+This command will create all of the CVManager containers as well a the intersection-specific containers. Now, intersection-specific data will be available through the CVManager webapp.
+
+**Running the CVManager without Intersection Services**
+
+1. Update your .env from the sample_no_cm.env (It is not necessary to clear out the intersection-specific variables)
+2. Build the docker-compose-no-cm:
+   If you would like to run all of the ConflictMonitor services including the JPO-ODE and GeoJSONConverter, use the docker-compose-full-cm.yml:
+
+```sh
+docker compose -f docker-compose-no-cm.yml up --build -d
+```
+
+**Running all ConflictMonitor Services**
+
+1. Update your .env from the sample.env, all intersection-specific service variables are at the bottom. No additional variables are currently required on top of the simple intersection configuration.
+2. Build the combined docker-compose:
+
+```sh
+docker compose -f docker-compose-full-cm.yml up --build -d
+```
+
+**ConflictMonitor Configuration Scripts**
+
+A set of scripts and data dumps exists in the [conflictmonitor folder](./conflictmonitor), see the readme in that location for more information.
+
+#### ConflictVisualizer API
+
+- The CV Manager webapp has been integrated with the ConflictVisualizer tool to allow users to view data directly from a jpo-conflictmonitor instance. This integration currently requires an additional jpo-conflictvisualizer api to be deployed alongside the jpo-cvmanager api. This allows the webapp to make authenticated requests to the jpo-conflictvisualizer api to retrieve the conflict monitor data.
+- [jpo-conflictvisualizer (api)](https://github.com/usdot-jpo-ode/jpo-conflictvisualizer/tree/cvmgr-cimms-integration/api)
+- kafka
+- kafka_init (to create required kafka topics)
+- MongoDB (to hold message and configuration data)
+
+The ConflictVisualizer api pulls archived message and configuration data from MongoDB, and is able to live-stream SPATs, MAPs, and BSMs from specific kafka topics
+
+#### MongoDB
+
+MongoDB is the backing database of the ConflictVisualizer api. This database holds configuration parameters, archived data (SPATs, MAPs, BSMs, ...), and processed data (notifications, assessments, events). For local development, a mongodump has been created in the conflictmonitor/mongo/dump_2024_08_20 directory. This includes notifications, assessments, events, as well as SPATs, MAPs, and BSMs. All of this data is available through the conflictvisualizer api.
+
+#### Kafka
+
+Kafka is used by the ConflictVisualizer api to receive data from the ODE, GeoJSONConverter, and ConflictMonitor. These connections enable live data to
+
+#### Generating Sample Data
+
+Some simple sample data is injected into the MongoDB instance when created. If more data is useful, the test-message-sender from the jpo-conflictmonitor can also be used to generate live sample data. This component should be cloned/installed separately, and is described here: [jpo-conflictmonitor/test-message-sender](https://github.com/usdot-jpo-ode/jpo-conflictmonitor/tree/develop/test-message-sender)
+
 ## Getting Started
 
 The following steps are intended to help get a new user up and running the JPO CV Manager in their own environment.
 
 1.  Follow the Requirements and Limitations section and make sure all requirements are met.
 2.  Create a copy of the sample.env named ".env" and refer to the Environmental variables section below for more information on each variable.
     1.  Make sure at least the DOCKER_HOST_IP, KEYCLOAK_ADMIN_PASSWORD, KEYCLOAK_API_CLIENT_SECRET_KEY, and MAPBOX_TOKEN are set for this.
+    2.  Some of these variables, delineated by sections, pertain to the [jpo-conflictvisualizer (api)](https://github.com/usdot-jpo-ode/jpo-conflictvisualizer/tree/cvmgr-cimms-integration/api), [jpo-conflictmonitor](https://github.com/usdot-jpo-ode/jpo-conflictmonitor), [jpo-geojsonconverter](https://github.com/usdot-jpo-ode/jpo-geojsonconverter), [jpo-ode](https://github.com/usdot-jpo-ode/jpo-ode). Please see the documentation provided for these projects when setting these variables.
 3.  The CV Manager has four components that need to be containerized and deployed: the API, the PostgreSQL database, Keycloak, and the webapp.
 
     - If you are looking to deploy the CV Manager locally, you can simply run the docker-compose, make sure to fill out the .env file to ensure it launches properly. Also, edit your host file ([How to edit the host file](<[resources/kubernetes](https://docs.rackspace.com/support/how-to/modify-your-hosts-file/)>)) and add IP address of your docker host to these custom domains (remove the carrot brackets and just put the IP address):
@@ -66,7 +163,15 @@ The following steps are intended to help get a new user up and running the JPO C
 
 4.  Apply the docker compose to start the required components:
 
-         docker compose up -d
+    ```sh
+    docker compose up -d
+    ```
+
+    If any issues occur, try:
+
+    ```sh
+    docker compose up --build -d
+    ```
 
 5.  Access the website by going to:
 
@@ -144,7 +249,15 @@ For the "Debug Solution" to run properly on Windows 10/11 using WSL, the followi
 
 3.  Apply the docker compose to start the required components:
 
-         docker compose up -d
+```sh
+docker compose up -d
+```
+
+To run only the critical cvmanager components (no conflictmonitor/conflictvisualizer), use this command:
+
+```sh
+docker compose up -d cvmanager_api cvmanager_webapp cvmanager_postgres cvmanager_keycloak
+```
 
 4.  Access the website by going to:
 
@@ -189,13 +302,15 @@ For the "Debug Solution" to run properly on Windows 10/11 using WSL, the followi
 - SSM_DB_NAME: The database name for SSM visualization data.
 - SRM_DB_NAME: The database name for SRM visualization data.
 - FIRMWARE_MANAGER_ENDPOINT: Endpoint for the firmware manager deployment's API.
-- CSM_EMAIL_TO_SEND_FROM: Origin email address for the API.
+- CSM_EMAIL_TO_SEND_FROM: Origin email address for the API error developer emails.
+- CSM_EMAILS_TO_SEND_TO: Destination email addresses for the API error developer emails.
 - CSM_EMAIL_APP_USERNAME: Username for the SMTP server.
 - CSM_EMAIL_APP_PASSWORD: Password for the SMTP server.
-- CSM_EMAILS_TO_SEND_TO: Destination email list.
 - CSM_TARGET_SMTP_SERVER_ADDRESS: Destination SMTP server address.
 - CSM_TARGET_SMTP_SERVER_PORT: Destination SMTP server port.
 - API_LOGGING_LEVEL: The level of which the CV Manager API will log. (DEBUG, INFO, WARNING, ERROR)
+- CSM_TLS_ENABLED: Set to "true" if the SMTP server requires TLS.
+- CSM_AUTH_ENABLED: Set to "true" if the SMTP server requires authentication.
 - WZDX_ENDPOINT: WZDX datafeed endpoint.
 - WZDX_API_KEY: API key for the WZDX datafeed.
 - TIMEZONE: Timezone to be used for the API.
@@ -210,8 +325,30 @@ For the "Debug Solution" to run properly on Windows 10/11 using WSL, the followi
 
 <b>MongoDB Variables</b>
 
+#### For Windows Users Only
+
+If running on Windows, please make sure that your global git config is set up to not convert end-of-line characters during checkout.
+
+Disable `git core.autocrlf` (One Time Only)
+
+```bash
+git config --global core.autocrlf false
+```
+
 - MONGO_DB_URI: URI for the MongoDB connections.
 - MONGO_DB_NAME: Database name for RSU counts.
+- MONGO_ADMIN_DB_USER: Admin Username for MongoDB
+- MONGO_ADMIN_DB_PASS: Admin Password for MongoDB
+- MONGO_CV_MANAGER_DB_USER: CV Manager Username for MongoDB
+- MONGO_CV_MANAGER_DB_PASS: CV Manager Password for MongoDB
+
+- MONGO_IP: IP Address of the MongoDB (Defaults to $DOCKER_HOST_IP)
+- MONGO_DB_USER: Username of the account used to connect to MongoDB
+- MONGO_DB_PASS: Password of the account used to connect to MongoDB
+- MONGO_PORT: Port number of MongoDB (default is 27017)
+- MONGO_COLLECTION_TTL: Number of days documents will be kept in a MongoDB collection
+
+- INSERT_SAMPLE_DATA: If true, sample data will be inserted in the CVCounts, V2XGeoJson, and OdeSsmJson collections
 
 <b>Keycloak Variables</b>
 

diff --git a/conflictmonitor/README.md b/conflictmonitor/README.md
@@ -0,0 +1,11 @@
+# JPO-Conflictmonitor Components
+
+This directory contains configuration files for the jpo-conflictmonitor, referenced in the docker-compose.yml. These files configure the kafka init container as well as the mongodb container.
+
+## kafka
+
+This directory contains kafka scripts, used for initializing the relevant kafka topics required for ConflictMonitor components. This script came from the JPO-ConflictMonitor repository, and has been modified to create additional topics required by the conflictvisualizer api.
+
+## mongo
+
+This directory contains scripts from the ConflictMonitor for initializing collections and indexes, as well as a mongodump dataset used for the visualizer. These files are referenced in the docker-compose.yml, and should not need to be modified for local development.