本文基于 ansible 2.3.0.0 编写

我们目前有 8 个大区共 24 台 nginx 服务器,每个区除了 upstream 地址不同,其它配置参数都一样。自从使用了 ansible 来维护更新后,工作变得非常轻松,几分钟内就可以更新所有 24 台服务器的 nginx 配置。并且实现了检查配置有误后,自动恢复上一次配置的机制。

以下就以此为例,展示如何利用 ansible 在自动化部署 nginx 时,如何规避错误的配置。

首先看看我的 nginx role 目录结构

deploy.Nginx/
├── files
│   └── nginx.conf
├── handlers
│   └── main.yml
├── tasks
│   ├── Debian.yml
│   ├── main.yml
│   └── sites_conf_test.yml
└── templates
    ├── cms_console_newtouch_com.j2
    └── console_newtouch_com.j2

roles/deploy.Nginx/tasks/main.ymlinclude sites_conf_test.yml 的代码片段:

- include: sites_conf_test.yml
  vars:
    - file: '{{ item }}'
  with_items:
    - 'console_newtouch_com'

这里传递了变量 file 的值给 sites_conf_test.yml,这样我们可以扩展配置多个站点配置文件。


roles/deploy.Nginx/tasks/sites_conf_test.yml 的代码:

- name: Create ~/'{{ file }}.conf'
  template:
    src: '../templates/{{ file }}.j2'
    dest: '~/{{ file }}.conf'
  register: createResult

- block:
    - name: Copy '~/{{ file }}.conf'
      copy:
        src: '~/{{ file }}.conf'
        dest: '/etc/nginx/sites-enabled/{{ file }}.conf'
        backup: yes
        remote_src: yes
      register: copyResult
      when: createResult.changed
    - name: 'Test {{ file }}.conf config'
      command: nginx -t
      notify: Reload nginx service
      when: copyResult.changed
  rescue:
    - name: '{{ file }}.conf test failed, rolling backup file.'
      copy:
        src: '{{ copyResult.backup_file }}'
        dest: '/etc/nginx/sites-enabled/{{ file }}.conf'
        remote_src: yes

代码解析:

  1. 首先使用 template 模块,在服务器上生成 nginx 站点的配置文件。

    ansible 2.3.0.0 有个问题还没解决,就是 template 模块的 backup 参数,并不会返回备份文件的名称,所以只能曲线救国,先创建一个临时的文件。
  2. 然后,重点就在这个 block 编排里。第一个 task 是把生成的 console_newtouch_com.conf 文件拷贝到 /etc/nginx/sites-enabled/ 目录下,因为启用了 backup 参数,所以 copyResult 会包含 backup_file 的绝对路径地址名称。这个就用在配置回滚操作中。
  3. 第二个 task 就是执行 nginx -t 来确认新配置文件是否正确了。如果失败了,就会触发 rescue 里的任务。我们只需要把备份文件恢复,保证服务器上的配置是好的。

同理可以用在更新 nginx.conf 的操作里。