Ресурс cron_d

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

Все страницы ресурсов Infra

Используйте ресурс cron_d для управления файлами задач cron в каталоге /etc/cron.d.

Новинка в Chef Infra Client 14.4.

Синтаксис

Блок ресурса cron_d управляет файлами cron.d. Например, чтобы получить еженедельный отчет о сборке кулинарных рецептов из Chef Supermarket:

cron_d 'cookbooks_report' do
  action :create
  minute '0'
  hour '0'
  weekday '1'
  user 'getchef'
  mailto 'sysadmin@example.com'
  home '/srv/supermarket/shared/system'
  command %W{
    cd /srv/supermarket/current &&
    env RUBYLIB="/srv/supermarket/current/lib"
    RAILS_ASSET_ID=`git rev-parse HEAD` RAILS_ENV="#{rails_env}"
    bundle exec rake cookbooks_report
  }.join(' ')
end

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

cron_d 'name' do
  command               String
  comment               String
  cron_name             String # default value: 'name' unless specified
  day                   Integer, String # default value: "*"
  environment           Hash # default value: {}
  home                  String
  hour                  Integer, String # default value: "*"
  mailto                String
  minute                Integer, String # default value: "*"
  mode                  String, Integer # default value: "0600"
  month                 Integer, String # default value: "*"
  path                  String
  predefined_value      String
  random_delay          Integer
  shell                 String
  time_out              Hash # default value: {}
  user                  String # default value: "root"
  weekday               Integer, String, Symbol # default value: "*"
  action                Symbol # defaults to :create if not specified
end

где:

• cron_d — это ресурс.
• name — это имя, присвоенное блоку ресурса.
• action определяет шаги, которые Chef Infra Client предпримет для приведения узла к желаемому состоянию.
• command, comment, cron_name, day, environment, home, hour, mailto, minute, mode, month, path, predefined_value, random_delay, shell, time_out, user, и weekday — это доступные свойства для данного ресурса.

Действия

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

:create

(по умолчанию)

:create_if_missing

Добавить файл определения cron в /etc/cron.d, но не обновлять существующий файл.

:delete

Удалить файл определения cron из /etc/cron.d, если он существует.

:nothing

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

Свойства

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

command

Тип Ruby: Строка | REQUIRED

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

comment

Тип Ruby: Строка

Комментарий, который нужно поместить в файл cron.d.

cron_name

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

Необязательное свойство для установки имени cron, если оно отличается от имени блока ресурса.

day

Тип Ruby: Целое число, строка | Значение по умолчанию: *

День месяца, в который должна выполняться запись cron (1 - 31).

environment

Тип Ruby: Массив | Значение по умолчанию: {}

Массив, содержащий дополнительные произвольные переменные среды, в которых будет выполняться задача cron в формате ({'ENV_VARIABLE' => 'VALUE'}). Примечание: эти переменные должны существовать, чтобы команда выполнялась успешно.

home

Тип Ruby: Строка

Установите переменную среды HOME.

hour

Тип Ruby: Целое число, строка | Значение по умолчанию: *

Час, в который должна выполняться запись cron (0 - 23).

mailto

Тип Ruby: Строка

Установите переменную среды MAILTO.

minute

Тип Ruby: Целое число, строка | Значение по умолчанию: *

Минута, в которую должна выполняться запись cron (0 - 59).

mode

Тип Ruby: Строка, целое число | Значение по умолчанию: 0600

Восьмеричный режим генерируемого файла crontab.

month

Тип Ruby: Целое число, строка | Значение по умолчанию: *

Месяц в году, в который должна выполняться запись cron (1 - 12, jan-dec, или *).

path

Тип Ruby: Строка

Установите переменную среды PATH.

predefined_value

Тип Ruby: Строка Допустимые значения: "@annually", "@daily", "@hourly", "@midnight", "@monthly", "@reboot", "@weekly", "@yearly"

Настройте задачу cron с помощью одного из предопределенных специальных значений вместо шаблона ** *.

random_delay

Тип Ruby: Целое число

Установите переменную среды RANDOM_DELAY в файле cron.d.

shell

Тип Ruby: Строка

Установите переменную среды SHELL.

time_out

Тип Ruby: Массив | Значение по умолчанию: {}

Массив тайм-аутов в формате ({'OPTION' => 'VALUE'}). Принятые допустимые значения:

• preserve-status (BOOL, по умолчанию: ‘false’),
• foreground (BOOL, по умолчанию: ‘false’),
• kill-after (в секундах),
• signal (имя, например, ‘HUP’, или число)

Новая функция в Chef Infra Client 15.7

user

Тип Ruby: Строка | Значение по умолчанию: root

Имя пользователя, который выполняет команду.

weekday

Тип Ruby: Целое число, строка, символ | Значение по умолчанию: *

День недели, в который должна выполняться запись (0-7, mon-sun, monday-sunday, или *), где воскресенье — это как 0 так и 7.

Общие возможности ресурсов

Ресурсы 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]', действие, которое нужно выполнить, и :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.

Примеры

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

Запуск программы в пятом часу дня

cron_d 'noop' do
  hour '5'
  minute '0'
  command '/bin/true'
end

Запуск записи, если папка существует

cron_d 'ganglia_tomcat_thread_max' do
  command "/usr/bin/gmetric
    -n 'tomcat threads max'
    -t uint32
    -v '/usr/local/bin/tomcat-stat
    --thread-max'"
  only_if { ::File.exist?('/home/jboss') }
end

Запуск записи каждую субботу в 8:00 утра

cron_d 'name_of_cron_entry' do
  minute '0'
  hour '8'
  weekday '6'
  mailto 'admin@example.com'
  command '/bin/true'
  action :create
end

Запуск записи в 20:00 каждый будний день (с понедельника по пятницу), но только в ноябре

cron_d 'name_of_cron_entry' do
  minute '0'
  hour '20'
  day '*'
  month '11'
  weekday '1-5'
  command '/bin/true'
  action :create
end

Удаление задачи cron по имени:

cron_d 'job_to_remove' do
  action :delete
end