连接SAM Local与Docker Compose网络的3种方案

2024-11-24 23:33:07

连接 SAM Local 与 Docker Compose 网络

在本地开发环境中，经常会使用 sam local start-lambda 模拟 AWS Lambda 和 API Gateway 的执行。如果开发环境中还使用了 Docker Compose 来管理服务依赖，例如数据库或消息队列，则需要将 SAM Local 连接到 Docker Compose 创建的网络中，以实现服务间的互通。本文将探讨如何实现 SAM Local 与 Docker Compose 网络的连接，并提供一些最佳实践。

理解网络连接的需求

当使用 sam local start-lambda 启动 Lambda 函数本地调试时，SAM 会创建一个隔离的网络环境。这导致 Lambda 函数无法直接访问 Docker Compose 定义的 private 网络中的服务。要解决这个问题，需要将 SAM Local 的网络桥接到 Docker Compose 的网络。

解决方案一：使用 Docker 网络的 host 模式

最简单的解决方案是使用 Docker 的 host 网络模式。这将使得 Docker 容器直接使用主机的网络栈，从而与 SAM Local 共享同一个网络环境。

操作步骤：

修改 docker-compose.yml 文件，将需要与 SAM Local 通信的服务的网络模式设置为 host。

version: "3.8"
services:
  php_app:
    # ... other configurations
    network_mode: "host" 
    # ...

  nginx:
   # ... other configurations
    network_mode: "host"
    # ...
#移除networks段落

启动 Docker Compose 服务: docker-compose up -d
启动 SAM Local: sam local start-lambda

优点： 简单易用，配置修改最少。

缺点： 安全性较低，因为所有容器都共享主机的网络端口。端口冲突的可能性也增加了. 不适用于复杂的网络配置。

解决方案二：使用 Docker 的 bridge 网络

此方案将 SAM Local 连接到 Docker 的默认 bridge 网络。这需要在启动 SAM Local 时指定 --docker-network 参数。

操作步骤：

确保 Docker Compose 使用默认的 bridge 网络, 或者在docker-compose.yml中明确指定bridge网络

version: "3.8"
services:
  # ...
networks:
  default:
    external:
      name: bridge # 明确指定使用docker的bridge网络

启动 Docker Compose 服务: docker-compose up -d
启动 SAM Local，并指定网络: sam local start-lambda --docker-network bridge

优点： 比 host 模式更安全，容器间端口冲突的概率更小。

缺点： 仍然不够灵活，不适用于自定义网络配置。

解决方案三：将 SAM Local 连接到自定义 Docker 网络

这是最灵活且推荐的解决方案。它允许 SAM Local 加入 Docker Compose 定义的任何自定义网络。

操作步骤:

运行 docker network inspect <network_name> 获取 Docker Compose 网络的子网和网关信息. <network_name>替换为你 docker-compose.yml 文件中的网络名称，比如本例中的private.
基于获取的子网信息，选择一个未使用的 IP 地址分配给 SAM Local 容器。
使用 docker run --network=<network_name> --ip=<assigned_ip> 启动 SAM Local。
```
sam local start-lambda --docker-network private --host 0.0.0.0
```
请注意 --host 0.0.0.0 选项，它会将 Lambda 函数绑定到所有可用的网络接口，使其可以通过 Docker 网络访问。