Ресурс cron_d

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

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

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

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

:create_if_missing

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

:delete

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

:nothing

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

Свойства

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

command

Тип Ruby: String | REQUIRED

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

comment

Тип Ruby: String

Комментарий для размещения в файле cron.d.

cron_name

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

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

day

Тип Ruby: Integer, String | Значение по умолчанию: *

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

environment

Тип Ruby: Hash

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

home

Тип Ruby: String

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

hour

Тип Ruby: Integer, String | Значение по умолчанию: *

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

mailto

Тип Ruby: String

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

minute

Тип Ruby: Integer, String | Значение по умолчанию: *

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

mode

Тип Ruby: String, Integer | Значение по умолчанию: "0600"

Октальный режим сгенерированного файла crontab.

month

Тип Ruby: Integer, String | Значение по умолчанию: *

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

path

Тип Ruby: String

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

predefined_value

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

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

random_delay

Тип Ruby: Integer

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

shell

Тип Ruby: String

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

time_out

Тип Ruby: Hash

Хэш таймаутов в виде ({'OPTION' => 'VALUE'}). Допустимые параметры:

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

Новое в Chef Infra Client 15.7

user

Тип Ruby: String | Значение по умолчанию: root

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

weekday

Тип Ruby: Integer, String, Symbol | Значение по умолчанию: *

День недели, в который должна выполняться эта запись (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: Integer | Значение по умолчанию: 0

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

retry_delay

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

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

sensitive

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

Убедитесь, что конфиденциальные данные ресурса не регистрируются Chef InfraClient.

Уведомления

notifies

Тип Ruby: Symbol, '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: Symbol, '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.

Примеры

В следующих примерах показаны различные подходы к использованию ресурса 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