Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lukewaite/laravel-queue-aws-batch
A Laravel queue connector for AWS Batch
https://github.com/lukewaite/laravel-queue-aws-batch
aws aws-batch laravel php queue
Last synced: about 3 hours ago
JSON representation
A Laravel queue connector for AWS Batch
- Host: GitHub
- URL: https://github.com/lukewaite/laravel-queue-aws-batch
- Owner: lukewaite
- License: mit
- Created: 2017-04-01T00:48:18.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2022-12-14T02:41:26.000Z (almost 2 years ago)
- Last Synced: 2024-10-21T03:03:59.735Z (27 days ago)
- Topics: aws, aws-batch, laravel, php, queue
- Language: PHP
- Homepage:
- Size: 64.5 KB
- Stars: 9
- Watchers: 4
- Forks: 16
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
## Laravel Queue for AWS Batch
[![Latest Version on Packagist][ico-version]][link-packagist]
[![Software License][ico-license]](LICENSE.md)
[![Build Status][ico-github]][link-github]
[![Code Coverage][ico-coverage]][link-coverage]
### 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.
Using `composer`, run:
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`.
2. Add a new queue to your `config/queues.php` config file's `connections` array:
```
[
'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.
3. 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`.
4. Create a AWS Batch job definition for each queue you define that looks something like this:
```json
{
"jobDefinitionName": "my-laravel-application",
"type": "container",
"parameters": {},
"retryStrategy": {
"attempts": 10
},
"containerProperties": {
"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.
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.
6. 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.
[ico-version]: https://img.shields.io/packagist/v/lukewaite/laravel-queue-aws-batch.svg?style=flat-square
[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
[ico-github]: https://img.shields.io/github/workflow/status/lukewaite/laravel-queue-aws-batch/Tests/main.svg?style=flat-square
[ico-coverage]: https://img.shields.io/scrutinizer/coverage/g/lukewaite/laravel-queue-aws-batch/main.svg?style=flat-square
[link-packagist]: https://packagist.org/packages/lukewaite/laravel-queue-aws-batch
[link-github]: https://github.com/lukewaite/laravel-queue-aws-batch/actions/workflows/tests.yml?query=branch%3Amain++
[link-coverage]: https://scrutinizer-ci.com/g/lukewaite/laravel-queue-aws-batch/?branch=main