Skip to content

feat: add workflow to trigger external pipeline for publishing lambda layers #129

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 14 commits into from
Aug 25, 2020
Merged

feat: add workflow to trigger external pipeline for publishing lambda layers #129

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
1f43ce4
line endings
Aug 23, 2020
eea4375
fix indent, yaml ...
Aug 23, 2020
1949593
fix typo in branch trigger
Aug 23, 2020
6ddd736
more typos
Aug 23, 2020
e6e5c12
add relase tag simulation
Aug 23, 2020
dac548c
add overwrite flag for ssm
Aug 23, 2020
7e0b872
remove tmp release flag and set trigger to release published
Aug 23, 2020
e8d77b7
change to eu-west-1 default region
Aug 23, 2020
2455001
moved publish step to publish workflow after pypi push
Aug 24, 2020
ac10b4f
add layer to docs and how to use it from SAR
Aug 24, 2020
5a9d576
Merge branch 'develop' into feat/lambda-layers
am29d Aug 24, 2020
679b22f
formatting for bash script
Aug 24, 2020
09d841e
Merge branch 'feat/lambda-layers' of github.com:am29d/aws-lambda-powe…
Aug 24, 2020
607904c
fix heading error due to merge
Aug 25, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions .github/workflows/publish.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,17 @@ jobs:
env:
PYPI_USERNAME: __token__
PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
- name: publish lambda layer in SAR by triggering the internal codepipeline
run: |
aws ssm put-parameter --name "powertools-python-release-version" --value $RELEASE_TAG_VERSION --overwrite
aws codepipeline start-pipeline-execution --name ${{ secrets.CODEPIPELINE_NAME }}
env:
AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
AWS_DEFAULT_REGION: eu-west-1
AWS_DEFAULT_OUTPUT: json



sync_master:
needs: upload
Expand Down
16 changes: 16 additions & 0 deletions docs/content/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Copy link
Contributor

@heitorlessa heitorlessa Aug 25, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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).

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.
Comment on lines +64 to +75
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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


## Tenets

* **AWS Lambda only** – We optimise for AWS Lambda function environments and supported runtimes only. Utilities might work with web frameworks and non-Lambda environments, though they are not officially supported.
Expand Down