Upgrading

This document describes the general steps to upgrade between major changes. Simple migrations, e.g. for adding schema changes, are not documented explicitly. Once we implement them, their usage will be described in the README.

v0.2 to v0.3 (MongoDB to PostgreSQL)

Shut down all services
Obviously, now is a good time to perform a full backup ;)
Update the codebase
Update docker-compose.yaml from the example. Leave the MongoDB service in place for now, but update all other service descriptions. You can remove redis already. Generate a better password than the default for your postgres user.
Start up the mongo and postgres services.
Build the new image (e.g. with docker-compose build portal)
Configure your API. The example config file is api/config.py.example, and it will need to be mounted to api/config.py in the container. Ignore the Keycloak options for now.

Prepare the database:

docker-compose run --rm portal python tools/reset_database.py
docker-compose run --rm portal python tools/prepare_sql_tiles.py

Import OSM data (see README)

Run the database migration script:

docker-compose run --rm \
    -v $PWD/export:/export \
    api \
    python tools/import_from_mongodb.py mongodb://mongo/obs \
    --keycloak-users-file /export/users.json

Shut down the mongo service, you can now remove it from docker-compose.yaml
Start keycloak and configure it, similarly to how it was configured in the development setup (but choose more secure options). Update the API config file to match your keycloak configuration. Import the file export/users.json into your realm, it will re-add all the users from the old installation. You should delete the file and export/ folder afterwards.
Start api, worker and frontend.

1.9 KiB Raw Blame History

Upgrading

v0.2 to v0.3 (MongoDB to PostgreSQL)

1.9 KiB

Raw Blame History