Amazon SAM CLI 的 Terraform 支持入门

1. 安装或升级 Amazon SAM CLI

   要检查是否已 Amazon SAM CLI 安装，请运行以下命令：

   $ sam --version

   如果已安装 Amazon SAM CLI，则输出将显示一个版本。要升级到最新版本，请参阅 升级 Amazon SAM CLI。

   有关安装 Amazon SAM CLI 及其所有先决条件的说明，请参阅 安装 Amazon SAM CLI。

2. 安装 Terraform

   要检查是否已安装 Terraform，请运行以下命令：

   $ terraform -version

   要安装 Terraform，请参阅 Terraform 注册表中的安装 Terraform。

3. 安装 Docker 以进行本地测试

   Amazon SAM CLI 进行本地测试需要 Docker。要安装 Docker，请参阅 安装 Docker 以与 Amazon SAM CLI 一起使用。

要定义 sam metadata 资源

1. 以 sam_metadata_ 开头命名您的资源，以将该资源标识为 sam metadata 资源。

2. 在资源 triggers 块中定义您的 Lambda 构件属性。

3. 使用 depends_on 参数指定包含您的 Lambda 构建逻辑的 null_resource。

   以下是一个示例模板：

   resource "null_resource" "sam_metadata_..." {
     triggers = {
       resource_name = resource_name
       resource_type = resource_type
       original_source_code = original_source_code
       built_output_path = built_output_path
     }
     depends_on = [
       null_resource.build_lambda_function # ref to your build logic
     ]
   }

   以下是 sam metadata 资源示例：

   resource "null_resource" "sam_metadata_aws_lambda_function_publish_book_review" {
       triggers = {
           resource_name = "aws_lambda_function.publish_book_review"
           resource_type = "ZIP_LAMBDA_FUNCTION"
           original_source_code = "${local.lambda_src_path}"
           built_output_path = "${local.building_path}/${local.lambda_code_filename}"
       }
       depends_on = [
           null_resource.build_lambda_function
       ]
   }

要使用 sam build 进行构建

1. 在包含 Terraform 根模块的目录中，运行以下命令：

   $ sam build --hook-name terraform

2. 要构建特定的 Lambda 函数或层，请运行以下命令

   $ sam build --hook-name terraform lambda-resource-id

   Lambda 资源 ID 可以是 Lambda 函数名称或完整 Terraform 资源地址，例如 aws_lambda_function.list_books 或 module.list_book_function.aws_lambda_function.this[0]。

要使用容器构建

1. 创建包含 Terraform、Python、和 Make 工具的 Dockerfile。您还应该纳入 Lambda 函数运行时。

   以下是 Dockerfile 示例：

   FROM public.ecr.aws/amazonlinux/amazonlinux:2
   
   RUN yum -y update \
       && yum install -y unzip tar gzip bzip2-devel ed gcc gcc-c++ gcc-gfortran \
       less libcurl-devel openssl openssl-devel readline-devel xz-devel \
       zlib-devel glibc-static libcxx libcxx-devel llvm-toolset-7 zlib-static \
       && rm -rf /var/cache/yum
   
   RUN yum -y install make \
       && yum -y install zip
   
   RUN yum install -y yum-utils \
       && yum-config-manager --add-repo https://rpm.releases.hashicorp.com/AmazonLinux/hashicorp.repo \
       && yum -y install terraform \
       && terraform --version
   
   # AWS Lambda Builders
   RUN amazon-linux-extras enable python3.8
   RUN yum clean metadata && yum -y install python3.8
   RUN curl -L get-pip.io | python3.8
   RUN pip3 install aws-lambda-builders
   RUN ln -s /usr/bin/python3.8 /usr/bin/python3
   RUN python3 --version
   
   VOLUME /project
   WORKDIR /project
   
   ENTRYPOINT ["sh"]

2. 使用 docker build 构建您的 Docker 映像。

   以下是示例：

   $ docker build --tag terraform-build:v1 <path-to-directory-containing-Dockerfile>

3. 使用 --use-container 和 --build-image 选项运行 Amazon SAM CLI sam build 命令。

   以下是示例：

   $ sam build --use-container --build-image terraform-build:v1

要生成本地计划文件

1. 配置 API 令牌 – 令牌的类型将取决于您的访问级别。有关更多信息，请参阅 Terraform Cloud 文档中的 API 令牌。

2. 设置 API 令牌环境变量 – 以下是命令行的示例：

   $ export TOKEN="<api-token-value>"

3. 获取您的运行 ID – 在 Terraform Cloud 控制台中，找到您要与 Amazon SAM CLI 一起使用的 Terraform 运行的运行 ID。

   运行 ID 位于您运行的页面导览痕迹路径中。

   

4. 获取计划文件 – 使用您的 API 令牌获取本地计划文件。以下是来自命令行的示例：

   curl \
      --header "Authorization: Bearer $TOKEN" \
      --header "Content-Type: application/vnd.api+json" \
      --location \
      https://app.terraform.io/api/v2/runs/<run ID>/plan/json-output \
      > custom_plan.json