20、Ansible 软件管理与故障排除指南

Ansible 软件管理与故障排除指南

一、Ansible 故障排除

1.1 故障排除概述

在使用 Ansible 时，可能会遇到各种问题，需要进行故障排除。主要涵盖四个与故障排除相关的主题：
1. 获取足够的故障排除信息 ：包括处理日志文件、使用检查模式以及提高详细程度。
2. 使用不同模块 ：有助于更深入了解剧本的成功或失败情况。
3. 使用标签 ：可用于仅运行特定任务。
4. 常见场景故障排除 ：针对一些常见问题进行排查。

1.2 关键术语定义

需要理解以下关键术语：
- 检查模式（check mode） ：在不实际执行更改的情况下模拟任务执行。
- 过滤器（filter） ：用于处理和转换数据。
- 标签（tag） ：用于标记任务，方便选择性执行。

1.3 复习问题

以下是一些复习问题及解答思路：
1. 如何确保任务不在检查模式下运行 ：可通过特定的参数设置或任务配置来实现。
2. 如果块中的主任务失败并执行救援操作，在剧本输出摘要中会看到什么 ：会显示主任务失败和救援操作执行的相关信息。
3. 在 ansible.cfg 文件中可以设置哪个参数来指定 Ansible 命令输出的日志位置 ：可通过设置相应的日志路径参数来指定。
4. 使用哪个模块来分析 API 输出 ：有专门的模块可用于此操作。
5. 想要编写一个剧本，定义任务失败的条件，应使用哪个模块 ：有特定的模块可用于定义任务失败条件。
6. 使用哪个模块来测试预期结果是否存在，否则失败 ：有相应的模块可完成此测试。
7. 如何将变量数据类型从字符串转换为整数 ：可使用特定的函数或操作来实现。
8. 使用哪个标签可以确保任务除非被明确请求否则永远不会运行 ：有专门的标签用于此目的。
9. 一个任务配置了 [ debug, never ] 标签，如何运行剧本以运行包括此任务在内的所有任务 ：可通过特定的命令参数来实现。
10. 使用哪个命令来验证与 Ansible 管理的机器的连接 ：使用 ansible all -m ping 命令。

1.4 实验任务

有一个实验任务， lesson11 - lab.yaml 剧本包含一些错误，需要按照以下步骤修复：
1. 使用命令行工具和参数查找错误，而不是仅通过阅读 YAML 文件来修复。
2. 修复一个任务中的错误后，开始运行下一个任务，避免重复运行相同任务。
3. 在应用模板之前，使用预运行和差异比较来查看模板将进行的更改。
4. 在必要时使用调试模块。

二、使用 Ansible 管理软件

2.1 管理软件包的模块

2.1.1 配置仓库访问

在管理软件包之前，需要设置对仓库的访问，可使用 yum_repository 模块。示例剧本如下：

---
- name: setting up repository access
  hosts: all
  tasks:
  - name: connect to example repo
    yum_repository:
      name: example repo
      description: RHCE8 example repo
      file: examplerepo
      baseurl: ftp://control.example.com/repo/
      gpgcheck: no

yum_repository 模块的关键参数如下表所示：
| 参数 | 说明 |
| ---- | ---- |
| name | 仓库名称 |
| description | 仓库描述 |
| file | 仓库文件名称 |
| baseurl | 仓库的基础 URL |
| gpgcheck | 是否进行 GPG 检查 |

2.1.2 使用 yum 管理软件

yum 模块可用于管理软件包，包括安装、删除和更新。以下是一些示例：
- 更新所有软件包 ：

---
- name: updating all packages
  hosts: ansible2
  tasks:
  - name: system update
    yum:
      name: '*'
      state: latest

• 安装软件包组 ：

---
- name: install or update a package group
  hosts: ansible2
  tasks:
  - name: install or update a package group
    yum:
      name: '@Virtualization Host'
      state: latest

• 安装 AppStream 模块 ：

---
- name: installing an AppStream module
  hosts: ansible2
  tasks:
  - name: install or update an AppStream module
    yum:
      name: '@php:7.3/devel'
      state: present

2.1.3 管理软件包事实

当 Ansible 收集事实时，软件包事实不包含在内，需要使用 package_facts 模块单独收集。示例剧本如下：

---
- name: using package facts
  hosts: ansible2
  vars:
    my_package: nmap
  tasks:
  - name: install package
    yum:
      name: "{{ my_package }}"
      state: present
  - name: update package facts
    package_facts:
      manager: auto
  - name: show package facts for {{ my_package }}
    debug:
      var: ansible_facts.packages[my_package]
    when: my_package in ansible_facts.packages

2.2 管理仓库和订阅的模块

2.2.1 设置仓库

如果外部仓库不可访问，需要自己设置仓库。以设置基于 FTP 的仓库为例，需要完成以下任务：
1. 安装 FTP 软件包。
2. 启动并启用 FTP 服务器。
3. 打开防火墙以允许 FTP 流量。
4. 确保 FTP 共享仓库目录可用。
5. 下载软件包到仓库目录。
6. 使用 createrepo 命令生成仓库索引。

示例剧本如下：

- name: install FTP to export repo
  hosts: localhost
  tasks:
  - name: install FTP server
    yum:
      name:
      - vsftpd
      - createrepo_c
      state: latest
  - name: start FTP server
    service:
      name: vsftpd
      state: started
      enabled: yes
  - name: open firewall for FTP
    firewalld:
      service: ftp
      state: enabled
      permanent: yes
- name: setup the repo directory
  hosts: localhost
  tasks:
  - name: make directory
    file:
      path: /var/ftp/repo
      state: directory
  - name: download packages
    yum:
      name: nmap
      download_only: yes
      download_dir: /var/ftp/repo
  - name: createrepo
    command: createrepo /var/ftp/repo

2.2.2 管理 GPG 密钥

为保证软件包的完整性，大多数仓库都设置了 GPG 密钥。可使用 rpm_key 模块来获取和设置 GPG 密钥。示例剧本如下：

- name: use rpm_key in repository access
  hosts: all
  tasks:
  - name: get the GPG public key
    rpm_key:
      key: ftp://control.example.com/repo/RPM - GPG - KEY
      state: present
  - name: set up the repository client
    yum_repository:
      file: myrepo
      name: myrepo
      description: example repo
      baseurl: ftp://control.example.com/repo
      enabled: yes
      gpgcheck: yes
      state: present

2.2.3 管理 RHEL 订阅

使用 Red Hat Enterprise Linux 时，需要设置对订阅的访问。Ansible 提供了两个重要模块：
- redhat_subscription ：可在一个任务中完成订阅和注册。
- rhsm_repository ：可用于添加订阅管理器仓库。

示例剧本如下：

---
- name: use subscription manager to register and set up repos
  hosts: ansible5
  tasks:
  - name: register and subscribe ansible5
    redhat_subscription:
      username: bob@example.com
      password: verysecretpassword
      state: present
  - name: configure additional repo access
    rhsm_repository:
      name:
      - rh - gluster - 3 - client - for - rhel - 8 - x86_64 - rpms
      - rhel - 8 - for - x86_64 - appstream - debug - rpms
      state: present

2.3 实验练习

有两个实验练习：

2.3.1 练习 12 - 1：管理软件包

步骤如下：
1. 使用编辑器创建一个名为 exercise121.yaml 的新文件。
2. 编写一个剧本头，定义变量 my_package 并将其值设置为 virt - manager 。

---
- name: exercise121
  hosts: ansible2
  vars:
    my_package: virt - manager
  tasks:

3. 添加一个任务，根据提供的变量名称安装软件包。

- name: install package
  yum:
    name: "{{ my_package }}"
    state: present

4. 添加一个任务，收集已安装软件包的事实。

- name: update package facts
  package_facts:
    manager: auto

5. 添加一个任务，显示刚刚安装的软件包的事实。

- name: show package facts for {{ my_package }}
  debug:
    var: ansible_facts.packages[my_package]
  when: my_package in ansible_facts.packages

6. 使用 ansible - playbook exercise121.yaml 运行剧本并验证输出。

2.3.2 练习 12 - 2：设置仓库

步骤如下：
1. 使用编辑器创建 exercise122 - server.yaml 文件。
2. 定义设置基本 FTP 配置的剧本。

---
- name: install, configure, start and enable FTP
  hosts: localhost
  tasks:
  - name: install FTP server
    yum:
      name: vsftpd
      state: latest
  - name: allow anonymous access to FTP
    lineinfile:
      path: /etc/vsftpd/vsftpd.conf
      regexp: '^anonymous_enable = NO'
      line: anonymous_enable = YES
  - name: start FTP server
    service:
      name: vsftpd
      state: started
      enabled: yes
  - name: open firewall for FTP
    firewalld:
      service: ftp
      state: enabled
      immediate: yes
      permanent: yes

3. 设置仓库目录，添加相应的剧本。

- name: setup the repo directory
  hosts: localhost
  tasks:
  - name: make directory
    file:
      path: /var/ftp/repo
      state: directory
  - name: download packages
    yum:
      name: nmap
      download_only: yes
      download_dir: /var/ftp/repo
  - name: install createrepo package
    yum:
      name: createrepo_c
      state: latest
  - name: createrepo
    command: createrepo /var/ftp/repo
    notify:
    - restart_ftp
  handlers:
  - name: restart_ftp
    service:
      name: vsftpd
      state: restarted

4. 使用 ansible - playbook exercise122 - server.yaml 命令在 control.example.com 上设置 FTP 服务器。
5. 创建 exercise122 - client.yaml 文件并编写剧本头。

---
- name: configure repository
  hosts: all
  vars:
    my_package: nmap
  tasks:

6. 添加一个任务，使用 yum_repository 模块配置对新仓库的访问。

- name: connect to example repo
  yum_repository:
    name: exercise122
    description: RHCE8 exercise 122 repo
    file: exercise122
    baseurl: ftp://control.example.com/repo/
    gpgcheck: no

7. 添加一个任务，确保客户端能够通过名称访问仓库服务器。

- name: ensure control is resolvable
  lineinfile:
    path: /etc/hosts
    line: 192.168.4.200  control.example.com  control
- name: install package
  yum:
    name: "{{ my_package }}"
    state: present

8. 如果使用 package_facts 模块，安装新软件包后需要更新它。

- name: update package facts
  package_facts:
    manager: auto

通过以上步骤和示例，我们可以全面了解如何使用 Ansible 进行故障排除和软件管理。在实际应用中，可根据具体需求灵活运用这些知识和技巧。

三、总结与操作流程梳理

3.1 操作流程总结

为了更清晰地展示使用 Ansible 进行故障排除和软件管理的操作流程，下面通过 mermaid 流程图进行梳理。

graph LR
    classDef startend fill:#F5EBFF,stroke:#BE8FED,stroke-width:2px
    classDef process fill:#E5F6FF,stroke:#73A6FF,stroke-width:2px
    classDef decision fill:#FFF6CC,stroke:#FFBC52,stroke-width:2px

    A([开始]):::startend --> B{选择操作类型}:::decision
    B -->|故障排除| C(获取足够故障排除信息):::process
    B -->|软件管理| D(配置仓库访问):::process
    C --> C1(处理日志文件):::process
    C --> C2(使用检查模式):::process
    C --> C3(提高详细程度):::process
    C1 --> C4(检查日志内容定位问题):::process
    C2 --> C5(模拟任务执行查看结果):::process
    C3 --> C6(获取更详细任务信息):::process
    D --> D1(使用 yum_repository 模块):::process
    D1 --> D2(设置仓库参数):::process
    D2 --> D3(连接到仓库):::process
    D3 --> E(管理软件包):::process
    E --> E1(使用 yum 模块):::process
    E1 --> E2(安装/删除/更新软件包):::process
    E1 --> E3(安装软件包组/模块):::process
    E --> E4(使用 package_facts 模块):::process
    E4 --> E5(收集软件包事实):::process
    E5 --> E6(查看软件包详细信息):::process
    D3 --> F(设置仓库服务器):::process
    F --> F1(安装 FTP 软件包):::process
    F --> F2(启动并启用 FTP 服务器):::process
    F --> F3(打开防火墙):::process
    F --> F4(创建仓库目录):::process
    F --> F5(下载软件包到目录):::process
    F --> F6(生成仓库索引):::process
    F6 --> G(管理 GPG 密钥):::process
    G --> G1(使用 rpm_key 模块):::process
    G1 --> G2(获取和设置 GPG 密钥):::process
    G2 --> H(管理 RHEL 订阅):::process
    H --> H1(使用 redhat_subscription 模块):::process
    H --> H2(使用 rhsm_repository 模块):::process
    H1 --> H3(完成订阅和注册):::process
    H2 --> H4(添加订阅管理器仓库):::process
    C4 --> I([结束]):::startend
    C5 --> I
    C6 --> I
    E2 --> I
    E3 --> I
    E6 --> I
    H3 --> I
    H4 --> I

3.2 常见问题及解决方法

以下是在使用 Ansible 进行故障排除和软件管理过程中可能遇到的常见问题及解决方法列表：
| 问题描述 | 可能原因 | 解决方法 |
| ---- | ---- | ---- |
| 任务在检查模式下仍执行更改 | 任务配置参数错误 | 检查任务配置，确保不包含会导致实际执行的参数 |
| 无法连接到仓库 | 仓库地址错误、网络问题、GPG 检查失败 | 检查仓库地址是否正确，确保网络连接正常，若 GPG 检查失败，可尝试设置 gpgcheck: no 或获取正确的 GPG 密钥 |
| 软件包安装失败 | 仓库中无该软件包、依赖问题 | 检查仓库中是否存在该软件包，解决依赖问题，可使用 yum deplist 命令查看依赖信息 |
| 订阅注册失败 | 用户名或密码错误、网络问题 | 检查用户名和密码是否正确，确保网络连接正常，可使用 subscription-manager 命令手动测试注册 |

3.3 最佳实践建议

为了更高效地使用 Ansible 进行故障排除和软件管理，以下是一些最佳实践建议：
1. 日志管理 ：定期清理日志文件，避免日志文件过大影响系统性能。同时，设置合理的日志级别，以便在需要时能够快速定位问题。
2. 安全配置 ：使用 Ansible Vault 加密敏感信息，如用户名、密码等，避免在剧本中明文存储。
3. 模块化设计 ：将常用的任务封装成模块，提高剧本的复用性和可维护性。
4. 测试环境 ：在生产环境使用新的剧本或配置之前，先在测试环境进行充分测试，确保不会对生产系统造成影响。

3.4 总结

通过对 Ansible 故障排除和软件管理相关知识的学习，我们了解了如何获取足够的故障排除信息、使用不同模块进行软件包和仓库管理、处理 GPG 密钥和 RHEL 订阅等内容。同时，通过具体的操作步骤和示例代码，我们可以更好地掌握这些知识的实际应用。在实际工作中，我们可以根据具体需求灵活运用这些技巧，提高系统管理的效率和可靠性。

希望以上内容能够帮助你更好地理解和使用 Ansible 进行系统管理。如果你在实践过程中遇到任何问题，欢迎随时查阅相关文档或寻求社区帮助。