Migrating from SDW websocket depositor to SDW Depositor Submodule

Overview

The new Situation Data Warehouse supports depositing messages over a REST interface, instead of using Websockets.

The ODE team has created a new SDW Depositor module for this service that can be used as a standalone depositor or as an ODE submodule. This document is meant to guide users who currently use the Websocket interface and want to migrate to the new REST interface and SDW Depositor module.

Instructions

Note that pulling the latest updates will require migrating to the new .env file setup:

1. Make a backup of your existing environment file .env and then delete it
2. Remove any local changes you have made to sample.env, if any (git checkout -- sample.env)
3. Pull the latest release of the ODE (instructions)
4. Rename sample.env to .env
5. Copy the values from your backup env file to the new .env file
6. Choose whether to use the built-in WebSocket depositor or the new SDW Depositor service
   • If using the SDW Service set the following variables in your .env
     • SDW_USERNAME
     • SDW_PASSWORD
     • If needed, override the default SDW configuration with these values:
       • SDW_DESTINATION_URL
       • SDW_GROUP_ID
       • SDW_KAFKA_PORT
       • SDW_SUBSCRIPTION_TOPIC
   • If using the built-in WebSocket depositor
     • Set ODE_DEPOSIT_SDW_MESSAGES_OVER_WEBSOCKET=true
     • Remove or comment out the jpo-sdw-depositor from your docker-compose.yml
     • Transfer the old ODE_DDS_* environment variables from the old .env into the new .env
7. Build and deploy as usual