Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
@cumulus/cumulus-ecs-task
Advanced tools
@cumulus/cumulus-ecs-task - npm Package Compare versions
Comparing version 1.6.0 to 1.7.0
@@ -5,11 +5,25 @@ # cumulus-ecs-task change log | ||
| The format is based on [Keep a Changelog](http://keepachangelog.com/) and this project adheres to [Semantic Versioning](http://semver.org/). | ||
| The format is based on [Keep a Changelog](http://keepachangelog.com/) and this | ||
| project adheres to [Semantic Versioning](http://semver.org/). | ||
| ## [Unreleased] | ||
| ## [v.1.7.0] | ||
| ### BREAKING CHANGES | ||
| - Now uses Node version 12.18.1 | ||
| ## [v.1.6.0] | ||
| ## BREAKING CHANGES | ||
| ### BREAKING CHANGES | ||
| - **CUMULUS-1896** - Updates to the [cumulus-message-adapter-js](https://github.com/nasa/cumulus-message-adapter-js) library and Cumulus core required an update to this image to utilize async handlers. See [Node.js Lambda documentation](https://docs.aws.amazon.com/lambda/latest/dg/nodejs-handler.html) for more information on async handlers. Users utilizing this module should update their lambdas to utilize an async handler style. | ||
| - **CUMULUS-1896** - Updates to the | ||
| [cumulus-message-adapter-js](https://github.com/nasa/cumulus-message-adapter-js) | ||
| library and Cumulus core required an update to this image to utilize async | ||
| handlers. See | ||
| [Node.js Lambda documentation](https://docs.aws.amazon.com/lambda/latest/dg/nodejs-handler.html) | ||
| for more information on async handlers. Users utilizing this module should | ||
| update their lambdas to utilize an async handler style. | ||
| ## [v1.5.1] | ||
@@ -28,3 +42,6 @@ | ||
| - **CUMULUS-1629** | ||
| - Update image python to python3. This version of cumulus-ecs-task is *required* for [Cumulus message adapter](https://github.com/nasa/cumulus-message-adapter) >= 1.2.0. | ||
| - Update image python to python3. This version of cumulus-ecs-task is | ||
| *required* for | ||
| [Cumulus message adapter](https://github.com/nasa/cumulus-message-adapter) | ||
| >= 1.2.0. | ||
@@ -43,4 +60,6 @@ ## [v1.4.0] | ||
| - **CUMULUS-1418** | ||
| - Added ability to use lambda layers if they are configured for the target lambda | ||
| - Added logic to allow CMA to utilize default `cumulus-message-adapter` location, else expect it in /opt/ | ||
| - Added ability to use lambda layers if they are configured for the target | ||
| lambda | ||
| - Added logic to allow CMA to utilize default `cumulus-message-adapter` | ||
| location, else expect it in /opt/ | ||
@@ -108,6 +127,8 @@ ## [v1.2.5] | ||
| ## [v1.0.2] - 2018-03-30 | ||
| - increase activity queue timeout to 65 seconds as suggested here: https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/StepFunctions.html#getActivityTask-property | ||
| - increase activity queue timeout to 65 seconds as suggested here: | ||
| https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/StepFunctions.html#getActivityTask-property | ||
| ## [v1.0.1] - 2018-03-23 | ||
| - fixes the validation error that happens when error strings are too long for stepfunctions.sendTaskFailure() | ||
| - fixes the validation error that happens when error strings are too long for | ||
| stepfunctions.sendTaskFailure() | ||
@@ -118,3 +139,7 @@ ## [v1.0.0] - 2018-03-08 | ||
| - Initial release | ||
| [Unreleased]: https://github.com/nasa/cumulus-ecs-task/compare/v1.5.0...HEAD | ||
| [Unreleased]: https://github.com/nasa/cumulus-ecs-task/compare/v1.7.0...HEAD | ||
| [v1.7.0]: https://github.com/nasa/cumulus-ecs-task/compare/v1.6.0...v1.7.0 | ||
| [v1.6.0]: https://github.com/nasa/cumulus-ecs-task/compare/v1.5.1...v1.6.0 | ||
| [v1.5.1]: https://github.com/nasa/cumulus-ecs-task/compare/v1.5.0...v1.5.1 | ||
| [v1.5.0]: https://github.com/nasa/cumulus-ecs-task/compare/v1.4.0...v1.5.0 | ||
@@ -121,0 +146,0 @@ [v1.4.0]: https://github.com/nasa/cumulus-ecs-task/compare/v1.3.0...v1.4.0 |
| { | ||
| "name": "@cumulus/cumulus-ecs-task", | ||
| "version": "1.6.0", | ||
| "version": "1.7.0", | ||
| "description": "Run lambda functions in ECS", | ||
@@ -10,3 +10,3 @@ "main": "index.js", | ||
| "engines": { | ||
| "node": ">=10.16.3" | ||
| "node": ">=12.18.0" | ||
| }, | ||
@@ -13,0 +13,0 @@ "keywords": [ |
@@ -6,17 +6,26 @@ # cumulus-ecs-task | ||
| Use this Docker image to run a Node.js Lambda function in AWS [ECS](https://aws.amazon.com/ecs/). | ||
| Use this Docker image to run a Node.js Lambda function in AWS | ||
| [ECS](https://aws.amazon.com/ecs/). | ||
| ## About | ||
| cumulus-ecs-task is a Docker image that can run Lambda functions as ECS services. | ||
| cumulus-ecs-task is a Docker image that can run Lambda functions as ECS | ||
| services. | ||
| When included in a Cumulus workflow and deployed to AWS, it will download a specified Lambda function, and act as an activity in a Step Functions workflow. | ||
| When included in a Cumulus workflow and deployed to AWS, it will download a | ||
| specified Lambda function, and act as an activity in a Step Functions workflow. | ||
| ## Compatibility | ||
| This only works with Node.js Lambda functions, and requires that the Lambda function it is running has a dependency of at least v1.0.1 of [cumulus-message-adapter-js](https://github.com/cumulus-nasa/cumulus-message-adapter-js). | ||
| This only works with Node.js Lambda functions, and requires that the Lambda | ||
| function it is running has a dependency of at least v1.0.1 of | ||
| [cumulus-message-adapter-js](https://github.com/cumulus-nasa/cumulus-message-adapter-js). | ||
| ## Usage | ||
| Like other Cumulus libraries, cumulus-ecs-task is designed to be deployed to AWS using [kes](https://github.com/developmentseed/kes) to manage Cloudformation config. This documentation assumes you're working with a Cumulus deployment and that you have files and directory structure similar to what's found in the [cumulus template repository](https://github.com/cumulus-nasa/template-deploy). | ||
| Like other Cumulus libraries, cumulus-ecs-task is designed to be deployed to AWS | ||
| using [kes](https://github.com/developmentseed/kes) to manage Cloudformation | ||
| config. This documentation assumes you're working with a Cumulus deployment and | ||
| that you have files and directory structure similar to what's found in the | ||
| [cumulus template repository](https://github.com/cumulus-nasa/template-deploy). | ||
@@ -28,3 +37,4 @@ ### Options | ||
| - `activityArn` **required** | ||
| - The arn of the activity in a step functions workflow. Used to receive messages for that activity and send success/failure responses. | ||
| - The arn of the activity in a step functions workflow. Used to receive | ||
| messages for that activity and send success/failure responses. | ||
| - `lambdaArn` **required** | ||
@@ -35,3 +45,7 @@ - The arn of the lambda function you want to run in ECS. | ||
| For examples of how to integrate this image with Cumulus, please see the [documentation](https://nasa.github.io/cumulus/docs/workflows/developing-workflow-tasks#ecs-activities) and our [example workflow](https://github.com/nasa/cumulus/blob/master/example/cumulus-tf/ecs_hello_world_workflow.tf) in source. | ||
| For examples of how to integrate this image with Cumulus, please see the | ||
| [documentation](https://nasa.github.io/cumulus/docs/workflows/developing-workflow-tasks#ecs-activities) | ||
| and our | ||
| [example workflow](https://github.com/nasa/cumulus/blob/master/example/cumulus-tf/ecs_hello_world_workflow.tf) | ||
| in source. | ||
@@ -64,5 +78,7 @@ ## Development | ||
| You can execute workflows on AWS that test the version of cumulus-ecs-task that you're developing on locally. | ||
| You can execute workflows on AWS that test the version of cumulus-ecs-task that | ||
| you're developing on locally. | ||
| First, make sure that the ECS cluster for your deployment has zero tasks running that might respond to a workflow's requests. | ||
| First, make sure that the ECS cluster for your deployment has zero tasks running | ||
| that might respond to a workflow's requests. | ||
@@ -93,3 +109,4 @@ That way only your local version will respond to your workflow. | ||
| Finally, trigger a workflow. You can do this from the Cumulus dashboard, the Cumulus API, or with the AWS Console. | ||
| Finally, trigger a workflow. You can do this from the Cumulus dashboard, the | ||
| Cumulus API, or with the AWS Console. | ||
@@ -100,6 +117,7 @@ ## Troubleshooting | ||
| Make sure the EC2 instance has internet access and is able to pull the image from docker hub by doing: | ||
| Make sure the EC2 instance has internet access and is able to pull the image | ||
| from docker hub by doing: | ||
| ```bash | ||
| docker pull cumuluss/cumulus-ecs-task:1.1.1 | ||
| docker pull cumuluss/cumulus-ecs-task:1.7.0 | ||
| ``` | ||
@@ -118,3 +136,5 @@ | ||
| - Delete the ec2 instance and redeploy | ||
| - Delete the incorrect config and restart the ecs agent (I haven't tested this much but I expect it to work. You'll still want to update the docker credentials in the deployment's app directory). Restart the agent by doing: | ||
| - Delete the incorrect config and restart the ecs agent (I haven't tested this | ||
| much but I expect it to work. You'll still want to update the docker | ||
| credentials in the deployment's app directory). Restart the agent by doing: | ||
@@ -129,5 +149,7 @@ ```bash | ||
| To create a release, first make sure the [CHANGELOG.md](CHANGELOG.md) file is updated with all the changes made. | ||
| To create a release, first make sure the [CHANGELOG.md](CHANGELOG.md) file is | ||
| updated with all the changes made. | ||
| Next, bump the version and the changes will automatically be released upon merge to master. | ||
| Next, bump the version and the changes will automatically be released upon merge | ||
| to master. | ||
@@ -134,0 +156,0 @@ ```bash |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by0.62%
58288
- Number of lines in readme file
- increased by14.77%
171
No dependency changes