Arkindex 1.6.2

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.6.2
• Run the database migrations: docker run ark-backend arkindex migrate

The release notes for Arkindex 1.6.2 are available here.

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

S3 import worker🔗

S3 import processes now use a worker instead of an internal Arkindex task. In order to be able to start S3 imports on your Arkindex instance, you now need to:

• Set the docker.ingest_image setting in your configuration file: it defaults to registry.gitlab.teklia.com/arkindex/workers/import/s3:latest but specifying a tag is recommended, as latest does not guarantee stability.
• Create the corresponding worker version on your Arkindex instance. If no worker version exists on the instance with the Docker image set in settings, when starting up the backend the system checks will display a warning. You can do this using the worker version publishing command in the CLI, or through the frontend:
  • Go to the workers list page, by clicking on Workers in the user dropdown menu (where your email address is displayed in the main navbar). Use the Create button to create a new worker. You can, for example, name it Elements Initialisation Worker, and set the type as init_worker.
  • Select your new worker in the workers list, and from the versions list on the right, use the Create button to create a new version. Set the Docker image from your settings as the Docker image reference, and leave the configuration empty.

The current recommended docker.ingest_image setting is:

registry.gitlab.teklia.com/arkindex/workers/import/s3:0.1.0

Timeout for sending verification emails🔗

The account verification email is now sent via an asynchronous task. A new job_timeouts.send_verification_email setting is available. It defaults to 120 seconds.

Timeout for creating a process from Worker Activity failures🔗

The CreateProcessFailures endpoint now creates the process in an asynchronous task, and notifies the user by email when it is available. A new job_timeouts.create_process_failures setting is available. It defaults to 3600 seconds.

Export queues🔗

Arkindex 1.6.1 introduced the export Redis queue. In this release, we split exports between two distinct queues depending on their source, i.e. the database they are generated from.

The export Redis queue is now only used by the Enterprise Edition of Arkindex. If you are using the Community Edition, then your exports will run whether or not the export queue has assigned workers.

For Arkindex instances using the Enterprise Edition:

• You can set up a dedicated database to run project exports from, using the database.export setting.
• If you have set up such a database, then the exports made from this database will run on the export Redis queue. Exports created from the main database will run on the high Redis queue.
  Warning
  

  Exports created from the export database can only run if you assign workers to the export queue. For Docker Compose-based deployments, see our sample docker-compose.yml.