danihodovic/openresty

ansible-openresty

镜像概述和主要用途

ansible-openresty是一个Ansible角色，用于部署运行Openresty的Docker容器。该角色提供灵活的配置选项，包括可选的速率限制、Prometheus指标收集和默认代理配置，适用于需要高性能Web服务器和反向代理的场景。

核心功能和特性

• Docker容器化部署：通过Ansible自动化管理Openresty容器的生命周期
• 内置配置模块：提供速率限制（rate_limit.conf）、Prometheus指标（prometheus_metrics.conf）和默认代理（proxy.conf）等可选配置
• SSL自动管理：集成lua-resty-auto-ssl，支持Let's Encrypt证书自动生成与更新
• 自定义配置支持：允许添加额外的Nginx配置文件，满足个性化需求
• 网络管理：支持Docker网络配置，确保容器间通信

使用场景和适用范围

• 需要部署高性能Web服务器和反向代理的环境
• 需要对API或Web服务实施速率限制的场景
• 需要收集Prometheus监控指标的监控环境
• 需要自动管理SSL证书的HTTPS服务部署
• 基于Docker容器化的Web服务架构

使用方法和配置说明

前提要求

• 主机已安装Docker守护进程
• 主机已安装docker pip库：pip install docker

基本部署示例

yaml
- name: 部署Openresty
  hosts: localhost
  vars:
    ansible_become: true
  tasks:
    - name: 创建网络
      docker_network:
        name: test_default

    - import_role:
        name: ansible-role-openresty
      vars:
        openresty_includes_extras:
          findwork-dev.conf: |
            server {
              server myserver.org;
              location / {
                set $proxy_address mycontainer:5050;
                proxy_pass http://$proxy_address;
              }
            }
        openresty_includes_builtin:
          - proxy.conf
          - rate_limit.conf
          - prometheus_metrics.conf
        openresty_docker_networks:
          - name: test_default

带lua-resty-auto-ssl的部署

要启用自动SSL功能，需进行以下配置：

1. 定义openresty_ssl_domains变量，指定需要自动获取SSL证书的域名
2. 在虚拟主机配置块中添加{{ openresty_auto_ssl_config|indent(2) }}以包含SSL证书管理所需的Lua代码块

yaml
- name: 部署Openresty
  hosts: localhost
  become: true
  tasks:
    - name: 创建网络
      docker_network:
        name: test_default

    - import_role:
        name: ansible-openresty
      vars:
        openresty_includes_extras:
          findwork-dev.conf: |
            server {
              listen 443 ssl;
              server_name findwork.dev;

              {{ openresty_auto_ssl_config|indent(2) }}

              location / {
                set $proxy_address mycontainer:5050;
                proxy_pass http://$proxy_address;
              }
            }
        openresty_includes_builtin:
          - ssl.conf
          - proxy.conf
          - logging.conf
        openresty_ssl_domains:
          - findwork.dev
        openresty_docker_networks:
          - name: test_default

使用proxy.conf

proxy.conf包含Docker DNS解析器127.0.0.11（需要用户定义网络）。使用proxy_pass时需通过变量设置目标地址，否则可能导致主机解析失败：

nginx
location / {
  set $proxy_address myserver:5050;
  proxy_pass [***]
}