Skip to content

Commit

Permalink
docs: fix readme (#5)
Browse files Browse the repository at this point in the history
* feature: add dependabot

* docs: fix readme

---------

Co-authored-by: Ran Isenberg <[email protected]>
  • Loading branch information
ran-isenberg and Ran Isenberg authored Jun 29, 2024
1 parent 72e0a48 commit d4e345e
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 3 deletions.
30 changes: 30 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
version: 2
updates:
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "monthly"
commit-message:
prefix: chore
include: scope

- package-ecosystem: "pip"
directory: "/"
schedule:
interval: "monthly"
target-branch: "main"
commit-message:
prefix: chore
include: scope

- package-ecosystem: "npm"
directory: "/"
schedule:
interval: "monthly"
target-branch: "develop"
commit-message:
prefix: chore
include: scope
allow:
# Allow updates for AWS CDK
- dependency-name: "aws-cdk"
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@
![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/ran-isenberg/streamlining-serverless-governance-aws-blog/badge)
![issues](https://img.shields.io/github/issues/ran-isenberg/streamlining-serverless-governance-aws-blog)

![alt text](https://github.com/ran-isenberg/streamlining-serverless-governance-aws-blog/blob/main/docs/media/banner.png?raw=true)

This project provides a working, open source based, AWS Lambda handler skeleton Python code including DEPLOYMENT code with CDK and a pipeline.

This project can serve as a template for new Serverless services - CDK deployment code, pipeline and handler are covered.
Expand All @@ -29,6 +27,11 @@ The architecture adheres to security best practices and governance for optimized

## Architecture Overview

<p align="center">
<img src="design.png"/>
</p>


1. **SQS Queue**:
- Receives messages and triggers the Lambda function.
- Configured with a Dead Letter Queue (DLQ) for message failures.
Expand Down Expand Up @@ -58,7 +61,7 @@ The architecture adheres to security best practices and governance for optimized

- AWS CLI configured with appropriate permissions.
- AWS CDK installed (`npm install -g aws-cdk`).
- Python 3.12 installed.
- Python 3.12 installed with poetry installed.

## Installation and Deployment

Expand Down
Binary file added design.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit d4e345e

Please sign in to comment.