使用容器映像部署 Ruby Lambda 函數

有三種方法可以為 Ruby Lambda 函數構建容器映像：

使用 Ruby 的 AWS 基本圖像

AWS 基礎映像會預先載入語言執行期、用來管理 Lambda 與函數程式碼之間互動的執行期界面用戶端，以及用於本機測試的執行期界面模擬器。
使用 AWS 僅限作業系統的基礎映像

AWS 僅限作業系統的基本映像檔包含 Amazon Linux 散發和執行階段介面模擬器。這些映像常用於為編譯語言 (如 Go 和 Rust) 和 Lambda 不提供基礎映像的語言或語言版本 (如 Node.js 19) 建置容器映像。您還可以使用僅限作業系統的基礎映像來實作自訂執行期。若要使映像與 Lambda 相容，您必須在映像中加入適用於 Ruby 的執行期介面用戶端。
使用非AWS 基本圖像

您可以使用其他容器登錄檔中的替代基礎映像 (例如 Alpine Linux 或 Debian)。您也可以使用組織建立的自訂映像。若要使映像與 Lambda 相容，您必須在映像中加入適用於 Ruby 的執行期介面用戶端。

提示

若要縮短 Lambda 容器函數變成作用中狀態所需的時間，請參閱 Docker 文件中的使用多階段建置。若要建置有效率的容器映像，請遵循撰寫 Dockerfiles 的最佳實務。

本頁面會說明如何為 Lambda 建置、測試和部署容器映像。

AWS 紅寶石的基本圖像

AWS 提供 Ruby 的下列基本影像：

標籤	執行期	作業系統	Dockerfile	棄用
3.3	紅寶石	Amazon Linux 2023	碼頭文件紅寶石 3.3 上 GitHub
3.2	Ruby 3.2	Amazon Linux 2	碼頭文件的紅寶石 3.2 上 GitHub

Amazon ECR 儲存庫：gallery.ecr.aws/lambda/ruby

使用 Ruby 的 AWS 基本圖像

若要完成本節中的步驟，您必須執行下列各項：

建立適用於 Ruby 的容器映像

建立專案的目錄，然後切換至該目錄。
```
mkdir example
cd example
```
建立稱為 Gemfile 的新檔案。這是您列出應用程序所需 RubyGems 軟件包的地方。可 AWS SDK for Ruby 從取得 RubyGems。您應該選擇要安裝的特定 AWS 服務寶石。例如，若要使用 Ruby Gem for Lambda，您的 Gemfile 看起來應該會像：
```
source 'https://rubygems.org'

gem 'aws-sdk-lambda'
```
或者，aws-sdk 寶石包含所有可用的 AWS 服務寶石。這個 Gem 非常大，我們建議您僅在依賴許多 AWS 服務時才使用它。
使用套件安裝作業安裝 Gemfile 中指定的相依項。
```
bundle install
```
建立稱為 lambda_function.rb 的新檔案。您可以將下列範例函數程式碼新增至檔案進行測試，或使用您自己的函數程式碼。
範例 Ruby 函數
```
module LambdaFunction
  class Handler
    def self.process(event:,context:)
      "Hello from Lambda!"
    end
  end
end
```

建立新的 Dockerfile。下列範例 Dockerfile 使用 AWS 基礎映像。此 Dockerfile 使用下列組態：

將 FROM 屬性設定為基礎映像的 URI。
使用 COPY 指令{LAMBDA_TASK_ROOT}，將函數程式碼和執行階段相依性複製到 Lambda 定義的環境變數。
將 CMD 引數設定為 Lambda 函數處理常式。

範例 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" ]

使用 docker build 命令建立 Docker 映像檔。以下範例將映像命名為 docker-image 並為其提供 test 標籤。
```
docker build --platform linux/amd64 -t docker-image:test .
```
注意
此命令會指定 --platform linux/amd64 選項，確保無論建置機器的架構為何，您的容器都與 Lambda 執行環境相容。如果您打算使用 ARM64 指令集架構建立 Lambda 函數，務必將命令變更為改用 --platform linux/arm64 選項。

使用 docker run 命令啟動 Docker 影像。在此範例中，docker-image 為映像名稱，test 為標籤。
```
docker run --platform linux/amd64 -p 9000:8080 docker-image:test
```
此命令將映像作為容器執行，並在 localhost:9000/2015-03-31/functions/function/invocations 建立本機端點。

注意
如果您為 ARM64 指令集架構建立 Docker 映像檔，請務必將--platform linux/arm64選項改用選項。--platform linux/amd64
從新的終端機視窗，將事件張貼至本機端點。
Linux/macOS
在 Linux 或 macOS 中，執行下列 curl 命令：
```
curl "http://localhost:9000/2015-03-31/functions/function/invocations" -d '{}'
```
此命令會透過空白事件調用函數，並傳回一個回應。如果您使用自己的函數程式碼而不是範例函數程式碼，則可能需要使用 JSON 承載調用該函數。範例：
```
curl "http://localhost:9000/2015-03-31/functions/function/invocations" -d '{"payload":"hello world!"}'
```
PowerShell
在中 PowerShell，執行下列Invoke-WebRequest命令：
```
Invoke-WebRequest -Uri "http://localhost:9000/2015-03-31/functions/function/invocations" -Method Post -Body '{}' -ContentType "application/json"
```
此命令會透過空白事件調用函數，並傳回一個回應。如果您使用自己的函數程式碼而不是範例函數程式碼，則可能需要使用 JSON 承載調用該函數。範例：
```
Invoke-WebRequest -Uri "http://localhost:9000/2015-03-31/functions/function/invocations" -Method Post -Body '{"payload":"hello world!"}' -ContentType "application/json"
```
取得容器 ID。
```
docker ps
```
使用 docker kill 命令停止容器。在此命令中，將 3766c4ab331c 替換為上一步驟中的容器 ID。
```
docker kill 3766c4ab331c
```

若要將映像上傳至 Amazon ECR 並建立 Lambda 函數

執行命get-login-password令以向您的 Amazon ECR 登錄驗證碼頭 CLI。
- 將--region值設定為您 AWS 區域要建立 Amazon ECR 儲存庫的位置。
- 111122223333用您的 AWS 帳戶 ID 替換。
```
aws ecr get-login-password --region us-east-1 | docker login --username AWS --password-stdin 111122223333.dkr.ecr.us-east-1.amazonaws.com
```

使用 create-repository 命令在 Amazon ECR 中建立儲存庫。


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

注意

Amazon ECR 儲存庫必須與 Lambda 函數位於 AWS 區域相同。

如果成功，您將會看到以下回應：


{
    "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"
        }
    }
}

從上一步驟的輸出中複製 repositoryUri。
執行 docker tag 命令，將 Amazon ECR 儲存庫中的本機映像標記為最新版本。在此命令中：
- 將 docker-image:test 替換為 Docker 映像檔的名稱和標籤。
- 將 <ECRrepositoryUri> 替換為複製的 repositoryUri。確保在 URI 的末尾包含 :latest。
```
docker tag docker-image:test <ECRrepositoryUri>:latest
```
範例：
```
docker tag docker-image:test 111122223333.dkr.ecr.us-east-1.amazonaws.com/hello-world:latest
```
執行 docker push 命令，將本機映像部署至 Amazon ECR 儲存庫。確保在儲存庫 URI 的末尾包含 :latest。
```
docker push 111122223333.dkr.ecr.us-east-1.amazonaws.com/hello-world:latest
```
建立函數的執行角色 (若您還沒有的話)。在下一個步驟中您需要角色的 Amazon Resource Name (ARN)。
建立 Lambda 函數。對於 ImageUri，從之前的設定中指定儲存庫 URI。確保在 URI 的末尾包含 :latest。
```
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
```
注意
只要映像與 Lambda 函數位於相同區域，您就可以使用不同 AWS 帳戶中的映像檔建立函數。如需詳細資訊，請參閱 Amazon ECR 跨帳戶許可。

調用函數。


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

您應該看到如下回應：


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

若要查看函數的輸出，請檢查 response.json 檔案。

若要更新函數程式碼，您必須再次建立映像、將新映像上傳到 Amazon ECR 存放庫，然後使用update-function-code命令將映像部署到 Lambda 函數。

透過執行期介面用戶端使用替代基礎映像

如果您使用僅限作業系統的基礎映像或替代的基礎映像，則必須在映像中加入執行期介面用戶端。執行期介面用戶端會讓您擴充 Lambda 執行階段 API，管理 Lambda 與函數程式碼之間的互動。

使用 RubyGems .org 套件管理員為 Ruby 安裝 Lambda 執行階段介面用戶端：


gem install aws_lambda_ric

您也可以從下載 Ruby 執行階段介面用戶端 GitHub。執行期介面用戶端支援 Ruby 2.5.x 至 2.7.x 版。

下面的例子演示了如何使用非AWS 基本圖像為 Ruby 構建容器映像。範例 Dockerfile 使用官方 Ruby 基礎映像。Dockerfile 包含執行期界面用戶端。

若要完成本節中的步驟，您必須執行下列各項：

使用替代基礎映像為 Ruby 建立容器映像

建立專案的目錄，然後切換至該目錄。
```
mkdir example
cd example
```
建立稱為 Gemfile 的新檔案。這是您列出應用程序所需 RubyGems 軟件包的地方。可 AWS SDK for Ruby 從取得 RubyGems。您應該選擇要安裝的特定 AWS 服務寶石。例如，若要使用 Ruby Gem for Lambda，您的 Gemfile 看起來應該會像：
```
source 'https://rubygems.org'

gem 'aws-sdk-lambda'
```
或者，aws-sdk 寶石包含所有可用的 AWS 服務寶石。這個 Gem 非常大，我們建議您僅在依賴許多 AWS 服務時才使用它。
使用套件安裝作業安裝 Gemfile 中指定的相依項。
```
bundle install
```
建立稱為 lambda_function.rb 的新檔案。您可以將下列範例函數程式碼新增至檔案進行測試，或使用您自己的函數程式碼。
範例 Ruby 函數
```
module LambdaFunction
  class Handler
    def self.process(event:,context:)
      "Hello from Lambda!"
    end
  end
end
```

建立新的 Dockerfile。下列 Dockerfile 使用 Ruby 基礎映像，而非 AWS 基礎映像。Dockerfile 包含適用於 Ruby 的執行期介面用戶端，可讓映像與 Lambda 相容。或者，您可以將執行期界面用戶端新增到應用程式的 Gemfile 中。

將 FROM 屬性設定為 Ruby 基礎映像。
建立函數程式碼的目錄，以及指向該目錄的環境變數。在此範例中，目錄是/var/task，它會反映 Lambda 執行環境。但是，您可以為函數代碼選擇任何目錄，因為 Dockerfile 不使用 AWS 基本映像。
將 ENTRYPOINT 設為您希望 Docker 容器在啟動時執行的模組。在此案例中，模組是執行期界面用戶端。
將 CMD 引數設定為 Lambda 函數處理常式。

範例 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" ]

使用 docker build 命令建立 Docker 映像檔。以下範例將映像命名為 docker-image 並為其提供 test 標籤。
```
docker build --platform linux/amd64 -t docker-image:test .
```
注意
此命令會指定 --platform linux/amd64 選項，確保無論建置機器的架構為何，您的容器都與 Lambda 執行環境相容。如果您打算使用 ARM64 指令集架構建立 Lambda 函數，務必將命令變更為改用 --platform linux/arm64 選項。

使用執行期界面模擬器以在本機測試映像。您可以將模擬器建置到映像中，也可以將其安裝在本機電腦。

若要在本機電腦上安裝並執行執行期介面模擬器

從您的項目目錄中運行以下命令以下載運行時接口仿真器（x86-64 架構） GitHub 並將其安裝在本地計算機上。

使用 docker run 命令啟動 Docker 影像。注意下列事項：
- docker-image 是映像名稱，而 test 是標籤。
- aws_lambda_ric lambda_function.LambdaFunction::Handler.process 是 Dockerfile 中的 ENTRYPOINT，後面接著 CMD。
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
```
此命令將映像作為容器執行，並在 localhost:9000/2015-03-31/functions/function/invocations 建立本機端點。

注意
如果您為 ARM64 指令集架構建立 Docker 映像檔，請務必將--platform linux/arm64選項改用選項。--platform linux/amd64
將事件張貼至本機端點。
Linux/macOS
在 Linux 或 macOS 中，執行下列 curl 命令：
```
curl "http://localhost:9000/2015-03-31/functions/function/invocations" -d '{}'
```
此命令會透過空白事件調用函數，並傳回一個回應。如果您使用自己的函數程式碼而不是範例函數程式碼，則可能需要使用 JSON 承載調用該函數。範例：
```
curl "http://localhost:9000/2015-03-31/functions/function/invocations" -d '{"payload":"hello world!"}'
```
PowerShell
在中 PowerShell，執行下列Invoke-WebRequest命令：
```
Invoke-WebRequest -Uri "http://localhost:9000/2015-03-31/functions/function/invocations" -Method Post -Body '{}' -ContentType "application/json"
```
此命令會透過空白事件調用函數，並傳回一個回應。如果您使用自己的函數程式碼而不是範例函數程式碼，則可能需要使用 JSON 承載調用該函數。範例：
```
Invoke-WebRequest -Uri "http://localhost:9000/2015-03-31/functions/function/invocations" -Method Post -Body '{"payload":"hello world!"}' -ContentType "application/json"
```
取得容器 ID。
```
docker ps
```
使用 docker kill 命令停止容器。在此命令中，將 3766c4ab331c 替換為上一步驟中的容器 ID。
```
docker kill 3766c4ab331c
```

若要將映像上傳至 Amazon ECR 並建立 Lambda 函數

執行命get-login-password令以向您的 Amazon ECR 登錄驗證碼頭 CLI。
- 將--region值設定為您 AWS 區域要建立 Amazon ECR 儲存庫的位置。
- 111122223333用您的 AWS 帳戶 ID 替換。
```
aws ecr get-login-password --region us-east-1 | docker login --username AWS --password-stdin 111122223333.dkr.ecr.us-east-1.amazonaws.com
```

使用 create-repository 命令在 Amazon ECR 中建立儲存庫。


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

注意

Amazon ECR 儲存庫必須與 Lambda 函數位於 AWS 區域相同。

如果成功，您將會看到以下回應：


{
    "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"
        }
    }
}

從上一步驟的輸出中複製 repositoryUri。
執行 docker tag 命令，將 Amazon ECR 儲存庫中的本機映像標記為最新版本。在此命令中：
- 將 docker-image:test 替換為 Docker 映像檔的名稱和標籤。
- 將 <ECRrepositoryUri> 替換為複製的 repositoryUri。確保在 URI 的末尾包含 :latest。
```
docker tag docker-image:test <ECRrepositoryUri>:latest
```
範例：
```
docker tag docker-image:test 111122223333.dkr.ecr.us-east-1.amazonaws.com/hello-world:latest
```
執行 docker push 命令，將本機映像部署至 Amazon ECR 儲存庫。確保在儲存庫 URI 的末尾包含 :latest。
```
docker push 111122223333.dkr.ecr.us-east-1.amazonaws.com/hello-world:latest
```
建立函數的執行角色 (若您還沒有的話)。在下一個步驟中您需要角色的 Amazon Resource Name (ARN)。
建立 Lambda 函數。對於 ImageUri，從之前的設定中指定儲存庫 URI。確保在 URI 的末尾包含 :latest。
```
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
```
注意
只要映像與 Lambda 函數位於相同區域，您就可以使用不同 AWS 帳戶中的映像檔建立函數。如需詳細資訊，請參閱 Amazon ECR 跨帳戶許可。

調用函數。


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

您應該看到如下回應：


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

若要查看函數的輸出，請檢查 response.json 檔案。

若要更新函數程式碼，您必須再次建立映像、將新映像上傳到 Amazon ECR 存放庫，然後使用update-function-code命令將映像部署到 Lambda 函數。

您的瀏覽器已停用或無法使用 Javascript。

您必須啟用 Javascript，才能使用 AWS 文件。請參閱您的瀏覽器說明頁以取得說明。

文件慣用形式

部署 .zip 封存檔

Context

使用容器映像部署 Ruby Lambda 函數

提示

主題

AWS 紅寶石的基本圖像

使用 Ruby 的 AWS 基本圖像

建立適用於 Ruby 的容器映像

範例 Ruby 函數

範例 Dockerfile

注意

注意

若要將映像上傳至 Amazon ECR 並建立 Lambda 函數

注意

注意

透過執行期介面用戶端使用替代基礎映像

使用替代基礎映像為 Ruby 建立容器映像

範例 Ruby 函數

範例 Dockerfile

注意

若要在本機電腦上安裝並執行執行期介面模擬器

注意

若要將映像上傳至 Amazon ECR 並建立 Lambda 函數

注意

注意