cron Ресурс

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

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

Используйте ресурс cron для управления записями cron для планирования задач по времени. Свойства для расписания по умолчанию установлены в * если не указаны. Для работы с ресурсом cron требуется доступ к программе crontab, обычно cron.

Синтаксис

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

cron 'name' do
  command          String
  day              Integer, String # default value: "*"
  environment      Hash # default value: {}
  home             String
  hour             Integer, String # default value: "*"
  mailto           String
  minute           Integer, String # default value: "*"
  month            Integer, String # default value: "*"
  path             String
  shell            String
  time             Symbol
  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 — это ресурс.
• name — имя блока ресурса.
• action определяет шаги, которые Chef Infra Client выполнит для приведения узла к нужному состоянию.
• command, day, environment, home, hour, mailto, minute, month, path, shell, time, time_out, user, и weekday — доступные для этого ресурса свойства.

Действия

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

:create

Создает запись в файле таблицы cron (crontab). Если запись уже существует (но не соответствует), обновляет её, чтобы она соответствовала. (по умолчанию)

:delete

Удаляет запись из файла таблицы cron (crontab).

:nothing

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

Свойства

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

command

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

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

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).

month

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

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

path

Тип Ruby: Строка

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

shell

Тип Ruby: Строка

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

time

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

Интервал времени.

time_out

Тип Ruby: Словарь | Значение по умолчанию: {}

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

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

Новое в Chef Infra Client 15.7

user

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

Имя пользователя, который выполняет команду. Если свойство user изменено, исходный пользователь для программы crontab продолжает работать до тех пор, пока эта программа crontab не будет удалена. Это свойство не применимо к платформе AIX.

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[Строка]'

Ресурс может уведомить другой ресурс о действии при изменении его состояния. Укажите '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[Строка]'

Ресурс может прослушивать другой ресурс и выполнять действие, если состояние прослушиваемого ресурса изменится. Укажите '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.

Примеры

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

Запуск программы с заданным интервалом

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

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

cron '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 утра

Следующий пример показывает расписание, которое будет выполняться каждый час в 8:00 каждую субботу утром, а затем отправлять электронное письмо на «admin@example.com» после каждого запуска.

cron 'name_of_cron_entry' do
  minute '0'
  hour '8'
  weekday '6'
  mailto 'admin@example.com'
  action :create
end

Запуск один раз в неделю

cron 'cookbooks_report' do
  minute '0'
  hour '0'
  weekday '1'
  user 'chefio'
  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(' ')
  action :create
end

Запуск только в ноябре

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

cron 'name_of_cron_entry' do
  minute '0'
  hour '20'
  day '*'
  month '11'
  weekday '1-5'
  action :create
end