Arkindex 1.10.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.
Worker configurations
Creating a worker configuration on a worker version that uses the modern configuration format will now require some backend-side validation. It is no longer possible to create a worker configuration with invalid values, and users can get better feedback on why each value is invalid without having to troubleshoot a failed process.
This validation does not yet run when selecting an existing configuration in a process, or when starting or retrying a process. Existing configurations that refer to objects that do not exist or that users do not have access to could still cause errors.
This validation will run when starting a document export, as it implicitly creates a worker configuration.
Additionally, all system workers on Arkindex have now been migrated to this modern configuration format, bringing us one step closer to removing the previous format.
Processes
Environment variables are now computed when starting a task, instead of being computed only when starting or retrying a process. This resolves issues with obsolete variables being set when restarting a task using the Restart task button.
API
In Arkindex 1.9.0, we had introduced a new API error format to allow more detailed validation on worker configurations. This new format has been used by every new API endpoint in subsequent releases. In this release, we are also starting to migrate existing API endpoints. The following API endpoints now return errors in the new format:
The documentation for each of those API endpoints contains a detailed description of the structure of this new format.
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.10.2 -
Run the database migrations:
docker exec ark-backend arkindex migrate -
Update the system workers:
docker exec ark-backend arkindex update_system_workers
The main changes impacting developers and system administrators are detailed below.
Minimum Ponos agent version
Administrators of Enterprise Edition instances must upgrade all Ponos agents to version 0.14.0 when upgrading to this new Arkindex version.
The changes to task environment variables mean that tasks executed by older versions of the agent will no longer have access to an API token or to their process ID.
Conversely, upgrading any Ponos agent to version 0.14.0 requires upgrading the Arkindex instance to this release. This version will expect attributes on tasks that are only provided starting with this release.
Django 6.0.1 and Python 3.12 upgrade
The Arkindex backend has been updated to Django 6.0.1. As the Django 6.0 branch drops support for Python 3.10, Arkindex now requires Python 3.12 to run.
System administrators and other users of the Docker images do not need to take any actions, as the Docker images were already using Python 3.12 since Arkindex 1.7.3. Developers may need to re-create their virtual environments.
Removed email.error_report_recipients
The error_report_recipients option has been removed from the email configuration. This setting was misleading, as emails were no longer sent for server errors since Arkindex 0.12.1. If your configuration includes this setting, it will now be ignored. You can safely remove it.