2017 © Pedro Peláez
 

library laravel-queue-aws-batch

Laravel Queue for AWS Batch, enabling users to submit jobs for processing to a Batch queue.

image

lukewaite/laravel-queue-aws-batch

Laravel Queue for AWS Batch, enabling users to submit jobs for processing to a Batch queue.

  • Friday, July 20, 2018
  • by lukewaite
  • Repository
  • 3 Watchers
  • 3 Stars
  • 2,429 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 0 Forks
  • 0 Open issues
  • 13 Versions
  • 45 % Grown

The README.md

Laravel Queue for AWS Batch

Latest Version on Packagist ![Software License][ico-license] [Build Status][link-github] ![Code Coverage][ico-coverage], (*1)

Supported Versions

Laravel Version Package Tag Supported
8.x unreleased yes
5.4.x 2.0.x no
5.3.x 1.0.x no
5.2.x 1.0.x no
5.1.x 1.0.x no

Installation

See the table above for package version information, and change the version below accordingly., (*2)

Using composer, run:, (*3)

composer require lukewaite/laravel-queue-aws-batch ~2.0

Usage

  1. Your Laravel application will need to be dockerized and pushed into a container registry of your choice. The ENTRYPOINT should be set to artisan., (*4)

  2. Add a new queue to your config/queues.php config file's connections array:, (*5)

    [
        'batch' => [
            'driver' => 'batch',
            'table' => 'jobs',
            'queue' => 'first-run-job-queue',
            'jobDefinition' => 'my-job-definition',
            'expire' => 60,
            'region' => 'us-east-1'
        ]
    ]

This queue transport depends on being able to write it's queue jobs to a database queue. In this example, it writes it's jobs to the jobs table. You'll need to use the artisan queue:table to create a migration to create this table., (*6)

  1. Create an AWS Batch job queue with the same name as the queue config setting. This is where the Batch connector will push your jobs into Batch. In this case, my queue name would be first-run-job-queue., (*7)

  2. Create a AWS Batch job definition for each queue you define that looks something like this:, (*8)

{
    "jobDefinitionName": "my-laravel-application",
    "type": "container",
    "parameters": {},
    "retryStrategy": {
        "attempts": 10
    },
    "containerProperties": {
        "image": "<your docker image>",
        "vcpus": 1,
        "memory": 256,
        "command": [
            "queue:work-batch",
            "Ref::jobId",
            "--tries=3"
        ],
        "volumes": [],
        "environment": [],
        "mountPoints": [],
        "ulimits": []
    }
}

Here, you configure your container to start, run the queue:work-batch command (assuming artisan is your entrypoint) and pass in the name of the queue, first-run-job-queue as well as the Ref::jobId param, which is passed in when the Batch connector creates the job., (*9)

It is important that you configure a retryStrategy with more "attempts" than you are running tries if you provide that argument. Otherwise, Batch will not retry your job if it fails. Laravel 5.1 does not write to the failed job queue until the next run after tries has been exceeded by jobs failing. Newer versions will write to the queue in the same run, so this requirement can be relaxed later., (*10)

  1. Add the Service Provider to your application:
    • In config/app.php add to the providers array: LukeWaite\LaravelQueueAwsBatch\BatchQueueServiceProvider::class

Limitations

Delayed Jobs

AWS Batch has no method to delay a job and as it's our runner, we don't have an easy work around. If you require delayed jobs for your use case, at this point my recommendation would be to use a regular DB queue, and to fire a job into it which will fire your batch job at the correct time., (*11)

The Versions

20/07 2018

1.0.x-dev

1.0.9999999.9999999-dev

Laravel Queue for AWS Batch, enabling users to submit jobs for processing to a Batch queue.

  Sources   Download

MIT

The Requires

 

The Development Requires

laravel aws queue batch

20/07 2018

v1.0.2

1.0.2.0

Laravel Queue for AWS Batch, enabling users to submit jobs for processing to a Batch queue.

  Sources   Download

MIT

The Requires

 

The Development Requires

laravel aws queue batch

16/07 2018

v1.0.1

1.0.1.0

Laravel Queue for AWS Batch, enabling users to submit jobs for processing to a Batch queue.

  Sources   Download

MIT

The Requires

 

The Development Requires

laravel aws queue batch

07/02 2018

dev-fix_batch_queue_retry

dev-fix_batch_queue_retry

Laravel Queue for AWS Batch, enabling users to submit jobs for processing to a Batch queue.

  Sources   Download

MIT

The Requires

 

The Development Requires

laravel aws queue batch

14/04 2017

dev-master

9999999-dev

Laravel Queue for AWS Batch, enabling users to submit jobs for processing to a Batch queue.

  Sources   Download

MIT

The Requires

 

The Development Requires

laravel aws queue batch

14/04 2017

v2.0.1

2.0.1.0

Laravel Queue for AWS Batch, enabling users to submit jobs for processing to a Batch queue.

  Sources   Download

MIT

The Requires

 

The Development Requires

laravel aws queue batch

10/04 2017

dev-laravel_master_test

dev-laravel_master_test

Laravel Queue for AWS Batch, enabling users to submit jobs for processing to a Batch queue.

  Sources   Download

MIT

The Requires

 

The Development Requires

laravel aws queue batch

09/04 2017

v2.0.0

2.0.0.0

Laravel Queue for AWS Batch, enabling users to submit jobs for processing to a Batch queue.

  Sources   Download

MIT

The Requires

 

The Development Requires

laravel aws queue batch

09/04 2017

v1.0.0

1.0.0.0

Laravel Queue for AWS Batch, enabling users to submit jobs for processing to a Batch queue.

  Sources   Download

MIT

The Requires

 

The Development Requires

laravel aws queue batch

08/04 2017

v0.2.1

0.2.1.0

Laravel Queue for AWS Batch, enabling users to submit jobs for processing to a Batch queue.

  Sources   Download

MIT

The Requires

 

The Development Requires

laravel aws queue batch

07/04 2017

v0.2.0

0.2.0.0

Laravel Queue for AWS Batch, enabling users to submit jobs for processing to a Batch queue.

  Sources   Download

MIT

The Requires

 

The Development Requires

laravel aws queue batch

01/04 2017

v0.1.1

0.1.1.0

Laravel Queue for AWS Batch, enabling users to submit jobs for processing to a Batch queue.

  Sources   Download

MIT

The Requires

 

The Development Requires

laravel aws queue batch

01/04 2017

v0.1.0

0.1.0.0

  Sources   Download

The Requires

 

The Development Requires