feat: add workflow to trigger external pipeline for publishing lambda layers #129
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 8 commits
August 23, 2020 11:47
am29d
changed the title
Codecov Report
@@ Coverage Diff @@
## develop #129 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 24 24
Lines 706 706
Branches 66 66
=========================================
Hits 706 706 Continue to review full report at Codecov.
|
heitorlessa
reviewed
Aug 23, 2020
|
This is awesome - Thanks for doing that ;) As to the docs, you can add that in the homepage under Installation: https://github.com/awslabs/aws-lambda-powertools-python/blob/develop/docs/content/index.mdx Create a sub-heading called |
…rtools-python into feat/lambda-layers
heitorlessa
reviewed
Aug 25, 2020
Comment on lines
+64
to
+75
| Create the layer via API with: | ||
|
|
||
| ```bash:title=bash-script | ||
| aws serverlessrepo create-cloud-formation-change-set --application-id arn:aws:serverlessrepo:eu-west-1:057560766410:applications/aws-lambda-powertools-python-layer --stack-name YOUR_STACK_NAME --capabilities CAPABILITY_NAMED_IAM | ||
| CHANGE_SET_ID=$(aws cloudformation list-change-sets --stack-name YOUR_STACK_NAME --query 'Summaries[*].ChangeSetId' --output text) | ||
| aws cloudformation wait change-set-create-complete --change-set-name $CHANGE_SET_ID | ||
| aws cloudformation execute-change-set --change-set-name $CHANGE_SET_ID | ||
| ``` | ||
|
|
||
| this will create a CloudFormation stack with the powertools layer in a specific region where you run this commands. | ||
| Keep in mind that layers are regional resources and you need to create the layer in every region where you need it. | ||
| Alternatively, you can deploy the layer from the AWS Console by navigating to Serverless Application Repository and search for `aws-lambda-powertools-python-layer` and follow the deploy steps from there. |
There was a problem hiding this comment.
Suggested change
| Create the layer via API with: | |
| ```bash:title=bash-script | |
| aws serverlessrepo create-cloud-formation-change-set --application-id arn:aws:serverlessrepo:eu-west-1:057560766410:applications/aws-lambda-powertools-python-layer --stack-name YOUR_STACK_NAME --capabilities CAPABILITY_NAMED_IAM | |
| CHANGE_SET_ID=$(aws cloudformation list-change-sets --stack-name YOUR_STACK_NAME --query 'Summaries[*].ChangeSetId' --output text) | |
| aws cloudformation wait change-set-create-complete --change-set-name $CHANGE_SET_ID | |
| aws cloudformation execute-change-set --change-set-name $CHANGE_SET_ID | |
| ``` | |
| this will create a CloudFormation stack with the powertools layer in a specific region where you run this commands. | |
| Keep in mind that layers are regional resources and you need to create the layer in every region where you need it. | |
| Alternatively, you can deploy the layer from the AWS Console by navigating to Serverless Application Repository and search for `aws-lambda-powertools-python-layer` and follow the deploy steps from there. | |
| SAR App | ARN | |
| ------------------------------------------------- | --------------------------------------------------------------------------------- | |
| [aws-lambda-powertools-python-layer](https://serverlessrepo.aws.amazon.com/applications/eu-west-1/057560766410/aws-lambda-powertools-python-layer) | arn:aws:serverlessrepo:eu-west-1:057560766410:applications/aws-lambda-powertools-python-layer | |
| If using SAM, you can include this SAR App as part of your shared Layers stack, and lock to a specific semantic version. Once deployed, it'll be available across the account this is deployed to. | |
| ```yaml | |
| AwsLambdaPowertoolsPythonLayer: | |
| Type: AWS::Serverless::Application | |
| Properties: | |
| Location: | |
| ApplicationId: arn:aws:serverlessrepo:eu-west-1:057560766410:applications/aws-lambda-powertools-python-layer | |
| SemanticVersion: 1.3.0 # change to latest semantic version available in SAR |
Customers typically use SAR within their SAM stack, or the Console, but rarely using the CLI as it's quite a lot of steps. Added a table as well as a snippet of this SAR App
heitorlessa
reviewed
Aug 25, 2020
| @@ -58,6 +58,22 @@ from aws_lambda_powertools.logging.logger import set_package_logger | |||
| set_package_logger() | |||
| ``` | |||
|
|
|||
| ## Lambda Layer | |||
|
|
|||
| Powertools is also available as a layer and is distributed via the [Serverless Application Repository](https://docs.aws.amazon.com/serverlessrepo/latest/devguide/what-is-serverlessrepo.html). | |||
There was a problem hiding this comment.
Suggested change
| Powertools is also available as a layer and is distributed via the [Serverless Application Repository](https://docs.aws.amazon.com/serverlessrepo/latest/devguide/what-is-serverlessrepo.html). | |
| Powertools is also available as a Lambda Layer. It is distributed via the [AWS Serverless Application Repository (SAR)](https://docs.aws.amazon.com/serverlessrepo/latest/devguide/what-is-serverlessrepo.html). |
heitorlessa
suggested changes
Aug 25, 2020
|
I seem to not have access to commit these changes while Alex is off... I'm merging as-is, and will submit the changes in a separate commit to |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue # , if available: #25
Description of changes:
Add workflow to publish latest release to Serverless Application Repository. This workflow will pass the release version parameter to ssm and start the pipeline within an internal AWS account. The GitHub secrets will be added separately. The code pipeline will package and publish the layer under the name aws-lambda-powertools-python-layer.
I would like to add documentation where to find the layer in SAR, how to find the right version, deploy and use it, but I am not sure to where to put the content. Docs, README.md or a dedicated .md file with a link in README.md?
Checklist
Breaking change checklist
RFC issue #:
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.