Workers property

Last update: 2024-02-05
  • Created for:
  • Admin
    Developer

You can define a worker to run independently from the web instance without a running Nginx instance; however, the worker does use the same network storage used by the Commerce application. You do not need to set up a web server on the worker instance (using Node.js or Go) because the router cannot direct public requests to the worker. This makes the worker instance ideal for background tasks or continually running tasks that risk blocking a deployment.

Configure a worker

Workers are available to use with Pro Staging and Production environments only. Pro integration and Starter environments can opt to use the CRON_CONSUMERS_RUNNER variable.

To configure a worker in Pro Staging or Production, Submit an Adobe Commerce Support ticket and include the following information:

  • Project ID
  • Environment ID
  • Worker name
  • Start commands

You can configure one process per worker. A basic, common worker configuration in the .magento.app.yaml file could look like the following:

workers:
    queue:
        commands:
            start: |
                php ./bin/magento queue:consumers:start commerce.eventing.event.publish

This example defines a single worker named queue, with a small (size S) level of resource allocation, and runs the php ./bin/magento command on startup. The worker queue then runs on each node as a worker process. If the command exits, it is automatically restarted.

Commands and overrides

The commands.start key is required to launch commands with the worker application. You can use any valid shell command, although it is ideal to use the language of your application. If the command specified by the start key terminates, it restarts automatically.

IMPORTANT

The deploy and post_deploy hooks and crons commands only run on the web container, not in worker instances.

Inheritance

Definitions for the size, relationships, access, disk and mount, and variables properties are inherited by a worker, unless explicitly overridden.

The following properties are the most commonly used to override top-level settings:

  • size—allocate fewer resources to a single background process
  • variables—instruct the application to run differently

Timing and queueing

Though each worker queues behind another, the following configuration produces a consistent two-second separation in time stamps in the var/time.txt file, regardless of the eight-second sleep within the PHP code:

workers:
    time1:
        commands:
            start: 'php -r "sleep(8); echo time() . PHP_EOL;" >> var/time.txt& sleep 2'

On this page