Ресурс systemd_unit

Редактировать эту страницу в репозитории Chef

Страница справки по ресурсам

Используйте ресурс systemd_unit для создания, управления и запуска единиц systemd.

Новое в Chef Infra Client 12.11.

Синтаксис

Полный синтаксис всех свойств, доступных для ресурса systemd_unit:

systemd_unit 'name' do
  content              String, Hash
  triggers_reload      true, false # default value: true
  unit_name            String # default value: 'name' unless specified
  user                 String
  verify               true, false # default value: true
  action               Symbol # defaults to :nothing if not specified
end

где:

• systemd_unit — это ресурс.
• name — это имя, заданное для блока ресурса.
• action определяет, какие шаги Chef Infra Client предпримет для приведения узла в нужное состояние.
• content, triggers_reload, unit_name, user, и verify — это доступные для этого ресурса свойства.

Действия

Ресурс systemd_unit имеет следующие действия:

:create

Создать файл единицы, если он ещё не существует.

:delete

Удалить файл единицы, если он существует.

:disable

Обеспечить, чтобы единица не запускалась после следующей перезагрузки системы.

:enable

Обеспечить, чтобы единица запускалась после следующей перезагрузки системы.

:mask

Обеспечить, чтобы единица не запускалась, даже для удовлетворения зависимостей.

:nothing

По умолчанию. Ничего не делать с единицей.

:preset

Восстановить предварительно заданную конфигурацию «включить/отключить» для единицы. Новое в Chef Client 14.0.

:reenable

Вновь включить файл единицы. Новое в Chef Client 14.0.

:reload

Перезагрузить файл конфигурации для единицы.

:reload_or_restart

Для единиц, являющихся сервисами, это действие перезагружает конфигурацию сервиса без перезапуска, если это возможно; в противном случае оно перезапустит сервис, чтобы применить новую конфигурацию.

:reload_or_try_restart

Для единиц, являющихся сервисами, это действие перезагружает конфигурацию сервиса без перезапуска, если это возможно; в противном случае оно попытается перезапустить сервис, чтобы применить новую конфигурацию.

:restart

Перезапустить единицу.

:revert

Вернуться к версии файла единицы поставщика. Новое в Chef Client 14.0.

:start

Запустить единицу, основанную на её файле единицы systemd.

:stop

Остановить запущенную единицу.

:try_restart

Попробовать перезапустить единицу, если она запущена.

:unmask

Остановить маскировку единицы и запустить её согласно указаниям.

Свойства

Ресурс systemd_unit имеет следующие свойства:

content

Тип в Ruby: Строка, Хэш

Строка или хэш, содержащий определение файла единицы systemd файла единицы, описывающий свойства управляемых systemd сущностей, таких как службы, сокеты, устройства и так далее. В Chef Infra Client 14.4 или более поздней версии можно реализовать повторяемые параметры с помощью массива.

triggers_reload

Тип в Ruby: true, false | Значение по умолчанию: true

Указывает, следует ли инициировать перезагрузку демона при создании или удалении единицы.

unit_name

Тип в Ruby: Строка | Значение по умолчанию: The resource block's name

Имя файла единицы, если оно отличается от имени блока ресурса.

Новое в Chef Client 13.7

user

Тип в Ruby: Строка

Учётная запись пользователя, под которой выполняется процесс единицы systemd. Путь к единице для этого пользователя будет примерно таким: ‘/etc/systemd/user/sshd.service’. Если учётная запись пользователя не указана, единица systemd будет выполняться под учётной записью «system», а путь к единице будет примерно таким: ‘/etc/systemd/system/sshd.service’.

verify

Тип в Ruby: true, false | Значение по умолчанию: true

Указывает, будет ли единица проверена перед установкой. Systemd может быть слишком строгим при проверке единиц, поэтому в некоторых случаях предпочтительно не проверять единицу.

Проверка файла единицы

Файл единицы проверяется с помощью вызова systemd-analyze verify перед записью на диск.

Обратите внимание, что указанные команды и файлы должны существовать до проверки.

Общие функции ресурсов

Ресурсы Chef включают общие свойства, уведомления и защитные механизмы ресурсов.

Общие свойства

Следующие свойства общие для всех ресурсов:

compile_time

Тип в Ruby: true, false | Значение по умолчанию: false

Управление фазой, в которой ресурс выполняется на узле. Установите в значение true, чтобы запустить его, пока собирается коллекция ресурсов (compile phase). Установите в значение false, чтобы запустить его, когда Chef Infra Client настраивает узел (converge phase).

ignore_failure

Тип в Ruby: true, false, :quiet | Значение по умолчанию: false

Продолжить выполнение рецепта, если ресурс завершился неудачей по какой-либо причине. При значении :quiet не будет отображаться полный стек вызовов, и рецепт продолжит выполнение, если ресурс завершился неудачей.

retries

Тип в Ruby: Целое число | Значение по умолчанию: 0

Количество попыток перехвата исключений и повторной попытки ресурса.

retry_delay

Тип в Ruby: Целое число | Значение по умолчанию: 2

Задержка повторной попытки (в секундах).

sensitive

Тип в Ruby: true, false | Значение по умолчанию: false

Обеспечить, чтобы конфиденциальные данные ресурсов не регистрировались Chef InfraClient.

Уведомления

notifies

Тип в Ruby: Символ, 'Chef::Resource[String]'

Ресурс может уведомить другой ресурс о выполнении действия при изменении его состояния. Укажите 'resource[name]', :action действие, которое должен выполнить ресурс, и :timer для этого действия. Один ресурс может уведомлять несколько ресурсов; для каждого уведомляемого ресурса используйте инструкцию notifies.

Если указанный ресурс не существует, возникает ошибка. В отличие от этого, subscribes не завершится ошибкой, если исходный ресурс не найден.

Таймер определяет момент во время выполнения Chef Infra Client, в который выполняется уведомление. Доступны следующие таймеры:

:before

Указывает, что действие над уведомлённым ресурсом должно выполняться до обработки блока ресурса, в котором находится уведомление.

:delayed

По умолчанию. Указывает, что уведомление должно быть помещено в очередь и выполнено в конце выполнения Chef Infra Client.

:immediate, :immediately

Указывает, что уведомление должно быть выполнено немедленно для каждого уведомлённого ресурса.

Синтаксис для notifies:

notifies :action, 'resource[name]', :timer

subscribes

Тип в Ruby: Символ, 'Chef::Resource[String]'

Ресурс может прослушивать другой ресурс и выполнять действие, если состояние прослушиваемого ресурса меняется. Укажите 'resource[name]', действие, которое необходимо выполнить, и :timer для этого действия.

Обратите внимание, что subscribes не применяет указанное действие к ресурсу, за которым он следит — например:

file '/etc/nginx/ssl/example.crt' do
  mode '0600'
  owner 'root'
end

service 'nginx' do
  subscribes :reload, 'file[/etc/nginx/ssl/example.crt]', :immediately
end

В этом случае свойство subscribes перезагружает службу nginx всякий раз, когда обновляется её сертификат, расположенный в /etc/nginx/ssl/example.crt. subscribes не вносит никаких изменений в сам файл сертификата, а просто следит за изменениями в файле и выполняет действие :reload для своего ресурса (в этом примере nginx) при обнаружении изменений.

Если другой ресурс не существует, подписка не вызовет ошибку. В отличие от этого, более строгое notifies, вызовет ошибку, если другого ресурса не существует.

Таймер определяет момент во время выполнения Chef Infra Client, в который выполняется уведомление. Доступны следующие таймеры:

:before

Указывает, что действие над уведомлённым ресурсом должно выполняться до обработки блока ресурса, в котором находится уведомление.

:delayed

По умолчанию. Указывает, что уведомление должно быть помещено в очередь и выполнено в конце выполнения Chef Infra Client.

:immediate, :immediately

Указывает, что уведомление должно быть выполнено немедленно для каждого уведомлённого ресурса.

Синтаксис для subscribes:

subscribes :action, 'resource[name]', :timer

Защитные механизмы

Свойство защитного механизма может использоваться для оценки состояния узла во время фазы выполнения Chef Infra Client. На основании результатов этой оценки свойство защитного механизма сообщает Chef Infra Client, следует ли продолжить выполнение ресурса. Свойство защитного механизма принимает строковое значение или значение блока Ruby:

• Строка выполняется как команда оболочки. Если команда возвращает 0, защитный механизм применяется. Если команда возвращает любое другое значение, то свойство защитного механизма не применяется. Строковые защитные механизмы в powershell_script выполняют команды Windows PowerShell и могут возвращать true в дополнение к 0.
• Блок выполняется как код Ruby, который должен вернуть либо true или false. Если блок возвращает true, защитный механизм применяется. Если блок возвращает false, защитный механизм не применяется.

Свойство сторожа полезно для обеспечения идемпотентности ресурса, позволяя этому ресурсу проверять желаемое состояние во время выполнения, а затем, если желаемое состояние присутствует, Chef Infra Client ничего не делать.

Следующие свойства могут использоваться для определения сторожа, который оценивается во время фазы выполнения выполнения Chef Infra Client:

not_if

Предотвратить выполнение ресурса, когда условие возвращает true.

only_if

Разрешить выполнение ресурса только если условие возвращает true.

Примеры

Следующие примеры демонстрируют различные подходы к использованию ресурса systemd_unit в рецептах:

Создание файла системного сервисного блока systemd из Hash

systemd_unit 'etcd.service' do
  content({Unit: {
            Description: 'Etcd',
            Documentation: ['https://coreos.com/etcd', 'man:etcd(1)'],
            After: 'network.target',
          },
          Service: {
            Type: 'notify',
            ExecStart: '/usr/local/etcd',
            Restart: 'always',
          },
          Install: {
            WantedBy: 'multi-user.target',
          }})
  action [:create, :enable]
end

Создание файла системного сервисного блока systemd из строки

systemd_unit 'sysstat-collect.timer' do
  content <<~EOU
  [Unit]
  Description=Run system activity accounting tool every 10 minutes

  [Timer]
  OnCalendar=*:00/10

  [Install]
  WantedBy=sysstat.service
  EOU

  action [:create, :enable]
end