Skip to content

Upgrade to 1.1

Upgrading from platform version 1.0.x to 1.1.0 is a drop-in update. No action is required: your .env keeps working unchanged.

Coming from before 1.0.0?

1.0.0 renamed WEB_GATEWAY_VERSION to RAG_WEB_VERSION, but from 1.1.0 on, neither variable is used anyway. Instead image versions are pinned in the deployment files.

Docker Compose

  1. Update your copy of rag-docker to the 1.1.0 tag (git fetch --tags && git checkout 1.1.0), or replace docker-compose.yml with the 1.1.0 version.
  2. Pull the new images and restart:

    docker compose pull
    docker compose up -d
    
  3. Check the result:

    curl http://localhost:8000/version
    

    The response should contain "product": "1.1.0".

Podman quadlets

The quadlets carry your local values (env file path, credentials, port), so apply them again when you replace the files. These lines changed in 1.1.0:

  • the Image= tags: 1.1.0 for the RAG images, valkey/valkey:9.0.7, rabbitmq:4.4.0
  • Environment=APP_RELEASE=1.1.0 in web-gateway, api-gateway, ingestion and dlq-consumer
  • the After= and Requires= lines of web-gateway.container
  • the new [Service] section of web-gateway-migrations.container

Then reload systemd and restart the services:

systemctl --user daemon-reload
systemctl --user restart web-gateway api-gateway ingestion dlq-consumer valkey rabbitmq

Optional cleanup

RAG_WEB_VERSION, RAG_SYSTEM_VERSION, VALKEY_VERSION, POSTGRES_VERSION and RABBITMQ_VERSION in your .env are ignored from 1.1.0 on. You can delete them.

Run a different image on purpose

To run an image other than the pinned one, for example a hotfix, don't edit docker-compose.yml. Put the change in a docker-compose.override.yml next to it, which Docker Compose loads automatically:

services:
  web-gateway:
    image: registry.git.nrw/ki-expertisezentrum.nrw/apps/rag/rag-web/web-gateway:1.1.1 # example

An override survives updates of the repository. Remove it when you update, and check which images will run with docker compose config --images.

For quadlets, edit the Image= line of the .container file, then run systemctl --user daemon-reload and restart the service.

Later upgrades

Read the upgrade notes of every release between yours and the target in the release notes. MINOR and PATCH releases need no action. A MAJOR release lists its steps. See Versioning and compatibility.