Ansible 角色：Nginx

注意： 请考虑使用 NGINX, Inc. 的官方 NGINX Ansible 角色。

在 RedHat/CentOS、Debian/Ubuntu、Archlinux、FreeBSD 或 OpenBSD 服务器上安装 Nginx。

该角色从 Nginx yum 仓库（在基于 RedHat 的系统上）、apt（在基于 Debian 的系统上）、pacman（Archlinux）、pkgng（在 FreeBSD 系统上）或 pkg_add（在 OpenBSD 系统上）安装并配置 Nginx 的最新版本。您可能需要在此角色安装 Nginx 后进行额外的设置工作，比如在 /etc/nginx/conf.d/ 中添加您自己的 [virtualhost].conf 文件，以描述您特定网站的位置和选项。

需求

无。

角色变量

可用变量如下所示，以及默认值（请参阅 defaults/main.yml）：

nginx_listen_ipv6: true

是否监听 IPv6（应用于该角色管理的所有虚拟主机）。

nginx_vhosts: []

Nginx 虚拟主机的 vhost 定义（服务器块）列表。每个条目将创建一个名为 server_name 的单独配置文件。如果留空，您需要提供自己的虚拟主机配置。请查看 defaults/main.yml 中的注释示例以获取可用的服务器选项。如果您需要对服务器定义进行大量自定义，最好自己管理虚拟主机配置文件，将此变量设置为 []。

nginx_vhosts:
  - listen: "443 ssl http2"
    server_name: "example.com"
    server_name_redirect: "www.example.com"
    root: "/var/www/example.com"
    index: "index.php index.html index.htm"
    error_page: ""
    access_log: ""
    error_log: ""
    state: "present"
    template: "{{ nginx_vhost_template }}"
    filename: "example.com.conf"
    extra_parameters: |
      location ~ \.php$ {
          fastcgi_split_path_info ^(.+\.php)(/.+)$;
          fastcgi_pass unix:/var/run/php5-fpm.sock;
          fastcgi_index index.php;
          fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
          include fastcgi_params;
      }
      ssl_certificate     /etc/ssl/certs/ssl-cert-snakeoil.pem;
      ssl_certificate_key /etc/ssl/private/ssl-cert-snakeoil.key;
      ssl_protocols       TLSv1.1 TLSv1.2;
      ssl_ciphers         HIGH:!aNULL:!MD5;

一个完整的 nginx_vhosts 条目的示例，使用 | 声明 extra_parameters 的语法块。

请注意上述块的缩进。第一行应使用正常的 2 空格缩进。所有其他行应相对于该行正常缩进。在生成的文件中，整个块将缩进 4 空格。此样式将确保配置文件的缩进正确。

  - listen: "80"
    server_name: "example.com www.example.com"
    return: "301 https://example.com$request_uri"
    filename: "example.com.80.conf"

一个二级虚拟主机的示例，将重定向到上面显示的虚拟主机。

注意：filename 默认使用 server_name 中的第一个域名，如果有两个虚拟主机使用相同的域名，例如重定向，您需要手动设置 filename，以便第二个不会覆盖第一个

nginx_remove_default_vhost: false

是否移除 Nginx 提供的“默认”虚拟主机配置。如果您希望基本的 / URL 指向您在单独的.conf 文件中配置的某个虚拟主机，这很有用。

nginx_upstreams: []

如果您将 Nginx 配置为负载均衡器，可以使用此变量定义一个或多个上游集。除了定义至少一个上游，您还需要配置您的服务器块之一，以通过已定义的上游代理请求（例如：proxy_pass http://myapp1;）。有关更多信息，请参见 defaults/main.yml 中的注释示例。

nginx_user: "nginx"

Nginx 将运行的用户。对 RedHat 默认为 nginx，对 Debian 默认为 www-data，对 FreeBSD 和 OpenBSD 默认为 www。

nginx_worker_processes: "{{ ansible_processor_vcpus|default(ansible_processor_count) }}"
nginx_worker_connections: "1024"
nginx_multi_accept: "off"

nginx_worker_processes 应设置为您机器上存在的核心数量（如果默认值不正确，可以通过 grep processor /proc/cpuinfo | wc -l 找到这个数字）。nginx_worker_connections 是每个进程的连接数量。将其设置得更高可以处理更多的同时连接（请记住，连接将在每个客户端的保持活动超时期间被使用！）。如果您希望 Nginx 立即接受所有连接，可以将 nginx_multi_accept 设置为 on。

nginx_error_log: "/var/log/nginx/error.log warn"
nginx_access_log: "/var/log/nginx/access.log main buffer=16k flush=2m"

默认错误日志和访问日志的配置。设置为 off 可完全禁用日志。

nginx_sendfile: "on"
nginx_tcp_nopush: "on"
nginx_tcp_nodelay: "on"

TCP 连接选项。有关这些指令的更多信息，请参见 这篇博文。

nginx_keepalive_timeout: "65"
nginx_keepalive_requests: "100"

Nginx keepalive 设置。如果您有更多轮询样式的流量（特别是 AJAX 驱动的网站），超时时间应设置得更高（10秒以上）；如果大多数用户只访问几页且不发送进一步的请求，则应设置得更低（少于 10秒）。

nginx_server_tokens: "on"

Nginx server_tokens 设置。控制 Nginx 是否在 HTTP 头中响应其版本。设置为 "off" 可禁用。

nginx_client_max_body_size: "64m"

该值决定了最大文件上传量，因为上传是通过 Nginx 传递到后端的，比如 php-fpm。如果您收到错误 client intended to send too large body，这意味着该值设置得过低。

nginx_server_names_hash_bucket_size: "64"

如果您有许多服务器名称，或有非常长的服务器名称，您可能会在启动时遇到 Nginx 错误，需要增加此值。

nginx_proxy_cache_path: ""

在 nginx.conf 文件中设置为 proxy_cache_path 指令。默认情况下，如果保持为空字符串，将不会进行配置，但如果您希望将 Nginx 作为反向代理使用，可以将其设置为有效值（例如 "/var/cache/nginx keys_zone=cache:32m"），以使用 Nginx 的缓存（进一步的代理配置可以在各个服务器配置中进行）。

nginx_extra_http_options: ""

插入到 nginx.conf 的顶层 http 块中的额外行。值应按字面意义定义（就像您直接插入到 nginx.conf 中一样，遵循 Nginx 配置语法，例如 ; 用于行终止等），例如：

nginx_extra_http_options: |
  proxy_buffering    off;
  proxy_set_header   X-Real-IP $remote_addr;
  proxy_set_header   X-Scheme $scheme;
  proxy_set_header   X-Forwarded-For $proxy_add_x_forwarded_for;
  proxy_set_header   Host $http_host;

有关放置的更多详细信息，请参见 templates/nginx.conf.j2 中的模板。

nginx_extra_conf_options: ""

插入到 nginx.conf 顶部的额外行。值同样应按字面意义定义，例如：

nginx_extra_conf_options: |
  worker_rlimit_nofile 8192;

有关放置的更多详细信息，请参见 templates/nginx.conf.j2 中的模板。

nginx_log_format: |-
  '$remote_addr - $remote_user [$time_local] "$request" '
  '$status $body_bytes_sent "$http_referer" '
  '"$http_user_agent" "$http_x_forwarded_for"'

配置 Nginx 的 log_format 选项。

nginx_default_release: ""

（仅适用于 Debian/Ubuntu）允许您为 Nginx 的安装设置不同的仓库。例如，如果您正在运行 Debian 的 wheezy 版本，并希望获得更新版本的 Nginx，您可以安装 wheezy-backports 仓库并在此处设置该值，Ansible 将在安装 Nginx 时将其用作 -t 选项。

nginx_ppa_use: false
nginx_ppa_version: stable

（仅适用于 Ubuntu）允许您使用官方 Nginx PPA，而不是系统的包。您可以将版本设置为 stable 或 development。

nginx_yum_repo_enabled: true

（仅适用于 RedHat/CentOS）将其设置为 false 以禁用 nginx yum 仓库的安装。如果您希望使用默认的操作系统稳定包，或使用 Satellite，这可能是必要的。

nginx_zypper_repo_enabled: true

（仅适用于 Suse）将其设置为 false 以禁用 nginx zypper 仓库的安装。如果您希望使用默认的操作系统稳定包，或使用 Suse Manager，这可能是必要的。

nginx_service_state: started
nginx_service_enabled: yes

默认情况下，此角色会确保 Nginx 在配置后运行并在启动时启用。如果在容器中安装或需要更进一步控制服务状态，您可以使用这些变量覆盖此行为。

覆盖配置模板

如果您无法通过变量自定义，因为没有暴露选项，您可以覆盖用于生成虚拟主机配置文件或 nginx.conf 文件的模板。

nginx_conf_template: "nginx.conf.j2"
nginx_vhost_template: "vhost.j2"

如果需要，您还可以按虚拟主机单独设置模板。

nginx_vhosts:
  - listen: "80 default_server"
    server_name: "site1.example.com"
    root: "/var/www/site1.example.com"
    index: "index.php index.html index.htm"
    template: "{{ playbook_dir }}/templates/site1.example.com.vhost.j2"
  - server_name: "site2.example.com"
    root: "/var/www/site2.example.com"
    index: "index.php index.html index.htm"
    template: "{{ playbook_dir }}/templates/site2.example.com.vhost.j2"

您可以复制并修改提供的模板，或使用 Jinja2 模板继承 扩展模板，并覆盖需要更改的特定模板块。

示例：在 nginx 配置中配置 gzip

将 nginx_conf_template 设置为指向您播放书目录中的模板文件。

nginx_conf_template: "{{ playbook_dir }}/templates/nginx.conf.j2"

在您上面配置的路径中创建子模板，并扩展相对于 playbook.yml 的 geerlingguy.nginx 模板文件。

{% extends 'roles/geerlingguy.nginx/templates/nginx.conf.j2' %}

{% block http_gzip %}
    gzip on;
    gzip_proxied any;
    gzip_static on;
    gzip_http_version 1.0;
    gzip_disable "MSIE [1-6]\.";
    gzip_vary on;
    gzip_comp_level 6;
    gzip_types
        text/plain
        text/css
        text/xml
        text/javascript
        application/javascript
        application/x-javascript
        application/json
        application/xml
        application/xml+rss
        application/xhtml+xml
        application/x-font-ttf
        application/x-font-opentype
        image/svg+xml
        image/x-icon;
    gzip_buffers 16 8k;
    gzip_min_length 512;
{% endblock %}

依赖

无。

示例剧本

- hosts: server
  roles:
    - { role: geerlingguy.nginx }

许可证

MIT / BSD

作者信息

此角色由 Jeff Geerling 创建于 2014 年，他是 Ansible for DevOps 的作者。