Ресурс systemd_unit

Изменить эту страницу в репозитории Chef

Страница всех ресурсов Infra

Используйте ресурс 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

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

:delete

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

:disable

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

:enable

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

:mask

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

:nothing

Этот блок ресурса не действует, пока другой ресурс не уведомит его о действии. После уведомления этот блок ресурса либо выполняется немедленно, либо ставится в очередь для выполнения в конце выполнения Chef Infra Client.

:preset

Восстанавливает предопределенную конфигурацию ‘enable/disable’ для единицы systemd. Новое в Chef Infra Client 14.0.

:reenable

Вновь разрешает файл единицы. Новое в Chef Infra Client 14.0.

:reload

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

:reload_or_restart

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

:reload_or_try_restart

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

:restart

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

:revert

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

:start

Запускает единицу systemd.

:stop

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

:try_restart

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

:unmask

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

Свойства

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

content

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

Строка или хэш, содержащий определение файла единицы systemd unit file, описывающий свойства управляемых 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 Infra Client.

Уведомления

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]', :action действия и :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 из хэша

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