(Advanced) Downloading the source code from a non-default branch

The above steps to pull the code from GitHub repository pulls it from the default branch which is the stable branch. If you wish to pull the source code from a branch that is still under development or beta testing, you will need to specify the branch to pull from. The following commands aid you in that action. **Note**: These commands can also be performed using the provided script `update_branch`. ```bash # Backup user provided source or configuration files used by submodules cp asn1_codec/asn1c_combined/J2735_201603DA.ASN . # Run the following commands to reset existing branch git reset --hard git submodule foreach --recursive git reset --hard # Pull from the non-default branch git checkout git pull origin # The next command wipes out all of the submodules and re-initializes them. git submodule deinit -f . && git submodule update --recursive --init # Restore user provided source or configuration files used by submodules cp ./J2735_201603DA.ASN asn1_codec/asn1c_combined/ ```

#### Step 2 - Build and run the application **Notes:** - Docker builds may fail if you are on a corporate network due to DNS resolution errors. [See here](https://github.com/usdot-jpo-ode/jpo-ode/wiki/Docker-fix-for-SSL-issues-due-to-corporate-network) for instructions to fix this. - In order for Docker to automatically read the environment variable file, you must rename it from `sample.env` to `.env`. **This file will contain private keys, do not put add it to version control.** Copy the following files from `jpo-ode` directory into your DOCKER_SHARED_VOLUME directory. - Copy jpo-ode/ppm.properties to ${DOCKER_SHARED_VOLUME}/config.properties. Open the newly copied `config.properties` file in a text editor and update the `metadata.broker.list=your.docker.host.ip:9092` line with your system's DOCKER_HOST_IP in place of the dummy `your.docker.host.ip` string. - Copy jpo-ode/adm.properties to ${DOCKER_SHARED_VOLUME}/adm.properties - Copy jpo-ode/aem.properties to ${DOCKER_SHARED_VOLUME}/aem.properties Navigate to the root directory of the jpo-ode project and run the following command: ```bash docker-compose up --build -d docker-compose ps ``` To bring down the services and remove the running containers run the following command: ```bash docker-compose down ``` For a fresh restart, run: ```bash docker-compose down docker-compose up --build -d docker-compose ps ``` To completely rebuild from scratch, run: ```bash docker-compose down docker-compose rm -fvs docker-compose up --build -d docker-compose ps ``` Check the deployment by running `docker-compose ps`. You can start and stop containers using `docker-compose start` and `docker-compose stop` commands. If using the multi-broker docker-compose file, you can change the scaling by running `docker-compose scale =n` where container is the container you would like to scale and n is the number of instances. For example, `docker-compose scale kafka=3`. #### asn1_codec Module (ASN.1 Encoder and Decoder) ODE requires the deployment of asn1_codec module. ODE's `docker-compose.yml` file is set up to build and deploy the module in a Docker container. If you wish to run `asn1_codec` module outside Docker (i.e. directly on the host machine), please refer to the documentation of `asn1_codec` module. The only requirement for deploying `asn1_codec` module on Docker is the setup of two environment variables `DOCKER_HOST_IP` and `DOCKER_SHARED_VOLUME`. #### PPM Module (Geofencing and Filtering) To run the ODE with PPM module, you must install and start the PPM service. PPM service communicates with other services through Kafka Topics. PPM will read from the specified "Raw BSM" topic and publish the result to the specified "Filtered Bsm" topic. These topic names are specified by the following ODE and PPM properties: - ODE properties for communications with PPM (set in application.properties) - ode.kafkaTopicOdeBsmJson (default = topic.OdeBsmJson) - ode.kafkaTopicFilteredOdeBsmJson (default = topic.FilteredOdeBsmJson) - PPM properties for communications with ODE (set in yourconfig.properties) - privacy.topic.consumer (default = j2735BsmRawJson) - privacy.topic.producer (default = j2735BsmFilteredJson) Follow the instructions [here](https://github.com/usdot-jpo-ode/jpo-cvdp/blob/master/docs/installation.md) to install and build the PPM service. During the build process, edit the sample config file located in `config/example.properties` and point the property `metadata.broker.list` towards the host of your docker machine or wherever the kafka brokers are hosted. You may use the command `docker-machine ls` to find the kafka service. After a successful build, use the following commands to configure and run the PPM ``` cd $BASE_PPM_DIR/jpo-cvdp/build $ ./bsmjson_privacy -c ../config/ppm.properties ``` [Back to top](#toc) ## 4. File Manifest This section outlines the software technology stacks of the ODE. ### Containerization and Management - [Docker](https://www.docker.com/) - [Docker-Compose](https://docs.docker.com/compose/) ### Messaging - [Kafka](https://kafka.apache.org/) ### Code Quality - [SonarCloud](https://sonarcloud.io) ### Continuous Integration - [TravisCI](https://travis-ci.org/) ### ODE Code - [Java 8](https://openjdk.java.net/) - [Maven](https://maven.apache.org/) - [Spring Boot](http://spring.io/projects/spring-boot) - [Logback](https://logback.qos.ch/) - [SNMP4J](https://www.snmp4j.org/) - [JUnit](https://junit.org) - [JMockit](http://jmockit.github.io/) - [Stomp Websocket](http://jmesnil.net/stomp-websocket) ### Web UI - [MaterializeCSS](https://materializecss.com) - [jQuery](https://jquery.com/) - [Stomp Websocket](http://jmesnil.net/stomp-websocket) - [SockJS](https://github.com/sockjs) [Back to top](#toc) ## 5. Development Setup ### Integrated Development Environment (IDE) Install the IDE of your choice: * Eclipse: [https://eclipse.org/](https://eclipse.org/) * STS: [https://spring.io/tools/sts/all](https://spring.io/tools/sts/all) * IntelliJ: [https://www.jetbrains.com/idea/](https://www.jetbrains.com/idea/) ### Continuous Integration * TravisCI: [Back to top](#toc) ## 6. Release History [Release Notes](ReleaseNotes.md) [Back to top](#toc) ## 7. Contact Information Contact the developers of the ODE application by submitting a [Github issue](https://github.com/usdot-jpo-ode/jpo-ode/issues). Contact the ODE management representative using the information in the [Code.gov Registration Info](#codegov-registration-info) section. ### License information Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either expressed or implied. See the License for the specific language governing permissions and limitations under the [License](http://www.apache.org/licenses/LICENSE-2.0). [Back to top](#toc) ## 8. Contributing Please read our [contributing guide](docs/contributing_guide.md) to learn about our development process, how to propose pull requests and improvements, and how to build and test your changes to this project. ### Source Repositories - GitHub - Main repository on GitHub (public) - - git@github.com:usdot-jpo-ode/jpo-ode.git - Data Privacy Module on Github (public) - - git@github.com/usdot-jpo-ode/jpo-cvdp - S3 Depositor Module on Github (public) - - gith@github.com/usdot-jpo-ode/jpo-s3-deposit - Security services repository on GitHub (public) - - git@github.com:usdot-jpo-ode/jpo-security-svcs.git ### Agile Project Management - Jira ### Wiki - Confluence ### Continuous Integration and Delivery

Using Travis for your build

To allow Travis run your build when you push your changes to your public fork of the jpo-ode repository, you must define the following secure environment variable using Travis CLI (). Run: ``` travis login --org ``` Enter personal github account credentials. In order to allow Sonar to run, personal key must be added with this command: (Key can be obtained from the JPO-ODE development team) ``` travis env set SONAR_SECURITY_TOKEN -pr / ```

### Static Code Analysis [Back to top](#toc) ## 9. Known Bugs Date: 07/2017 In its current state, the ODE has been developed to accomplish the goals of data transfer, security, and modularity working with the J2735 and 1609.2 security. The system has been designed to support multiple services orchestrated through the Apache Kafka streaming data pipelines, services built and supported as separate applications and described with each service's repository. As a modular system, each component has been built for functionality first, and additional performance testing is needed to understand the limits of the system with large volumes of data. ### Troubleshooting Please read our [Wiki](https://github.com/usdot-jpo-ode/jpo-ode/wiki) for more information, or check the [User Guide](docs/UserGuide.md). Application Support for the ODE currently managed via GitHub's native issue tracker: . [Back to top](#toc) ## 10. Credits and Acknowledgement [Attribution](ATTRIBUTION.md) [Back to top](#toc) ## 11. Code.gov Registration Info Agency: DOT Short Description: 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. Status: Beta Tags: transportation, connected vehicles, intelligent transportation systems, java Labor hours: 200 Contact Name: James Lieu Contact Phone: (202) 366-3000 [Back to top](#toc)