localstack/localstack

LocalStack 镜像文档

概述

LocalStack 是一款云服务模拟器，可在您的笔记本电脑或CI环境中的单个容器内运行。借助 LocalStack，您可以在本地计算机上完全运行AWS应用程序或Lambda函数，而无需连接到远程云提供商！无论您是测试复杂的CDK应用程序、Terraform配置，还是刚开始学习AWS服务，LocalStack都能帮助加速和简化您的测试与开发工作流程。

LocalStack支持日益增多的AWS服务，如AWS Lambda、S3、DynamoDB、Kinesis、SQS、SNS等。您可以在☑️ 功能覆盖页面查看支持的API完整列表。此外，LocalStack还提供了额外功能，为云开发人员提供更多便利，详情请参阅用户指南。

使用方法

在开始前，请确保您的机器上已配置好https://docs.docker.com/get-docker/%E3%80%82%E5%8F%AF%E9%80%9A%E8%BF%87%E5%9C%A8%E7%BB%88%E7%AB%AF%E6%89%A7%E8%A1%8C%60docker info`命令检查Docker是否正常配置，若未报错且显示Docker系统信息，则说明配置正确。

Docker CLI

您可以直接使用Docker CLI启动LocalStack容器。此方法需要更多手动步骤和配置，但能让您更好地控制容器设置。

执行以下命令启动Docker容器：

console
$ docker run --rm -it -p 4566:4566 -p 4510-4559:4510-4559 localstack/localstack

使用LocalStack的awslocal CLI创建S3存储桶：

$ awslocal s3api create-bucket --bucket sample-bucket
$ awslocal s3api list-buckets

注意

• 若本地已存在镜像，此命令将重用该镜像，不会自动从Docker Hub拉取最新镜像。
• 此命令未绑定LocalStack可能使用的所有端口，也未挂载任何卷。通过Docker手动启动LocalStack时，您需要自行配置容器（详见https://github.com/localstack/localstack/blob/main/docker-compose.yml%E5%92%8C%E9%85%8D%E7%BD%AE%EF%BC%89%E3%80%82%E8%BF%99%E5%8F%AF%E8%A7%86%E4%B8%BA%E5%90%AF%E5%8A%A8LocalStack%E7%9A%84%E2%80%9C%E4%B8%93%E5%AE%B6%E6%A8%A1%E5%BC%8F%E2%80%9D%E3%80%82%E8%8B%A5%E6%82%A8%E9%9C%80%E8%A6%81%E6%9B%B4%E7%AE%80%E5%8D%95%E7%9A%84%E5%90%AF%E5%8A%A8%E6%96%B9%E5%BC%8F%EF%BC%8C%E8%AF%B7%E4%BD%BF%E7%94%A8LocalStack CLI。

Docker Compose

您可以通过配置docker-compose.yml文件，使用https://docs.docker.com/compose/%E5%90%AF%E5%8A%A8LocalStack%E3%80%82%E7%9B%AE%E5%89%8D%E6%94%AF%E6%8C%81docker-compose 1.9.0+版本。

yaml
version: "3.8"

services:
  localstack:
    container_name: "${LOCALSTACK_DOCKER_NAME:-localstack-main}"
    image: docker.xuanyuan.run/localstack/localstack
    ports:
      - "127.0.0.1:4566:4566"            # LocalStack网关
      - "127.0.0.1:4510-4559:4510-4559"  # 外部服务端口范围
    environment:
      # LocalStack配置：https://docs.localstack.cloud/references/configuration/
      - DEBUG=${DEBUG:-0}
    volumes:
      - "${LOCALSTACK_VOLUME_DIR:-./volume}:/var/lib/localstack"
      - "/var/run/docker.sock:/var/run/docker.sock"

执行以下命令启动容器：

console
$ docker-compose up

使用LocalStack的awslocal CLI创建SQS队列：

$ awslocal sqs create-queue --queue-name test-queue
$ awslocal sqs list-queues

注意

• 若本地无镜像，此命令将拉取main分支的当前夜间构建版本，而非最新支持版本。如需使用特定版本，请在docker-compose.yml文件的services.localstack.image处设置相应的LocalStack镜像标签（例如localstack/localstack:<version>）。
• 若本地已存在镜像，此命令将重用该镜像，不会自动从Docker Hub拉取最新镜像。
• 将Docker套接字/var/run/docker.sock挂载为卷是Lambda服务的要求，更多信息请参阅Lambda提供程序文档。

请注意，通过docker-compose手动配置堆栈时可能存在一些陷阱（如必需的容器名称、Docker网络、卷挂载和环境变量）。建议使用LocalStack CLI验证配置，它会在检测到潜在配置问题时打印警告消息：

console
$ localstack config validate

基础镜像标签

LocalStack Docker镜像提供多种标签，您可根据需求选择：

• latest（默认）

  • 这是默认标签，指向经过全面集成测试套件测试的最新提交。
  • 包含主要版本更新，可能存在破坏性变更。
  • 适用于希望保持最新变更的场景。

• stable

  • 指向最新的标记版本，会随LocalStack的每次发布更新。
  • 包含主要版本更新，可能存在破坏性变更。
  • 适用于希望跟进版本发布，但不一定需要立即获取最新变更的场景。

• <major>（如3）

  • 指向特定主要版本的最新发布，会随该主要版本内的每次次要和补丁版本更新。
  • 适用于希望避免潜在破坏性变更的场景。

• <major>.<minor>（如3.0）

  • 指向特定次要版本的最新发布，会随该次要版本内的每次补丁版本更新。
  • 适用于希望避免新功能等较大变更，但仍需更新至最新 bugfix 版本的场景。

• <major>.<minor>.<patch>（如3.0.2）

  • 指向特定版本，不会更新。
  • 适用于希望完全避免镜像变更（包括最小的 bugfixes）的场景。

获取帮助

您可以通过以下渠道联系LocalStack团队：报告🐞https://github.com/localstack/localstack/issues/new/choose%E3%80%81%E4%B8%BA%F0%9F%91%8Dhttps://github.com/localstack/localstack/issues?q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc%E6%8A%95%E7%A5%A8%E3%80%81%F0%9F%99%8B%F0%9F%8F%BD%E6%8F%90%E5%87%BA%E6%94%AF%E6%8C%81%E9%97%AE%E9%A2%98%E6%88%96%F0%9F%97%A3%EF%B8%8F%E8%AE%A8%E8%AE%BA%E6%9C%AC%E5%9C%B0%E4%BA%91%E5%BC%80%E5%8F%91%EF%BC%9A

• LocalStack Slack社区
• https://github.com/localstack/localstack/issues
• 入门指南 - FAQ

许可证

版权所有 (c) 2017-2024 LocalStack维护者及贡献者。

版权所有 (c) 2016 Atlassian及其他方。

本版本的LocalStack采用Apache License 2.0许可协议（详见https://github.com/localstack/localstack/blob/main/LICENSE.txt%EF%BC%89%E3%80%82%E4%B8%8B%E8%BD%BD%E5%92%8C%E4%BD%BF%E7%94%A8%E6%9C%AC%E8%BD%AF%E4%BB%B6%E5%8D%B3%E8%A1%A8%E7%A4%BA%E6%82%A8%E5%90%8C%E6%84%8Fhttps://github.com/localstack/localstack/blob/main/doc/end_user_license_agreement%E3%80%82