Setting Up Queue Workers for Laravel Deployments

[chrillep]

Description

As a developer, I want to automatically set up and restart Laravel queue workers during deployment, so that background jobs process seamlessly without manual intervention.

---

Additional Information

• This story addresses the need for proper queue worker setup during deployments for Laravel applications using Deployer.
• It ensures that workers run updated code post-deployment and can handle worker failures with process management.
• Related links:
  • Laravel Queue Documentation
  • Supervisor Documentation
  • Deployer Laravel Recipe
  • Example Supervisor Configuration File

---

Acceptance Criteria (AC)

1. Supervisor configuration is provided as part of the deployment documentation.
2. The Laravel recipe automatically restarts queue workers during deployment.
3. Developers can customize worker parameters such as --queue, --max-jobs, --max-time, and --sleep.
4. Workers gracefully handle application maintenance mode and restart post-deployment.
5. Documentation is updated with detailed instructions for configuring Supervisor and Laravel workers.

---

How To Test

Setting Up Supervisor

1. Navigate to /etc/supervisor/conf.d/.
2. Add a configuration file named laravel-worker.conf with the following content:

   [program:laravel-worker]
   process_name=%(program_name)s_%(process_num)02d
   command=php /path/to/artisan queue:work --sleep=3 --tries=3 --max-time=3600
   autostart=true
   autorestart=true
   stopasgroup=true
   killasgroup=true
   user=forge
   numprocs=8
   redirect_stderr=true
   stdout_logfile=/path/to/worker.log
   stopwaitsecs=3600