Arkindex 1.11.2

We are happy to announce that a new Arkindex release is available. You can explore Arkindex and try out the newest features on our demo instance, demo.arkindex.org.

Removal notices

Old configuration format

As per our previous announcements, support for importing workers based on the previous configuration format with .arkindex.yml will be removed in the next release, Arkindex 1.12.0. Workers that were previously imported may continue to work, but they will not be officially supported.

Worker developers should follow the migration guide to migrate workers to the new configuration format.

JSON elements listing

Support for elements.json will also be removed in Arkindex 1.12.0. This means the Skip JSON elements listing option will be removed, and Workers processes will always behave as if that option was enabled.

Worker developers are encouraged to ensure their workers use version 0.5.1 or later of Base Worker to support this change.

Processes

Starting any process can now provide much more detailed validation errors. For example, running a process using a worker version that requires a model version, but without having specified any model version, will cause a specific error message to be shown on the associated worker version, instead of a generic message that applies to the whole process.

Retrying an existing process can now also perform the same validation and get the same detailed errors. This makes it safer to retry older processes, as retrying those with archived worker versions, unavailable model versions, etc. will no longer be allowed.

This change will allow for a detailed validation of configurations in later releases, after the old configuration format gets removed.

Users

Authenticated users can now update their email address without having to contact an instance administrator. Updating this address will cause a new verification email to be sent.

This can be particularly helpful on instances that offer to login with OpenID Connect, as the email address is not always guaranteed to be correct and may need to be updated manually.

API

The following API endpoints have been migrated to the new error format:

The documentation for each of those API endpoints contains a detailed description of the structure of this new format.

Misc

  • Fixed an issue that prevented the Update button of the modal to edit an element from running any update.

  • The process configuration page no longer makes two API calls for each WorkerRun in the process when it loads.

  • The ListWorkerRuns endpoint has been optimized and can no longer make up to 1020 additional database queries in the worst case.

  • The S3 import now skips over PDF files that have failed to import instead of failing entirely.

Upgrade notes

To upgrade a development instance, follow this documentation.

To upgrade a production instance, you need to:

  • Deploy this release’s Docker image: registry.gitlab.teklia.com/arkindex/backend:1.11.2

  • Run the database migrations: docker exec ark-backend arkindex migrate

  • Update the system workers: docker exec ark-backend arkindex update_system_workers

There are no notable changes or other actions to take for developers and system administrators in this release.