From 41731e226836335d5b8042ca5fed7abd5eb6e04c Mon Sep 17 00:00:00 2001 From: Henry Birge-Lee Date: Fri, 9 May 2025 22:02:20 -0400 Subject: [PATCH 1/2] Event Bridge Documentation --- README.md | 17 +++-------------- 1 file changed, 3 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 231afce..bf672b4 100644 --- a/README.md +++ b/README.md @@ -98,22 +98,11 @@ After `tofu destroy`, `./clean.sh` in the root directory also clears generated/z `hatch run lambda:destroy-tf` can be run as an alternative to `tofu destroy` -# Remaining tasks +## EventBridge Warmer -The Open MPIC project is currently under development. The work items remaining to a feature-complete production-level product include the following: (subject to change) +The AWS Lambda deployment takes approximately 8 seconds to perform the fist Open MPIC call because of [Lambda cold starts](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtime-environment.html). Subsequent calls take approximately 1 second. To avoid a cold start and get a ~1 second response time even on the first API call, the EventBridge Warmer can optionally be used to keep the Lambda functions "hot." To deploy with this feature, add `-var="eventbridge_warmer_enabled=true"` to the `tofu apply` command (e.g., `tofu apply -var="eventbridge_warmer_enabled=true"`). **The use of the EventBridge Warmer will increase costs and incur costs even when no API calls are being made.** -- Additional integration testing - -Throughout the development process, we will address any GitHub issues raised, and may modify the API accordingly. We also welcome pull requests from the general community. - -## Completed Tasks -- API Testing scripts and usage examples. completion date: 9/11/2024 -- Automatic provisioning of lambda functions based on a configuration file. This will eliminate the need to create the lambda functions one by one and simply allow a single config file to specify the entire system configuration which is then deployed automatically. completion date: 6/29/2024 -- Full conformance to the published [API specification](https://github.com/open-mpic/open-mpic-specification). Because development on the current implementation began as we were standardizing the API specification, there are currently some discrepancies that we plan to resolve. This update will make calls to the lambda API compliant with the specification. completion date: 6/30/2024 -- Refactoring to move non-AWS-specific functionality to a library (say lib-open-mpic) and contain AWS functionality in fewer files. - -## Tasks without assigned timelines +## Additional Implementation Tasks There are several features that may be of interest to the community, but we don't yet have a specific completion timeline. These may be given higher priority based on feedback and community interest. -- Support for retrieval of contact information from whois and DNS for the purpose of validation. Several validation methods require contact information to be retrieved via multiple perspectives (e.g., email to domain CAA contact) which is then used in a subsequent validation step (that may not actually require MPIC). The API could support this by allowing a single API call to retrieve the contact info and then perform a set comparison (based on the quorum policy) to return contact info that could be used for validation. - Support for CAA extensions. CAA issue tags can potentially have extensions to specify things like account ID or validation method per [RFC 8657](https://datatracker.ietf.org/doc/html/rfc8657). The API could potentially take validation method or account id as an optional parameter and perform the processing on these CAA extensions to have them correctly impact the API response. From 078fbe8e6484b85c5e24f95d18c02c05a8ff4bea Mon Sep 17 00:00:00 2001 From: Henry Birge-Lee Date: Fri, 9 May 2025 22:15:55 -0400 Subject: [PATCH 2/2] changed versions --- README.md | 2 +- pyproject.toml | 2 +- src/aws_lambda_mpic/__about__.py | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index bf672b4..4136336 100644 --- a/README.md +++ b/README.md @@ -100,7 +100,7 @@ After `tofu destroy`, `./clean.sh` in the root directory also clears generated/z ## EventBridge Warmer -The AWS Lambda deployment takes approximately 8 seconds to perform the fist Open MPIC call because of [Lambda cold starts](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtime-environment.html). Subsequent calls take approximately 1 second. To avoid a cold start and get a ~1 second response time even on the first API call, the EventBridge Warmer can optionally be used to keep the Lambda functions "hot." To deploy with this feature, add `-var="eventbridge_warmer_enabled=true"` to the `tofu apply` command (e.g., `tofu apply -var="eventbridge_warmer_enabled=true"`). **The use of the EventBridge Warmer will increase costs and incur costs even when no API calls are being made.** +The AWS Lambda deployment takes approximately 8 seconds to perform the fist Open MPIC call because of [Lambda cold starts](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtime-environment.html). Subsequent calls take approximately 1 second. To avoid a cold start and get a ~1 second response time even on the first API call, the EventBridge Warmer can optionally be used to keep the Lambda functions "hot." To deploy with this feature, add `-var="eventbridge_warmer_enabled=true"` to the `tofu apply` command (e.g., `tofu apply -var="dnssec_enabled=false" -var="eventbridge_warmer_enabled=true"`). **The use of the EventBridge Warmer will increase costs and incur costs even when no API calls are being made.** ## Additional Implementation Tasks There are several features that may be of interest to the community, but we don't yet have a specific completion timeline. These may be given higher priority based on feedback and community interest. diff --git a/pyproject.toml b/pyproject.toml index 07b3321..2ec2094 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -33,7 +33,7 @@ dependencies = [ "pydantic==2.10.6", "aiohttp==3.11.13", "aws-lambda-powertools[parser]==3.8.0", - "open-mpic-core==5.5.3", + "open-mpic-core==5.6.0", "aioboto3~=13.3.0", "black==24.8.0", ] diff --git a/src/aws_lambda_mpic/__about__.py b/src/aws_lambda_mpic/__about__.py index 382021f..6849410 100644 --- a/src/aws_lambda_mpic/__about__.py +++ b/src/aws_lambda_mpic/__about__.py @@ -1 +1 @@ -__version__ = "1.0.6" +__version__ = "1.1.0"