Что такое Ansible lineinfile?

Что такое Ansible модуль lineinfile?

Модуль lineinfile в Ansible — это один из ключевых инструментов для управления содержимым текстовых файлов на удалённых хостах. Его основная задача — гарантировать присутствие или отсутствие определённой строки в файле. В отличие от модулей template или copy, которые работают с файлами целиком, lineinfile работает точечно, изменяя только конкретные строки, что делает его идеальным для тонкой настройки конфигурационных файлов.

Основное назначение и сценарии использования

Главное предназначение lineinfile — идемпотентность конфигурации. Он гарантирует, что после выполнения задачи строка в файле будет находиться в нужном состоянии, независимо от того, сколько раз задача была запущена. Это фундаментальный принцип DevOps и инфраструктуры как кода (IaC).

Типичные сценарии использования:

• Настройка параметров в конфигурационных файлах (например, sshd_config, nginx.conf, sysctl.conf).
• Включение/отключение модулей или опций.
• Управление списками (например, списками пользователей в файле /etc/hosts.allow).
• Добавление или удаление переменных среды в shell-профилях.
• Быстрое исправление (hotfix) конфигурации без перезаписи всего файла.

Ключевые параметры модуля

Модуль обладает богатым набором параметров для гибкого управления:

• path (обязательный) — путь к целевому файлу.
• state — определяет целевое состояние строки (present — строка должна быть, absent — строка должна быть удалена).
• regexp — регулярное выражение для поиска заменяемой строки.
• line — собственно строка, которую нужно вставить или убедиться в её наличии.
• insertafter / insertbefore — указывают, куда вставить строку, если она не найдена (например, insertafter: EOF для вставки в конец файла).
• backrefs — важный параметр, который меняет логику работы при использовании групп в regexp. Если backrefs=yes и строка не найдена, файл не будет изменён.
• backup — создание резервной копии файла перед внесением изменений (yes/no).

Примеры практического применения

Пример 1: Гарантированное наличие параметра в SSH-конфиге Добавим или изменим строку PermitRootLogin no в файле /etc/ssh/sshd_config.

- name: Ensure root login is disabled via SSH
  ansible.builtin.lineinfile:
    path: /etc/ssh/sshd_config
    regexp: '^PermitRootLogin'
    line: 'PermitRootLogin no'
    state: present
  notify: restart sshd

Здесь regexp ищет строку, начинающуюся с PermitRootLogin, и заменяет её на нужное значение, независимо от текущего.

Пример 2: Добавление записи в файл hosts, если её ещё нет В этом случае мы хотим добавить строку только если её нет, и не изменять файл иным образом.

- name: Add localhost alias to /etc/hosts
  ansible.builtin.lineinfile:
    path: /etc/hosts
    line: '127.0.0.1 mylocalhost'
    state: present

Здесь мы опустили regexp, поэтому модуль будет искать точное совпадение всей строки.

Пример 3: Удаление строки по шаблону Удалим все строки, содержащие DEBUG, из конфигурационного файла приложения.

- name: Remove debug entries from app config
  ansible.builtin.lineinfile:
    path: /etc/myapp/config.conf
    regexp: '.*DEBUG.*'
    state: absent

Пример 4: Использование backrefs для сохранения части строки Допустим, нам нужно изменить значение параметра Listen, но сохранить возможный комментарий в конце строки.

- name: Change Apache Listen port and keep trailing comment
  ansible.builtin.lineinfile:
    path: /etc/apache2/ports.conf
    regexp: '^(Listen\s+)([0-9]+)(\s*#.*)?$'
    line: '\g<1>8080\g<3>'
    backrefs: yes

Если строка, соответствующая regexp, не найдена (файл пустой или параметр отсутствует), при backrefs=yes изменения не вносятся. Без backrefs строка из line была бы добавлена в конец файла.

Преимущества и ограничения

Преимущества:

• Точечность и безопасность: Не затрагивает остальное содержимое файла.
• Идемпотентность: Основа для надёжной автоматизации.
• Простота: Лёгок в понимании для простых операций.

Ограничения:

• Одна строка за раз: Неэффективен для массовых изменений множества строк. В таких случаях лучше использовать модули template или replace.
• Сложность с порядком строк: Управление позиционированием нескольких связанных строк может быть нетривиальным. Для этого существует модуль blockinfile.

Заключение

lineinfile — это незаменимый "скальпель" в арсенале DevOps-инженера, использующего Ansible. Он предназначен для точных, атомарных изменений в существующих файлах. Понимание его работы, особенно тонкостей взаимодействия параметров regexp, line и backrefs, критически важно для написания надёжных и предсказуемых плейбуков, управляющих конфигурацией инфраструктуры. Для более комплексных правок стоит рассмотреть другие модули, но для единичных строк lineinfile остаётся инструментом выбора.