Skip to content

Include an optional SAM config file when deploying #946

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Include an optional SAM config file when deploying #946

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
155556a
Update to include an optional SAM config file when deploying and spli…
stephen-cox-nzx Aug 11, 2025
01851fd
Added documentation on the config-file option
stephen-cox-nzx Aug 11, 2025
2d7a47f
Updated change log
stephen-cox-nzx Aug 11, 2025
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
5 changes: 5 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
### v1.20.2 - 2025/08/12
##### Docs
* added documentation on a new argumnet to the publish_lambdas.sh
##### Features
* Added a new command line argument to the publish_lambdas.sh to enable use of the --config-file option to support creating tags when deploying sam directly
### v1.20.1 - 2025/05/23
##### Docs
* Fix 404 link in README-AWS.md [903](https://github.com/elastic/elastic-serverless-forwarder/pull/903)
Expand Down
1 change: 1 addition & 0 deletions docs/reference/aws-deploy-elastic-serverless-forwarder.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -586,6 +586,7 @@ Usage: ./publish_lambda.sh config-path lambda-name forwarder-tag bucket-name reg
region: region where to publish in
custom-role-prefix: role/policy prefix to add in case customization is needed (optional)
(please note that the prefix will be added to both role/policy naming)
config-file: path to a SAM configuration file (optional)
```


Expand Down
35 changes: 32 additions & 3 deletions publish_lambda.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ set -e
echo " AWS CLI (https://aws.amazon.com/cli/), SAM (https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/install-sam-cli.html), Docker and Python3.12 with pip3 required"
echo " Please, before launching the tool execute \"$ pip3 install ruamel.yaml\""

if [ $# -lt 5 ] || [ $# -gt 6 ]
if [ $# -lt 5 ] || [ $# -gt 7 ]
then
echo "Usage: $0 config-path lambda-name forwarder-tag bucket-name region [custom-role-prefix]"
echo " Arguments:"
Expand All @@ -21,6 +21,7 @@ then
echo " region: region where to publish in"
echo " custom-role-prefix: role/policy prefix to add in case customization is needed (optional)"
echo " (please note that the prefix will be added to both role/policy names)"
echo " config-file: path to the SAM configuration file (optional)"

exit 1
fi
Expand All @@ -31,6 +32,7 @@ TAG_NAME="$3"
BUCKET="$4"
REGION="$5"
CUSTOM_ROLE_PREFIX="${6:-}" ## Default value would be of '' will be passed if this variable is NOT set.
EXPORTER_SAMCONFIG_FILE="${7:-}" ## Default value would be of '' will be passed if this variable is NOT set.

TMPDIR=$(mktemp -d /tmp/publish.XXXXXXXXXX)
CLONED_FOLDER="${TMPDIR}/sources"
Expand Down Expand Up @@ -529,6 +531,33 @@ EOF
sed -e "s|%codeUri%|${PACKAGE_FOLDER}|g" "${TMPDIR}/publish-before-sed.yaml" > "${TMPDIR}/publish.yaml"
python "${TMPDIR}/publish.py" "${PUBLISH_CONFIG}" "${TMPDIR}/publish.yaml"

if [ -n "${EXPORTER_SAMCONFIG_FILE}" ]; then
# copy in the SAM config file if it was specified on the command line
cp "${EXPORTER_SAMCONFIG_FILE}" "${TMPDIR}/"
fi

sam build --debug --use-container --build-dir "${TMPDIR}/.aws-sam/build/publish" --template-file "${TMPDIR}/publish.yaml" --region "${REGION}"
sam package --template-file "${TMPDIR}/.aws-sam/build/publish/template.yaml" --output-template-file "${TMPDIR}/.aws-sam/build/publish/packaged.yaml" --s3-bucket "${BUCKET}" --region "${REGION}"
sam deploy --stack-name "${LAMBDA_NAME}" --capabilities CAPABILITY_NAMED_IAM --template "${TMPDIR}/.aws-sam/build/publish/packaged.yaml" --s3-bucket "${BUCKET}" --region "${REGION}"
sam package --force-upload --template-file "${TMPDIR}/.aws-sam/build/publish/template.yaml" --output-template-file "${TMPDIR}/.aws-sam/build/publish/packaged.yaml" --s3-bucket "${BUCKET}" --region "${REGION}"
SAM_DEPLOY_CMD="sam deploy"
SAM_DEPLOY_CMD="${SAM_DEPLOY_CMD} --stack-name \"${LAMBDA_NAME}\""
SAM_DEPLOY_CMD="${SAM_DEPLOY_CMD} --capabilities CAPABILITY_NAMED_IAM"
SAM_DEPLOY_CMD="${SAM_DEPLOY_CMD} --template \"${TMPDIR}/.aws-sam/build/publish/packaged.yaml\""
SAM_DEPLOY_CMD="${SAM_DEPLOY_CMD} --s3-bucket \"${BUCKET}\""
SAM_DEPLOY_CMD="${SAM_DEPLOY_CMD} --region \"${REGION}\""
# Comment or uncomment either of the following two lines to support interactive or headless execution mode
# This could be controlled by another optional script argument
#SAM_DEPLOY_CMD="${SAM_DEPLOY_CMD} --confirm-changeset"
SAM_DEPLOY_CMD="${SAM_DEPLOY_CMD} --no-confirm-changeset"
# For CI/CD if there is no change it may not be an error
SAM_DEPLOY_CMD="${SAM_DEPLOY_CMD} --no-fail-on-empty-changeset"
SAM_DEPLOY_CMD="${SAM_DEPLOY_CMD} --parameter-overrides \"ParameterKey=CUSTOM_ROLE_PREFIX,ParameterValue=${CUSTOM_ROLE_PREFIX}\""
SAM_DEPLOY_CMD="${SAM_DEPLOY_CMD} --s3-prefix \"${LAMBDA_NAME}/\""
SAM_DEPLOY_CMD="${SAM_DEPLOY_CMD} --no-fail-on-empty-changeset"
# Force upload the artifacts to S3 bucket
# This is useful when the same stack is deployed multiple times via CI/CD pipelines
SAM_DEPLOY_CMD="${SAM_DEPLOY_CMD} --force-upload"
if [ -n "${EXPORTER_SAMCONFIG_FILE}" ]; then
SAM_DEPLOY_CMD="${SAM_DEPLOY_CMD} --config-file \"${EXPORTER_SAMCONFIG_FILE}\""
fi

eval "${SAM_DEPLOY_CMD}"