Ресурс chef_client_launchd

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

Страница ссылок на ресурсы

Используйте ресурс chef_client_launchd для настройки запуска клиента Chef Infra Client по расписанию.

Новое в Chef Infra Client 16.5.

Синтаксис

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

chef_client_launchd 'name' do
  accept_chef_license      true, false # default value: false
  chef_binary_path         String # default value: "/opt/chef/bin/chef-client"
  config_directory         String # default value: "/etc/chef"
  daemon_options           Array
  environment              Hash
  interval                 Integer, String # default value: 30
  log_directory            String # default value: "/Library/Logs/Chef"
  log_file_name            String # default value: "client.log"
  low_priority_io          true, false # default value: true
  nice                     Integer, String
  splay                    Integer, String # default value: 300
  user                     String # default value: "root"
  working_directory        String # default value: "/var/root"
  action                   Symbol # defaults to :enable if not specified
end

где:

• chef_client_launchd — это ресурс.
• name — это имя, данное блоку ресурса.
• action определяет, какие шаги предпримет клиент Chef Infra Client для приведения узла в желаемое состояние.
• accept_chef_license, chef_binary_path, config_directory, daemon_options, environment, interval, log_directory, log_file_name, low_priority_io, nice, splay, user, и working_directory — это свойства, доступные для этого ресурса.

Действия

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

:disable

Отключить запуск клиента Chef Infra Client по расписанию с помощью launchd

:enable

Включить запуск клиента Chef Infra Client по расписанию с помощью launchd

:nothing

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

Свойства

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

accept_chef_license

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

Принять Лицензионное соглашение и соглашение об услугах Chef Online Master. См. https://www.chef.io/online-master-agreement/

chef_binary_path

Тип Ruby: String | Значение по умолчанию: /opt/chef/bin/chef-client

Путь к бинарному файлу chef-client.

config_directory

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

Путь к каталогу конфигурации.

daemon_options

Тип Ruby: Array

Массив параметров для передачи команде chef-client.

environment

Тип Ruby: Hash

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

interval

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

Время в минутах между запусками клиента Chef Infra Client.

log_directory

Тип Ruby: String | Значение по умолчанию: /Library/Logs/Chef

Путь к каталогу, в котором будет создан файл журнала.

log_file_name

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

Имя файла журнала для использования.

low_priority_io

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

Запустить процесс chef-client с низким приоритетом ввода-вывода на диск

nice

Тип Ruby: Integer, String

Приоритет процесса для запуска процесса chef-client. Значение -20 — это самый высокий приоритет, а 19 — самый низкий приоритет.

splay

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

Случайное количество секунд от 0 до X, которое нужно добавить к интервалу, чтобы не все команды chef-client выполнялись одновременно.

user

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

Имя пользователя, от которого запускается клиент Chef Infra Client.

working_directory

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

Рабочий каталог, из которого запускается клиент Chef Infra Client.

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

Ресурсы 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

Средства защиты

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

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

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

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

not_if

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

only_if

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

Примеры

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

Настройка Chef Infra Client для запуска по расписанию:

chef_client_launchd 'Setup the Chef Infra Client to run every 30 minutes' do
  interval 30
  action :enable
end

Отключение запуска Chef Infra Client по расписанию:

chef_client_launchd 'Prevent the Chef Infra Client from running on a schedule' do
  action :disable
end