Déploiement de fonctions Lambda en Ruby avec des images conteneurs - AWS Lambda

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Déploiement de fonctions Lambda en Ruby avec des images conteneurs

Il existe trois méthodes pour créer une image de conteneur pour une fonction Lambda Ruby :

Astuce

Pour réduire le temps nécessaire à l’activation des fonctions du conteneur Lambda, consultez Utiliser des générations en plusieurs étapes (français non garanti) dans la documentation Docker. Pour créer des images de conteneur efficaces, suivez la section Bonnes pratiques pour l’écriture de Dockerfiles (français non garanti).

Cette page explique comment créer, tester et déployer des images de conteneur pour Lambda.

AWS images de base pour Ruby

AWS fournit les images de base suivantes pour Ruby :

Balises Environnement d’exécution Système d’exploitation Dockerfile Obsolescence

3.3

Ruby 3.3 Amazon Linux 2023 Dockerfile pour Ruby 3.3 sur GitHub

3.2

Ruby 3.2 Amazon Linux 2 Dockerfile pour Ruby 3.2 sur GitHub

Référentiel Amazon ECR : gallery.ecr.aws/lambda/ruby

Utiliser une image AWS de base pour Ruby

Pour exécuter la procédure indiquée dans cette section, vous devez satisfaire aux exigences suivantes :

Pour créer une image de conteneur pour Ruby
  1. Créez un répertoire pour le projet, puis passez à ce répertoire.

    mkdir example cd example
  2. Créez un nouveau fichier appelé Gemfile. C'est ici que vous listez les RubyGems packages requis pour votre application. Le AWS SDK for Ruby est disponible auprès de RubyGems. Vous devez choisir des gemmes AWS de service spécifiques à installer. Par exemple, pour utiliser la gem Ruby pour Lambda, votre Gemfile doit ressembler à ceci :

    source 'https://rubygems.org' gem 'aws-sdk-lambda'

    Sinon, la gemme aws-sdk contient toutes les gemmes de service disponibles. AWS Cette gem est très large. Nous vous recommandons de ne l'utiliser que si vous dépendez de nombreux AWS services.

  3. Installez les dépendances spécifiées dans le fichier Gemfile à l’aide de l’installation groupée.

    bundle install
  4. Créez un nouveau fichier appelé lambda_function.rb. Vous pouvez ajouter l’exemple de code de fonction suivant au fichier pour le tester, ou utiliser le vôtre.

    Exemple Fonction Ruby
    module LambdaFunction class Handler def self.process(event:,context:) "Hello from Lambda!" end end end
  5. Créez un nouveau fichier Docker. Voici un exemple de Dockerfile qui utilise une image de base AWS. Le Dockerfile utilise la configuration suivante :

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

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

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

    Exemple Dockerfile
    FROM public.ecr.aws/lambda/ruby:3.2 # Copy Gemfile and Gemfile.lock COPY Gemfile Gemfile.lock ${LAMBDA_TASK_ROOT}/ # Install Bundler and the specified gems RUN gem install bundler:2.4.20 && \ bundle config set --local path 'vendor/bundle' && \ bundle install # Copy function code COPY lambda_function.rb ${LAMBDA_TASK_ROOT}/ # Set the CMD to your handler (could also be done as a parameter override outside of the Dockerfile) CMD [ "lambda_function.LambdaFunction::Handler.process" ]
  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.

    docker build --platform linux/amd64 -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 d’instructions ARM64, veillez à modifier la commande pour utiliser plutôt l’option --platform linux/arm64.

  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 d’instructions ARM64, veillez à utiliser l’option --platform linux/arm64 plutôt que --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 :

    • Remplacez docker-image:test par le nom et la balise de votre image Docker.

    • 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 plus d’informations, consultez 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 mettre à jour le code de fonction, vous devez créer à nouveau l'image, télécharger la nouvelle image dans le référentiel Amazon ECR, puis utiliser la update-function-codecommande pour déployer l'image sur la fonction Lambda.

Utilisation d’une autre image de base avec le client d’interface d’exécution

Si vous utilisez une image de base uniquement pour le système d’exploitation ou une autre image de base, vous devez inclure le client d'interface d'exécution dans votre image. Le client d’interface d’exécution étend leAPI de l'environnement d'exécution Lambda, qui gère l’interaction entre Lambda et votre code de fonction.

Installez le client d'interface d'exécution Lambda pour Ruby à l'aide du gestionnaire de packages RubyGems .org :

gem install aws_lambda_ric

Vous pouvez également télécharger le client d'interface d'exécution Ruby depuis GitHub. Le client d’interface d’exécution prend en charge les versions 2.5.x à 2.7.x de Ruby.

L'exemple suivant montre comment créer une image de conteneur pour Ruby à l'aide d'une image non AWS basique. L’exemple Dockerfile utilise une image de base Ruby officielle. Le Dockerfile inclut le client d’interface d’exécution.

Pour exécuter la procédure indiquée dans cette section, vous devez satisfaire aux exigences suivantes :

Pour créer une image de conteneur pour Ruby au moyen d’une autre image de base
  1. Créez un répertoire pour le projet, puis passez à ce répertoire.

    mkdir example cd example
  2. Créez un nouveau fichier appelé Gemfile. C'est ici que vous listez les RubyGems packages requis pour votre application. Le AWS SDK for Ruby est disponible auprès de RubyGems. Vous devez choisir des gemmes AWS de service spécifiques à installer. Par exemple, pour utiliser la gem Ruby pour Lambda, votre Gemfile doit ressembler à ceci :

    source 'https://rubygems.org' gem 'aws-sdk-lambda'

    Sinon, la gemme aws-sdk contient toutes les gemmes de service disponibles. AWS Cette gem est très large. Nous vous recommandons de ne l'utiliser que si vous dépendez de nombreux AWS services.

  3. Installez les dépendances spécifiées dans le fichier Gemfile à l’aide de l’installation groupée.

    bundle install
  4. Créez un nouveau fichier appelé lambda_function.rb. Vous pouvez ajouter l’exemple de code de fonction suivant au fichier pour le tester, ou utiliser le vôtre.

    Exemple Fonction Ruby
    module LambdaFunction class Handler def self.process(event:,context:) "Hello from Lambda!" end end end
  5. Créez un nouveau fichier Docker. Le Dockerfile suivant utilise une image de base Ruby au lieu d’une image de base AWS. Le Dockerfile inclut le client d’interface d’exécution pour Ruby, ce qui rend l’image compatible avec Lambda. Vous pouvez également ajouter le client de l’interface d’exécution au Gemfile de votre application.

    • Définissez la propriété FROM sur l’image de base Ruby.

    • Créez un répertoire pour le code de fonction et une variable d'environnement pointant vers ce répertoire. Dans cet exemple, le répertoire est/var/task, qui reflète l'environnement d'exécution Lambda. Cependant, vous pouvez choisir n'importe quel répertoire pour le code de fonction car le Dockerfile n'utilise pas d'image de AWS base.

    • 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.

    Exemple Dockerfile
    FROM ruby:2.7 # Install the runtime interface client for Ruby RUN gem install aws_lambda_ric # Add the runtime interface client to the PATH ENV PATH="/usr/local/bundle/bin:${PATH}" # Create a directory for the Lambda function ENV LAMBDA_TASK_ROOT=/var/task RUN mkdir -p ${LAMBDA_TASK_ROOT} WORKDIR ${LAMBDA_TASK_ROOT} # Copy Gemfile and Gemfile.lock COPY Gemfile Gemfile.lock ${LAMBDA_TASK_ROOT}/ # Install Bundler and the specified gems RUN gem install bundler:2.4.20 && \ bundle config set --local path 'vendor/bundle' && \ bundle install # Copy function code COPY lambda_function.rb ${LAMBDA_TASK_ROOT}/ # Set runtime interface client as default command for the container runtime ENTRYPOINT [ "aws_lambda_ric" ] # Set the CMD to your handler (could also be done as a parameter override outside of the Dockerfile) CMD [ "lambda_function.LambdaFunction::Handler.process" ]
  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.

    docker build --platform linux/amd64 -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 d’instructions ARM64, veillez à modifier la commande pour utiliser plutôt l’option --platform linux/arm64.

Utilisez l’émulateur d’interface d’exécution pour tester l’image localement. Vous pouvez intégrer l’émulateur dans votre image ou l’installer sur votre ordinateur local.

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. Notez ce qui suit :

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

    • aws_lambda_ric lambda_function.LambdaFunction::Handler.process 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 \ aws_lambda_ric lambda_function.LambdaFunction::Handler.process
    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 ` aws_lambda_ric lambda_function.LambdaFunction::Handler.process

    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 d’instructions ARM64, veillez à utiliser l’option --platform linux/arm64 plutôt que --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 :

    • Remplacez docker-image:test par le nom et la balise de votre image Docker.

    • 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 plus d’informations, consultez 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 mettre à jour le code de fonction, vous devez créer à nouveau l'image, télécharger la nouvelle image dans le référentiel Amazon ECR, puis utiliser la update-function-codecommande pour déployer l'image sur la fonction Lambda.