Déployer des fonctions Lambda en Node.js avec des images conteneurs

Pour créer une image de conteneur à partir d'une image AWS de base pour Node.js

1. Créez un répertoire pour le projet, puis passez à ce répertoire.

   mkdir example
   cd example

2. Créez un nouveau projet Node.js avec npm. Appuyez sur Enter pour accepter les options par défaut fournies dans l’expérience interactive.

   npm init

3. Créez un nouveau fichier appelé index.js. Vous pouvez ajouter l’exemple de code de fonction suivant au fichier pour le tester, ou utiliser le vôtre.

   Exemple Gestionnaire CommonJS

   exports.handler = async (event) => {
       const response = {
           statusCode: 200,
           body: JSON.stringify('Hello from Lambda!'),
       };
       return response;
   };

4. Si votre fonction dépend de bibliothèques autres que celles-ci AWS SDK pour JavaScript, utilisez npm pour les ajouter à votre package.

5. Créez un nouveau Dockerfile avec la configuration suivante :

   • Définir la propriété FROM sur l’URI de l’image de base.

   • Utilisez la commande COPY pour copier le code de la fonction et les dépendances de l’environnement d’exécution dans {LAMBDA_TASK_ROOT}, une variable d’environnement définie par Lambda.

   • Définir l’argument CMD pour le gestionnaire de la fonction Lambda.

   Notez que l’exemple de Dockerfile n’inclut pas d’instruction USER. Lorsque vous déployez une image de conteneur sur Lambda, Lambda définit automatiquement un utilisateur Linux par défaut disposant d’autorisations de moindre privilège. Ceci est différent du comportement standard de Docker qui est défini par défaut par l’utilisateur root lorsqu’aucune instruction USER n’est fournie.

   Exemple Dockerfile

   FROM public.ecr.aws/lambda/nodejs:22
   
   # Copy function code
   COPY index.js ${LAMBDA_TASK_ROOT}
     
   # Set the CMD to your handler (could also be done as a parameter override outside of the Dockerfile)
   CMD [ "index.handler" ]

6. Générez l’image Docker à l’aide de la commande docker build. L’exemple suivant nomme l’image docker-image et lui donne la balise test. Pour rendre votre image compatible avec Lambda, vous devez utiliser l'--provenance=falseoption.

   docker buildx build --platform linux/amd64 --provenance=false -t docker-image:test .

   Note

   La commande spécifie l’option --platform linux/amd64 pour garantir la compatibilité de votre conteneur avec l’environnement d’exécution Lambda, quelle que soit l’architecture de votre machine de génération. Si vous avez l'intention de créer une fonction Lambda à l'aide de l'architecture du jeu ARM64 d'instructions, veillez à modifier la commande pour utiliser l'--platform linux/arm64option à la place.

1. Démarrez votre image Docker à l’aide de la commande docker run. Dans cet exemple, docker-image est le nom de l’image et test est la balise.

   docker run --platform linux/amd64 -p 9000:8080 docker-image:test

   Cette commande exécute l’image en tant que conteneur et crée un point de terminaison local à localhost:9000/2015-03-31/functions/function/invocations.

   Note

   Si vous avez créé l'image Docker pour l'architecture du jeu ARM64 d'instructions, veillez à utiliser l'--platform linux/arm64option au lieu de--platform linux/amd64.

2. À partir d’une nouvelle fenêtre de terminal, publiez un événement au point de terminaison local.

   Linux/macOS

   Sous Linux et macOS, exécutez la commande curl suivante :

   curl "http://localhost:9000/2015-03-31/functions/function/invocations" -d '{}'

   Cette commande invoque la fonction avec un événement vide et renvoie une réponse. Si vous utilisez votre propre code de fonction plutôt que l’exemple de code de fonction, vous pouvez invoquer la fonction avec une charge utile JSON. Exemple :

   curl "http://localhost:9000/2015-03-31/functions/function/invocations" -d '{"payload":"hello world!"}'

   PowerShell

   Dans PowerShell, exécutez la Invoke-WebRequest commande suivante :

   Invoke-WebRequest -Uri "http://localhost:9000/2015-03-31/functions/function/invocations" -Method Post -Body '{}' -ContentType "application/json"

   Cette commande invoque la fonction avec un événement vide et renvoie une réponse. Si vous utilisez votre propre code de fonction plutôt que l’exemple de code de fonction, vous pouvez invoquer la fonction avec une charge utile JSON. Exemple :

   Invoke-WebRequest -Uri "http://localhost:9000/2015-03-31/functions/function/invocations" -Method Post -Body '{"payload":"hello world!"}' -ContentType "application/json"

3. Obtenez l’ID du conteneur.

   docker ps

4. Utilisez la commande docker kill pour arrêter le conteneur. Dans cette commande, remplacez 3766c4ab331c par l’ID du conteneur de l’étape précédente.

   docker kill 3766c4ab331c

Pour charger l’image sur Amazon RIE et créer la fonction Lambda

1. Exécutez la get-login-passwordcommande pour authentifier la CLI Docker auprès de votre registre Amazon ECR.

   • Définissez la --region valeur à l' Région AWS endroit où vous souhaitez créer le référentiel Amazon ECR.

   • 111122223333Remplacez-le par votre Compte AWS identifiant.

   aws ecr get-login-password --region us-east-1 | docker login --username AWS --password-stdin 111122223333.dkr.ecr.us-east-1.amazonaws.com

2. Créez un référentiel dans Amazon ECR à l’aide de la commande create-repository.

   aws ecr create-repository --repository-name hello-world --region us-east-1 --image-scanning-configuration scanOnPush=true --image-tag-mutability MUTABLE

   Note

   Le référentiel Amazon ECR doit être Région AWS identique à la fonction Lambda.

   En cas de succès, vous obtenez une réponse comme celle-ci :

   {
       "repository": {
           "repositoryArn": "arn:aws:ecr:us-east-1:111122223333:repository/hello-world",
           "registryId": "111122223333",
           "repositoryName": "hello-world",
           "repositoryUri": "111122223333.dkr.ecr.us-east-1.amazonaws.com/hello-world",
           "createdAt": "2023-03-09T10:39:01+00:00",
           "imageTagMutability": "MUTABLE",
           "imageScanningConfiguration": {
               "scanOnPush": true
           },
           "encryptionConfiguration": {
               "encryptionType": "AES256"
           }
       }
   }

3. Copiez le repositoryUri à partir de la sortie de l’étape précédente.

4. Exécutez la commande docker tag pour étiqueter votre image locale dans votre référentiel Amazon ECR en tant que dernière version. Dans cette commande :

   • docker-image:test est le nom et la balise de votre image Docker. Il s’agit du nom et de la balise de l’image que vous avez spécifiés dans la commande docker build.

   • Remplacez <ECRrepositoryUri> par l’repositoryUri que vous avez copié. Assurez-vous d’inclure :latest à la fin de l’URI.

   docker tag docker-image:test <ECRrepositoryUri>:latest

   Exemple :

   docker tag docker-image:test 111122223333.dkr.ecr.us-east-1.amazonaws.com/hello-world:latest

5. Exécutez la commande docker push pour déployer votre image locale dans le référentiel Amazon ECR. Assurez-vous d’inclure :latest à la fin de l’URI du référentiel.

   docker push 111122223333.dkr.ecr.us-east-1.amazonaws.com/hello-world:latest

6. Créez un rôle d’exécution pour la fonction, si vous n’en avez pas déjà un. Vous aurez besoin de l’Amazon Resource Name (ARN) du rôle à l’étape suivante.

7. Créez la fonction Lambda. Pour ImageUri, indiquez l’URI du référentiel mentionné précédemment. Assurez-vous d’inclure :latest à la fin de l’URI.

   aws lambda create-function \
     --function-name hello-world \
     --package-type Image \
     --code ImageUri=111122223333.dkr.ecr.us-east-1.amazonaws.com/hello-world:latest \
     --role arn:aws:iam::111122223333:role/lambda-ex

   Note

   Vous pouvez créer une fonction en utilisant une image d'un autre AWS compte, à condition que l'image se trouve dans la même région que la fonction Lambda. Pour de plus amples informations, veuillez consulter Autorisations entre comptes Amazon ECR.

8. Invoquer la fonction.

   aws lambda invoke --function-name hello-world response.json

   Vous devriez obtenir une réponse comme celle-ci :

   {
     "ExecutedVersion": "$LATEST", 
     "StatusCode": 200
   }

9. Pour voir la sortie de la fonction, consultez le fichier response.json.

Pour créer une image de conteneur à partir d'une image non AWS basique

1. Créez un répertoire pour le projet, puis passez à ce répertoire.

   mkdir example
   cd example

2. Créez un nouveau projet Node.js avec npm. Appuyez sur Enter pour accepter les options par défaut fournies dans l’expérience interactive.

   npm init

3. Créez un nouveau fichier appelé index.js. Vous pouvez ajouter l’exemple de code de fonction suivant au fichier pour le tester, ou utiliser le vôtre.

   Exemple Gestionnaire CommonJS

   exports.handler = async (event) => {
       const response = {
           statusCode: 200,
           body: JSON.stringify('Hello from Lambda!'),
       };
       return response;
   };

4. Créez un nouveau fichier Docker. Le Dockerfile suivant utilise une image de base bookworm au lieu d’une image de base AWS. Le Dockerfile inclut le client d’interface d’exécution, ce qui rend l’image compatible avec Lambda. Le Dockerfile utilise une création à plusieurs étapes. La première étape crée une image de génération, qui est un environnement Node.js standard dans lequel les dépendances de la fonction sont installées. La deuxième étape crée une image plus fine qui inclut le code de la fonction et ses dépendances. Cela permet de réduire la taille de l’image finale.

   • Définissez la propriété FROM pour l’identifiant de l’image de base.

   • Utilisez la commande COPY pour copier le code de la fonction et les dépendances de l’exécution.

   • Définissez le ENTRYPOINT sur le module que vous souhaitez que le conteneur Docker exécute lorsqu’il démarre. Dans ce cas, le module est le client d’interface d’exécution.

   • Définir l’argument CMD pour le gestionnaire de la fonction Lambda.

   Notez que l’exemple de Dockerfile n’inclut pas d’instruction USER. Lorsque vous déployez une image de conteneur sur Lambda, Lambda définit automatiquement un utilisateur Linux par défaut disposant d’autorisations de moindre privilège. Ceci est différent du comportement standard de Docker qui est défini par défaut par l’utilisateur root lorsqu’aucune instruction USER n’est fournie.

   Exemple Dockerfile

   # Define custom function directory
   ARG FUNCTION_DIR="/function"
   
   FROM node:20-bookworm as build-image
   
   # Include global arg in this stage of the build
   ARG FUNCTION_DIR
   
   # Install build dependencies
   RUN apt-get update && \
       apt-get install -y \
       g++ \
       make \
       cmake \
       unzip \
       libcurl4-openssl-dev
   
   # Copy function code
   RUN mkdir -p ${FUNCTION_DIR}
   COPY . ${FUNCTION_DIR}
   
   WORKDIR ${FUNCTION_DIR}
   
   # Install Node.js dependencies
   RUN npm install
   
   # Install the runtime interface client
   RUN npm install aws-lambda-ric
   
   # Grab a fresh slim copy of the image to reduce the final size
   FROM node:20-bookworm-slim
   
   # Required for Node runtimes which use npm@8.6.0+ because
   # by default npm writes logs under /home/.npm and Lambda fs is read-only
   ENV NPM_CONFIG_CACHE=/tmp/.npm
   
   # Include global arg in this stage of the build
   ARG FUNCTION_DIR
   
   # Set working directory to function root directory
   WORKDIR ${FUNCTION_DIR}
   
   # Copy in the built dependencies
   COPY --from=build-image ${FUNCTION_DIR} ${FUNCTION_DIR}
   
   # Set runtime interface client as default command for the container runtime
   ENTRYPOINT ["/usr/local/bin/npx", "aws-lambda-ric"]
   # Pass the name of the function handler as an argument to the runtime
   CMD ["index.handler"]

5. Générez l’image Docker à l’aide de la commande docker build. L’exemple suivant nomme l’image docker-image et lui donne la balise test. Pour rendre votre image compatible avec Lambda, vous devez utiliser l'--provenance=falseoption.

   docker buildx build --platform linux/amd64 --provenance=false -t docker-image:test .

   Note

   La commande spécifie l’option --platform linux/amd64 pour garantir la compatibilité de votre conteneur avec l’environnement d’exécution Lambda, quelle que soit l’architecture de votre machine de génération. Si vous avez l'intention de créer une fonction Lambda à l'aide de l'architecture du jeu ARM64 d'instructions, veillez à modifier la commande pour utiliser l'--platform linux/arm64option à la place.

Pour installer et exécuter l’émulateur d’interface d’exécution sur votre ordinateur local

1. Depuis le répertoire de votre projet, exécutez la commande suivante pour télécharger l'émulateur d'interface d'exécution (architecture x86-64) GitHub et l'installer sur votre machine locale.

   Linux/macOS

   mkdir -p ~/.aws-lambda-rie && \
       curl -Lo ~/.aws-lambda-rie/aws-lambda-rie https://github.com/aws/aws-lambda-runtime-interface-emulator/releases/latest/download/aws-lambda-rie && \
       chmod +x ~/.aws-lambda-rie/aws-lambda-rie

   Pour installer l'émulateur arm64, remplacez l'URL du GitHub référentiel dans la commande précédente par la suivante :

   https://github.com/aws/aws-lambda-runtime-interface-emulator/releases/latest/download/aws-lambda-rie-arm64

   PowerShell

   $dirPath = "$HOME\.aws-lambda-rie"
   if (-not (Test-Path $dirPath)) {
       New-Item -Path $dirPath -ItemType Directory
   }
         
   $downloadLink = "https://github.com/aws/aws-lambda-runtime-interface-emulator/releases/latest/download/aws-lambda-rie"
   $destinationPath = "$HOME\.aws-lambda-rie\aws-lambda-rie"
   Invoke-WebRequest -Uri $downloadLink -OutFile $destinationPath

   Pour installer l’émulateur arm64, remplacez $downloadLink par ce qui suit :

   https://github.com/aws/aws-lambda-runtime-interface-emulator/releases/latest/download/aws-lambda-rie-arm64

2. Démarrez votre image Docker à l’aide de la commande docker run. Remarques :

   • docker-image est le nom de l’image et test est la balise.

   • /usr/local/bin/npx aws-lambda-ric index.handler est le ENTRYPOINT suivi du CMD depuis votre Dockerfile.

   Linux/macOS

   docker run --platform linux/amd64 -d -v ~/.aws-lambda-rie:/aws-lambda -p 9000:8080 \
       --entrypoint /aws-lambda/aws-lambda-rie \
       docker-image:test \
           /usr/local/bin/npx aws-lambda-ric index.handler

   PowerShell

   docker run --platform linux/amd64 -d -v "$HOME\.aws-lambda-rie:/aws-lambda" -p 9000:8080 `
   --entrypoint /aws-lambda/aws-lambda-rie `
   docker-image:test `
       /usr/local/bin/npx aws-lambda-ric index.handler

   Cette commande exécute l’image en tant que conteneur et crée un point de terminaison local à localhost:9000/2015-03-31/functions/function/invocations.

   Note

   Si vous avez créé l'image Docker pour l'architecture du jeu ARM64 d'instructions, veillez à utiliser l'--platform linux/arm64option au lieu de--platform linux/amd64.

3. Publiez un événement au point de terminaison local.

   Linux/macOS

   Sous Linux et macOS, exécutez la commande curl suivante :

   curl "http://localhost:9000/2015-03-31/functions/function/invocations" -d '{}'

   Cette commande invoque la fonction avec un événement vide et renvoie une réponse. Si vous utilisez votre propre code de fonction plutôt que l’exemple de code de fonction, vous pouvez invoquer la fonction avec une charge utile JSON. Exemple :

   curl "http://localhost:9000/2015-03-31/functions/function/invocations" -d '{"payload":"hello world!"}'

   PowerShell

   Dans PowerShell, exécutez la Invoke-WebRequest commande suivante :

   Invoke-WebRequest -Uri "http://localhost:9000/2015-03-31/functions/function/invocations" -Method Post -Body '{}' -ContentType "application/json"

   Cette commande invoque la fonction avec un événement vide et renvoie une réponse. Si vous utilisez votre propre code de fonction plutôt que l’exemple de code de fonction, vous pouvez invoquer la fonction avec une charge utile JSON. Exemple :

   Invoke-WebRequest -Uri "http://localhost:9000/2015-03-31/functions/function/invocations" -Method Post -Body '{"payload":"hello world!"}' -ContentType "application/json"

4. Obtenez l’ID du conteneur.

   docker ps

5. Utilisez la commande docker kill pour arrêter le conteneur. Dans cette commande, remplacez 3766c4ab331c par l’ID du conteneur de l’étape précédente.

   docker kill 3766c4ab331c

Pour charger l’image sur Amazon RIE et créer la fonction Lambda

1. Exécutez la get-login-passwordcommande pour authentifier la CLI Docker auprès de votre registre Amazon ECR.

   • Définissez la --region valeur à l' Région AWS endroit où vous souhaitez créer le référentiel Amazon ECR.

   • 111122223333Remplacez-le par votre Compte AWS identifiant.

   aws ecr get-login-password --region us-east-1 | docker login --username AWS --password-stdin 111122223333.dkr.ecr.us-east-1.amazonaws.com

2. Créez un référentiel dans Amazon ECR à l’aide de la commande create-repository.

   aws ecr create-repository --repository-name hello-world --region us-east-1 --image-scanning-configuration scanOnPush=true --image-tag-mutability MUTABLE

   Note

   Le référentiel Amazon ECR doit être Région AWS identique à la fonction Lambda.

   En cas de succès, vous obtenez une réponse comme celle-ci :

   {
       "repository": {
           "repositoryArn": "arn:aws:ecr:us-east-1:111122223333:repository/hello-world",
           "registryId": "111122223333",
           "repositoryName": "hello-world",
           "repositoryUri": "111122223333.dkr.ecr.us-east-1.amazonaws.com/hello-world",
           "createdAt": "2023-03-09T10:39:01+00:00",
           "imageTagMutability": "MUTABLE",
           "imageScanningConfiguration": {
               "scanOnPush": true
           },
           "encryptionConfiguration": {
               "encryptionType": "AES256"
           }
       }
   }

3. Copiez le repositoryUri à partir de la sortie de l’étape précédente.

4. Exécutez la commande docker tag pour étiqueter votre image locale dans votre référentiel Amazon ECR en tant que dernière version. Dans cette commande :

   • docker-image:test est le nom et la balise de votre image Docker. Il s’agit du nom et de la balise de l’image que vous avez spécifiés dans la commande docker build.

   • Remplacez <ECRrepositoryUri> par l’repositoryUri que vous avez copié. Assurez-vous d’inclure :latest à la fin de l’URI.

   docker tag docker-image:test <ECRrepositoryUri>:latest

   Exemple :

   docker tag docker-image:test 111122223333.dkr.ecr.us-east-1.amazonaws.com/hello-world:latest

5. Exécutez la commande docker push pour déployer votre image locale dans le référentiel Amazon ECR. Assurez-vous d’inclure :latest à la fin de l’URI du référentiel.

   docker push 111122223333.dkr.ecr.us-east-1.amazonaws.com/hello-world:latest

6. Créez un rôle d’exécution pour la fonction, si vous n’en avez pas déjà un. Vous aurez besoin de l’Amazon Resource Name (ARN) du rôle à l’étape suivante.

7. Créez la fonction Lambda. Pour ImageUri, indiquez l’URI du référentiel mentionné précédemment. Assurez-vous d’inclure :latest à la fin de l’URI.

   aws lambda create-function \
     --function-name hello-world \
     --package-type Image \
     --code ImageUri=111122223333.dkr.ecr.us-east-1.amazonaws.com/hello-world:latest \
     --role arn:aws:iam::111122223333:role/lambda-ex

   Note

   Vous pouvez créer une fonction en utilisant une image d'un autre AWS compte, à condition que l'image se trouve dans la même région que la fonction Lambda. Pour de plus amples informations, veuillez consulter Autorisations entre comptes Amazon ECR.

8. Invoquer la fonction.

   aws lambda invoke --function-name hello-world response.json

   Vous devriez obtenir une réponse comme celle-ci :

   {
     "ExecutedVersion": "$LATEST", 
     "StatusCode": 200
   }

9. Pour voir la sortie de la fonction, consultez le fichier response.json.