App Design Recommendations

Mon, 01 Jan 0001 00:00:00 +0000

This document is intended for developers who develop software and want to distribute it through the Quollix App Store. You are free to design your app in any way you like. However, following the recommendations ensures smooth integration with Quollix and improves the experience for administrators and end users.

Tip: Downloading a few official app definitions from the Quollix UI and inspecting their docker-compose.yml files can be useful. Some recommendations below are easier to understand when compared with working examples.

Service Migration

Mon, 01 Jan 0001 00:00:00 +0000

Quollix automatically runs selected service migrations during app updates from the App Store. For example, updating Postgres to a new major version no longer requires administrators to run the migration commands by hand. The same service migration mechanism is also used when an administrator directly uploads an app version to Quollix.

Current Support

Quollix currently handles these service migrations:

Service	Migration behavior
Postgres	On major version changes, Quollix exports a dump with `pg_dumpall` in the old container and imports it with `psql` in the new container.
Zulip Postgres	Zulip’s `zulip/zulip-postgresql` image follows the same Postgres migration flow.
RabbitMQ	On RabbitMQ image version changes, Quollix starts the old RabbitMQ container and runs `rabbitmqctl enable_feature_flag all` before the update continues.

RabbitMQ

For RabbitMQ, app definitions should keep the RabbitMQ node name stable across container recreations and upgrades, for example by setting RABBITMQ_NODENAME.

App Store on Quollix

App Design Recommendations

Service Migration

Current Support

RabbitMQ