Merge pull request #502 from usdot-jpo-ode/release/1.3.0

Merge release 1.3.0 into master

.devcontainer/Dockerfile

@@ -66,4 +66,12 @@ RUN chmod 775 /etc/init.d/kafka && update-rc.d kafka defaults
 
 COPY ./docker-entrypoint.sh ./docker-entrypoint.sh
 RUN chmod +x ./docker-entrypoint.sh
-ENTRYPOINT ["./docker-entrypoint.sh"]
+ENTRYPOINT ["./docker-entrypoint.sh"]
+
+# C++
+RUN apt-get update
+RUN apt-get install -y g++ cmake libsasl2-dev libsasl2-modules libssl-dev librdkafka-dev
+RUN apt install -y autoconf libtool
+
+ENV REDACTION_PROPERTIES_PATH /workspaces/jpo-ode/jpo-cvdp/config/fieldsToRedact.txt
+ENV RPM_DEBUG true

.devcontainer/devcontainer.json

@@ -1,7 +1,7 @@
 // For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
 // https://github.com/microsoft/vscode-dev-containers/tree/v0.154.0/containers/java-8
 {
-	"name": "Java 11",
+	"name": "Java 11 and C++",
 	"dockerFile": "Dockerfile",
 	"overrideCommand": false,
 	"shutdownAction": "stopContainer",
@@ -21,7 +21,9 @@
 		"mhutchie.git-graph",
 		"tabnine.tabnine-vscode",
 		"redhat.java",
-		"redhat.vscode-commons"
+		"redhat.vscode-commons",
+		"ms-vscode.cpptools",
+		"ms-vscode.cmake-tools"
 	],
 	// Use 'forwardPorts' to make a list of ports inside the container available locally.
 	// "forwardPorts": [8080, 9090, 46753, 46800, 5555, 6666, 8090, 2181, 9092],

.github/workflows/ci.yml

@@ -0,0 +1,30 @@
+name: ci
+
+on: [pull_request, push]
+
+jobs:
+  docker:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+      - name: Build
+        uses: docker/build-push-action@v3
+
+  sonar:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          submodules: recursive
+      - name: Set up JDK
+        uses: actions/setup-java@v3
+        with:
+          java-version: "11"
+          distribution: "temurin"
+      - name: Run Sonar
+        env:
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+        run: |
+          ls -la && pwd
+          mvn -e -X clean org.jacoco:jacoco-maven-plugin:prepare-agent package sonar:sonar -Dsonar.projectKey=usdot-jpo-ode_jpo-ode -Dsonar.projectName=jpo-ode -Dsonar.organization=usdot-jpo-ode-1 -Dsonar.host.url=https://sonarcloud.io -Dsonar.branch.name=$GITHUB_REF_NAM

.github/workflows/dockerhub.yml

@@ -0,0 +1,25 @@
+name: "DockerHub Build and Push"
+
+on:
+  push:
+    branches:
+      - "develop"
+
+jobs:
+  dockerhub-Jpo-ode:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+      - name: Login to DockerHub
+        uses: docker/login-action@v2
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+      - name: Build
+        uses: docker/build-push-action@v3
+        with:
+          push: true
+          tags: usdotjpoode/jpo-ode:${{ github.ref_name }}

.gitmodules

@@ -10,7 +10,7 @@
 	branch = master
 [submodule "jpo-security-svcs"]
 	path = jpo-security-svcs
-	url = https://github.com/usdot-jpo-ode/jpo-security-svcs
+	url = https://github.com/usdot-jpo-ode/jpo-security-svcs.git
 [submodule "jpo-sdw-depositor"]
 	path = jpo-sdw-depositor
 	url = https://github.com/usdot-jpo-ode/jpo-sdw-depositor.git

Dockerfile

@@ -16,7 +16,7 @@ COPY ./jpo-ode-svcs/src ./jpo-ode-svcs/src
 
 RUN mvn clean package -DskipTests
 
-FROM openjdk:11-jre-slim
+FROM eclipse-temurin:11-jre-alpine
 
 WORKDIR /home
 

README.md

@@ -4,7 +4,7 @@
 
 # jpo-ode
 
-**US Department of Transportation (USDOT) Intelligent Transportation Systems (ITS) Joint Program Office (JPO) Operational Data Environemnt (ODE)**
+**US Department of Transportation (USDOT) Intelligent Transportation Systems (ITS) Joint Program Office (JPO) Operational Data Environment (ODE)**
 
 The ITS ODE is a real-time virtual data router that ingests and processes operational data from various connected devices - including vehicles, infrastructure, and traffic management centers - and distributes it to other devices and subscribing transportation management applications. Using the ITS ODE within intelligent transportation deployments increases data fluidity and interoperability while meeting operational needs and protecting user privacy. The software’s microservices architecture makes it easy to add new capabilities to meet local needs. Check the ITS factsheet for more information: <https://www.its.dot.gov/factsheets/pdf/ITSJPO_ODE.pdf>.
 
@@ -26,6 +26,9 @@ All stakeholders are invited to provide input to these documents. To provide fee
 
 <a name="toc"/>
 
+## Release Notes
+The current version and release history of the JPO-ODE: [ODE Release Notes](<docs/Release_notes.md>)
+
 ## Table of Contents
 
 1.  [Usage Example](#usage-example)
@@ -279,9 +282,49 @@ cd $BASE_PPM_DIR/jpo-cvdp/build
 $ ./bsmjson_privacy -c ../config/ppm.properties
 ```
 
+# Confluent Cloud Integration
 
-[Back to top](#toc)
+Rather than using a local kafka instance, the ODE can utilize an instance of kafka hosted by Confluent Cloud via SASL.
+
+
+
+## Environment variables
+
+### Purpose & Usage
+
+- The DOCKER_HOST_IP environment variable is used to communicate with the bootstrap server that the instance of Kafka is running on.
+
+- The KAFKA_TYPE environment variable specifies what type of kafka connection will be attempted and is used to check if Confluent should be utilized. If this environment variable is not set, the ODE will default to normal behavior.
+
+- The CONFLUENT_KEY and CONFLUENT_SECRET environment variables are used to authenticate with the bootstrap server. If the KAFKA_TYPE environment variable is not set, then these are not required.
+
+
+
+### Values
+In order to utilize Confluent Cloud:
+
+- DOCKER_HOST_IP must be set to the bootstrap server address (excluding the port)
 
+- KAFKA_TYPE must be set to "CONFLUENT"
+
+- CONFLUENT_KEY must be set to the API key being utilized for CC
+
+- CONFLUENT_SECRET must be set to the API secret being utilized for CC
+
+
+
+## CC Docker Compose File
+
+There is a provided docker-compose file (docker-compose-confluent-cloud.yml) that passes the above environment variables into the container that gets created. Further, this file doesn't spin up a local kafka instance since it is not required.
+
+
+
+## Note
+
+This has only been tested with Confluent Cloud but technically all SASL authenticated Kafka brokers can be reached using this method.	
+
+[Back to top](#toc)
+
 <!--
 #########################################
 ############# File Manifest #############
@@ -353,6 +396,9 @@ Install the IDE of your choice:
 
 * TravisCI: <https://travis-ci.org/usdot-jpo-ode/jpo-ode>
 
+### Dev Container Environment
+The project can be reopened inside of a dev container in VSCode. This environment should have all of the necessary dependencies to debug the ODE and its submodules. When attempting to run scripts in this environment, it may be necessary to make them executable with "chmod +x" first.
+
 [Back to top](#toc)
 
 <!--