Changes for v1.1.1 (#7)

Author: JimTharioAmazon

.github/ISSUE_TEMPLATE/bug_report.md

@@ -25,7 +25,7 @@ To get the version of the solution, you can look at the description of the creat
     "Environment": {
       "Variables": {
         "SOLUTION_ID": "SO0248",
-        "SOLUTION_VERSION": "v1.1.0"
+        "SOLUTION_VERSION": "v1.1.1"
       }
     },
 ```
@@ -34,7 +34,7 @@ This information is also provided in `source/infrastructure/cdk.json`:
 
 ```json
     "SOLUTION_ID": "SO0248",
-    "SOLUTION_VERSION": "v1.1.0",
+    "SOLUTION_VERSION": "v1.1.1",
 ```
 
 

CHANGELOG.md

@@ -5,25 +5,33 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [1.0.0] - 2024-05-28
+## [1.1.1] - 2025-03-07
 
-### Added
+- Upgrade to Prebid Server v3.22 and underlying Docker base image
+- Optimized container image using jlink reducing image size from 774 MB to 142 MB
+- Change to Poetry for Python dependency management
+- Add script to run Prebid Server container locally with stack settings
 
-- All files, initial version
+## [1.1.0] - 2024-10-31
+
+- Upgrade to Prebid Server v3.13 and underlying Docker base image
+- ECS runtime logs in AWS CloudWatch instead of S3
+- Option to opt-out of installing CloudFront and WAF
+- Customize Prebid Server configuration through files in S3
+- Option to specify a custom container image
+
+## [1.0.2] - 2024-09-23
+
+- Upgrade Python `requests` package to version 2.32.3 in requirements.txt
+- Bug fix for launch failure of EfsCleanupContainerStop Lambda function
 
 ## [1.0.1] - 2024-08-02
 
 - Remove python `setuptools` and `pip` from prebid server docker image
 - Include missing copyright header for `source/infrastructure/prebid_server/stack_constants.py`
 
-## [1.0.2] - 2024-09-23
+## [1.0.0] - 2024-05-28
 
-- Upgrade Python `requests` package to version 2.32.3 in requirements.txt
-- Bug fix for launch failure of EfsCleanupContainerStop Lambda function
+### Added
 
-## [1.1.0] - 2024-10-31
-- Upgrade to Prebid Server v3.13 and underlying Docker base image
-- ECS runtime logs in AWS CloudWatch instead of S3
-- Option to opt-out of installing CloudFront and WAF
-- Customize Prebid Server configuration through files in S3
-- Option to specify a custom container image 
+- All files, initial version

CODE_OF_CONDUCT.md

@@ -1,4 +1,4 @@
 ## Code of Conduct
-This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct). 
-For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact 
+This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
+For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
 [email protected] with any additional questions or comments.

NOTICE.txt

@@ -10,78 +10,74 @@ specific language governing permissions and limitations under the License.
 **********************
 THIRD PARTY COMPONENTS
 **********************
+
 This software includes third party software subject to the following copyrights:
 
- Name                                             Version    License
- prebid-server-java                               3.13.0     Apache-2.0
- attrs                                            22.1.0     MIT License
- avro                                             1.11.1     Apache Software License
- aws-cdk-lib                                      2.140.0    Apache-2.0
- aws-cdk.asset-awscli-v1                          2.2.11     Apache-2.0
- aws-cdk.asset-kubectl-v20                        2.1.1      Apache-2.0
- aws-cdk.asset-node-proxy-agent-v5                2.0.17     Apache-2.0
- aws-lambda                                       0.2.0      Apache Software License
- aws-lambda-powertools                            1.31.0     MIT License; Other/Proprietary License
- aws-solutions-cdk                                2.0.0      Apache Software License
- aws-solutions-constructs.aws-eventbridge-lambda  2.25.0     Apache-2.0
- aws-solutions-constructs.aws-lambda-dynamodb     2.25.0     Apache-2.0
- aws-solutions-constructs.aws-lambda-sns          2.25.0     Apache-2.0
- aws-solutions-constructs.core                    2.25.0     Apache-2.0
- aws-solutions-python                             2.0.0      Apache Software License
- aws-xray-sdk                                     2.11.0     Apache Software License
- boto3                                            1.26.12    Apache Software License
- botocore                                         1.29.12    Apache Software License
- cattrs                                           22.2.0     MIT License
- cdk-nag                                          2.18.47    Apache-2.0
- certifi                                          2022.9.24  Mozilla Public License 2.0 (MPL 2.0)
- cffi                                             1.15.1     MIT License
- charset-normalizer                               2.0.12     MIT License
- click                                            8.1.3      BSD License
- constructs                                       10.1.163   Apache-2.0
- coverage                                         6.5.0      Apache Software License
- crhelper                                         2.0.11     Apache Software License
- cronex                                           0.1.3.1    MIT License
- cryptography                                     38.0.3     Apache Software License; BSD License
- docker                                           6.0.0      Apache Software License
- exceptiongroup                                   1.0.4      MIT License
- fastjsonschema                                   2.16.2     BSD License
- idna                                             3.4        BSD License
- infrastructure                                   1.0.0      Apache Software License
- iniconfig                                        1.1.1      MIT License
- Jinja2                                           3.1.2      BSD License
- jmespath                                         1.0.1      MIT License
- jsii                                             1.71.0     Apache Software License
- MarkupSafe                                       2.1.1      BSD License
- moto                                             4.0.3      Apache Software License
- mypy-extensions                                  0.4.3      MIT License
- packaging                                        21.3       Apache Software License; BSD License
- parsedatetime                                    2.6        Apache Software License
- pathspec                                         0.10.2     Mozilla Public License 2.0 (MPL 2.0)
- platformdirs                                     2.5.4      MIT License
- pluggy                                           1.0.0      MIT License
- publication                                      0.0.3      MIT License
- pycparser                                        2.21       BSD License
- pyparsing                                        3.0.9      MIT License
- pytest                                           7.2.0      MIT License
- pytest-cov                                       4.0.0      MIT License
- pytest-env                                       0.8.1      MIT License
- pytest-mock                                      3.10.0     MIT License
- python-dateutil                                  2.8.2      Apache Software License; BSD License
- pytz                                             2022.6     MIT License
- PyYAML                                           6.0.2      MIT License
- requests                                         2.32.3     Apache Software License
- responses                                        0.17.0     Apache 2.0
- s3transfer                                       0.6.0      Apache Software License
- shared                                           0.0.0      Apache Software License
- six                                              1.16.0     MIT License
- tenacity                                         8.1.0      Apache Software License
- tomli                                            2.0.1      MIT License
- typeguard                                        2.13.3     MIT License
- typing_extensions                                4.4.0      Python Software Foundation License
- urllib3                                          1.26.12    MIT License
- websocket-client                                 1.4.2      Apache Software License
- wrapt                                            1.14.1     BSD License
- xmltodict                                        0.13.0     MIT License
- wheel                                            0.38.4     MIT License
- Werkzeug                                         2.1.2      BSD License
- 
+alpinelinux/docker-alpine under the MIT license.
+github.com/prebid/prebid-server-java under the Apache-2.0 license.
+aws-cdk-asset-awscli-v1 under the Apache-2.0 license.
+aws-cdk-asset-kubectl-v20 under the Apache-2.0 license.
+aws-cdk-asset-node-proxy-agent-v6 under the Apache-2.0 license.
+aws-cdk-cloud-assembly-schema under the Apache-2.0 license.
+aws-cdk-lib under the Apache-2.0 license.
+aws-lambda-powertools under the MIT license.
+aws-solutions-cdk under the Apache-2.0 license.
+aws-solutions-python under the Apache-2.0 license.
+boto3 under the Apache-2.0 license.
+botocore under the Apache-2.0 license.
+cattrs under the MIT license.
+cdk-nag under the Apache-2.0 license.
+certifi under the MPL-2.0 license.
+cffi under the MIT license.
+charset-normalizer under the MIT license.
+click under the 0BSD license.
+colorama under the 0BSD license.
+constructs under the Apache-2.0 license.
+coverage under the Apache-2.0 license.
+crhelper under the Apache-2.0 license.
+cryptography under the Apache-2.0 license.
+docker under the Apache-2.0 license.
+idna under the 0BSD license.
+importlib-resources under the Apache-2.0 license.
+infrastructure under the MIT license.
+iniconfig under the MIT license.
+jinja2 under the 0BSD license.
+jmespath under the MIT license.
+jsii under the Apache-2.0 license.
+markupsafe under the 0BSD license.
+moto under the Apache-2.0 license.
+packaging under the Apache-2.0 license.
+pip under the MIT license.
+pluggy under the MIT license.
+publication under the MIT license.
+pycparser under the 0BSD license.
+pyparsing under the MIT license.
+pytest under the MIT license.
+pytest-cov under the MIT license.
+pytest-env under the MIT license.
+pytest-mock under the MIT license.
+pytest-ordering under the MIT license.
+python-dateutil under the Apache-2.0 license.
+pywin32 under the PSF-2.0 license.
+pyyaml under the MIT license.
+requests under the Apache-2.0 license.
+responses under the Apache-2.0 license.
+s3transfer under the Apache-2.0 license.
+six under the MIT license.
+typeguard under the MIT license.
+typing-extensions under the PSF-2.0 license.
+unit-tests under the Apache-2.0 license.
+url-normalize under the MIT license.
+urllib3 under the MIT license.
+werkzeug under the 0BSD license.
+xmltodict under the MIT license.
+
+********************
+OPEN SOURCE LICENSES
+********************
+
+0BSD - http://landley.net/toybox/license.html
+Apache-2.0 - https://www.apache.org/licenses/LICENSE-2.0
+PSF-2.0 - https://opensource.org/licenses/Python-2.0
+MIT - https://opensource.org/license/mit
+MPL-2.0 - https://www.mozilla.org/en-US/MPL/2.0/

README.md

@@ -33,25 +33,30 @@ The following procedures assumes that all the OS-level configuration has been co
 
 * [AWS Command Line Interface](https://aws.amazon.com/cli/)
 * [Python](https://www.python.org/) 3.11 or newer
+* [Pypi/Pip](https://pypi.org/project/pip/) 25.0 or newer
+* [Poetry](https://python-poetry.org/docs/#installing-with-pipx) 2.0 or newer
 * [Node.js](https://nodejs.org/en/) 16.x or newer 
 * [AWS CDK](https://aws.amazon.com/cdk/) 2.140.0 or newer 
-* [Amazon Corretto OpenJDK](https://docs.aws.amazon.com/corretto/) 17
+* [Amazon Corretto OpenJDK](https://docs.aws.amazon.com/corretto/) 21
+* [Apache Maven](https://maven.apache.org/) 3.9.9
 * [Docker](https://docs.docker.com/engine/)
 * [AWS access key ID and secret access key](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html) configured in your environment with AdministratorAccess equivalent permissions
 
 > **Please ensure you test the templates before updating any production deployments.**
 
 ### 1. Download or clone this repo
 ```
-git clone https://github.com/aws-solutions/prebid-server-deployment-on-aws
+git clone https://github.com/aws-solutions/prebid-server-deployment-on-aws.git
 ```
 
 ### 2. Create a Python virtual environment for development 
 ```bash 
+cd prebid-server-deployment-on-aws
 python3 -m venv .venv 
 source ./.venv/bin/activate 
 cd ./source 
-pip install -r requirements.txt
+pip install -r requirements-poetry.txt
+poetry install
 ```
 
 ### 2. After introducing changes, run the unit tests to make sure the customizations don't break existing functionality
@@ -168,7 +173,7 @@ If you'd like to use a different container:
 * Build and host the solution assets for installation in your account using the process described above
 * Change to the `deployment/global-s3-assets` folder on the build workstation
 * Open the file `prebid-server-deployment-on-aws.template` in an editor
-* Find the line in the template under the Task Definition resource that is `"Image": "public.ecr.aws/aws-solutions/prebid-server:v1.1.0",`
+* Find the line in the template under the Task Definition resource that is `"Image": "public.ecr.aws/aws-solutions/prebid-server:v1.1.1",`
 * Update the Image property value with your container image URI
 * Create the stack by uploading the changed template to the CloudFormation console
 

deployment/build-s3-dist.sh

@@ -9,7 +9,7 @@
 # Paramenters:
 #  - source-bucket-base-name: Name for the S3 bucket location where the template will source the Lambda
 #    code from. The template will append '-[region_name]' to this bucket name.
-#    For example: ./build-s3-dist.sh solutions v1.1.0
+#    For example: ./build-s3-dist.sh solutions v1.1.1
 #    The template will then expect the source code to be located in the solutions-[region_name] bucket
 #
 #  - solution-name: name of the solution for consistency
@@ -21,7 +21,7 @@
 # Check to see if input has been provided:
 if [ -z "$1" ] || [ -z "$2" ] || [ -z "$3" ]; then
     echo "Please provide the base source bucket name, trademark approved solution name and version where the lambda code will eventually reside."
-    echo "For example: ./build-s3-dist.sh solutions trademarked-solution-name v1.1.0"
+    echo "For example: ./build-s3-dist.sh solutions trademarked-solution-name v1.1.1"
     exit 1
 fi
 
@@ -57,7 +57,7 @@ rm -rf $cdk_out
 # cp $template_dir/*.yaml $template_dist_dir/
 # cd $template_dist_dir
 # # Rename all *.yaml to *.template
-# for f in *.yaml; do 
+# for f in *.yaml; do
 #     mv -- "$f" "${f%.yaml}.template"
 # done
 
@@ -107,3 +107,30 @@ fi
 # generate the templates (unbundled)
 cd $source_dir/
 cdk synth -o $cdk_out
+
+# If this is a release pipeline and the ecr_image_tags.json file references a
+# version that is different from the $VERSION environment variable then
+# exit with an error to stop the pipeline. This is intended to help prevent
+# accidentally overwriting a prebid-server image that has already been
+# published to the aws-solutions public repo. This can happen if a developer
+# has forgotten to update ecr_image_tags.json and it still refers to a
+# previously published version.
+if [ "${PIPELINE_TYPE:-}" = "release" ]; then
+  # The ${PIPELINE_TYPE:-} syntax provides a safe way to reference potentially
+  # undefined variables, defaulting to an empty string if the variable isn't
+  # set.
+  echo "This is a Release pipeline"
+  echo "------------------------------------------------------------------------------"
+  echo "[Validation] Check docker image tag prior to publishing to Amazon ECR"
+  echo "------------------------------------------------------------------------------"
+  TAGS_JSON_FILE="$template_dir/ecr_image_tags.json"
+  TAGS_JSON_FILE_EXISTS=$( [ -e $TAGS_JSON_FILE ] && echo true || echo false )
+  if [ TAGS_JSON_FILE_EXISTS ]; then
+      echo "Checking if version in ecr_image_tags.json matches $VERSION"
+      CUSTOM_TAG=$(jq -r --arg key "$IMAGE" '.[$key]' $TAGS_JSON_FILE)
+      if [ "$CUSTOM_TAG" != "$VERSION" ]; then
+          echo "ecr_image_tags.json version does not match $VERSION"
+          exit 1
+      fi
+  fi
+fi