Arkindex 1.8.0

A new Arkindex release is available.

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.8.0
• Run the database migrations: docker exec ark-backend arkindex migrate
• Update the system workers: docker exec ark-backend arkindex update_system_workers

The release notes for Arkindex 1.8.0 are available here.

The main changes impacting developers and system administrators are detailed below.

Support for PostgreSQL 14 dropped

Arkindex now requires PostgreSQL 15 and later. Official support for PostgreSQL 14 is dropped.

When attempting to run Arkindex on any PostgreSQL database with a version below 15, a new critical system check issue will be reported.

This has no impact for developers, as the development setup has been running PostgreSQL 17 since Arkindex 1.7.2.

New budget update command

Info

This feature is only available in Arkindex Enterprise Edition.

A new arkindex update_budgets command has been added to the backend. This command creates new budget entries for all processes that ran using workers with costs. To properly keep track of the current budget usage by processes, system administrators should configure their instances to run this command regularly, similarly to arkindex cleanup.

New setting for process budget enforcement

Info

This feature is only available in Arkindex Enterprise Edition.

A new process_enforce_budgets setting has been introduced to restrict running any process or task when workers with costs are involved. It will not be possible to run a worker with costs unless a budget has funds available, and the user has the necessary access rights to use the budget.

This setting is disabled by default to preserve the current behavior, but may be enabled by default in a future release.

Updated email configuration

Some options in the backend configuration related to sending emails have been changed:

• email.user is now optional and nullable. Omitting it, or setting it to null, will disable authentication to the SMTP server.
• email.password is now optional and nullable. Omitting it, or setting it to null, will disable authentication to the SMTP server.
• A new email.tls allows disabling TLS when connecting to the SMTP server. It defaults to true, as Arkindex was only ever using TLS before this option was introduced.

New frontend development tooling

Numerous upgrades have been done on the development and build tools on the Arkindex frontend:

• We now use Vite instead of Vue CLI as our build tool.
• Unit tests now use Vitest instead of Mocha.
• The pre-commit hooks have been replaced with Husky.
• The code is now automatically formatted using Prettier.

This removes many deprecated dependencies, and brings the project to the current recommendations for modern Vue.js development. Many issues with linting tools not running properly, or only running well when using Volar, have been resolved.

Developers should update their frontend repositories and run npm install to upgrade their development setup. No other changes are required.

This has no impact for system administrators.

MinIO upgrade

The development setup includes a MinIO container to provide S3 storage, which was pinned to a release from 2021. This older version provided its simple filesystem-based storage using “filesystem mode”, a feature that has since been dropped. We have upgraded MinIO to a more recent release. Developers will need to either start from scratch, losing all of their data on the local S3 buckets, or to migrate manually.

This has no impact for system administrators.

To start from scratch

1. Ensure all Arkindex containers are stopped: docker compose -p arkindex down
2. Erase the previous MinIO data: docker volume rm arkindex_miniodata
3. Restart the backend’s third-party services. This will recreate the buckets that Arkindex needs.

To migrate existing data

This is a simplified version of the official migration guide adapted to the MinIO instance provided by the Arkindex dev setup. During the migration, you will have 2 instances on MinIO running in parallel on your computer. This is required to be able to copy all the data from the old instance towards the new one. 1. Start the old MinIO server in your previous development setup with make services. You can use the 1.7.3 arkindex release for that (git checkout 1.7.3) 2. Verify that your server is correctly running: the MinIO console should be available with your existing buckets. 3. Run the following script to perform the migration:

# Start a server for this migration with the new MinIO version
docker run \
    --rm \
    --name ark-minio-migration \
    --detach \
    --publish 9002:9002 \
    --env MINIO_ROOT_USER=minio1234 \
    --env MINIO_ROOT_PASSWORD=minio1234 \
    --volume arkindex_miniodata:/olddata \
    --volume arkindex_minio_migration:/newdata \
    --network arkindex_default \
    minio/minio:RELEASE.2025-02-28T09-55-16Z \
    server /newdata --console-address :9002

# Configure the MinIO client to perform the migration
docker exec -it ark-minio-migration mc alias set old http://ark-minio:9000/ minio1234 minio1234
docker exec -it ark-minio-migration mc alias set new http://localhost:9000/ minio1234 minio1234

# Run the migration on each bucket
for bucket in export iiif-cache ingest ponos-artifacts ponos-logs staging thumbnails training uploads; do
    docker exec -it ark-minio-migration mc mb "new/$bucket"
    docker exec -it ark-minio-migration mc mirror --preserve "old/$bucket" "new/$bucket"
done

4. Open the MinIO console for the temporary migration server and login with minio1234 as the username and password.
5. Check that the same buckets are listed in both consoles, with the correct amount of objects.
6. Run the following to complete the migration:

# Stop the old server
docker compose -p arkindex down

# Overwrite the old server's data with the migrated data
docker exec -it ark-minio-migration sh -c 'rm -rf /olddata/.minio.sys /olddata/* && cp -rf /newdata/.minio.sys /newdata/* /olddata/'

# Stop the migration server
docker stop ark-minio-migration

7. Update your backend repository to get the newer server in your Docker Compose configuration. You should be on the release-1.8.0 branch or the 1.8.0 tag once available.
8. Start the new services with make services.
9. Check that the MinIO console is now the console of the newer version and still has your buckets.
10. Delete the migration data: docker volume rm arkindex_minio_migration