DRAFT 1.1 Migration Guide

Schema names

v1.1 has renamed the database schemas. If you have queries relying on the following schemas, please rename them as follows:

• augur_data -> data
• augur_operations -> operations

These schemas are considered internal to CollectOSS and may be subject to breaking changes. In a future version, we will be introducing a stable schema that will be tested and will become part of our public API commitment.

Environment Variables

Docker Entrypoints

Optional: Database rename

This part concerns renaming your database. This is a breaking change for anything that is connected to your database and is completely optional. It is recommended, but not required to perform this step after you have already migrated to collectoss 1.1.

To rename your database:

1. stop collection (using a command like docker stop collectoss-redis-1 collectoss-core-1 collectoss-rabbitmq-1 collectoss-flower-1 collectoss-keyman-1 collectoss-core-1 if your docker compose file was started from a folder called "collectoss")
2. ensure that all connections to the database are disconnected (you may need to create a new database just to connect and issue the following command)
3. run ALTER DATABASE augur RENAME TO collectoss; (or choose your own new name instead of CollectOSS)
4. ensure that the new database name is being supplied to environment variables for collectoss containers (specifically: database, core, and flower)
5. Ensure other downstream applications that connect to your database are updated too, including: the collectoss-monitoring stack (if in use), as well as 8Knot or any other downstream tools connecting to your database for analysis work.