Ресурс ohai

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

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

Используйте ресурс ohai для перезагрузки конфигурации Ohai на узле. Это позволяет рецептам, которые изменяют системные атрибуты (например, рецепт, который добавляет пользователя), ссылаться на эти атрибуты позже во время выполнения Chef Infra Client.

Синтаксис

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

ohai 'name' do
  plugin      String
  action      Symbol # defaults to :reload if not specified
end

где:

• ohai — это ресурс.
• name — это имя блока ресурса.
• action определяет действия, которые Chef Infra Client предпримет, чтобы привести узел в нужное состояние.
• plugin — это свойство, доступное для данного ресурса.

Действия

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

:nothing

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

:reload

Перезагружает данные Ohai. (по умолчанию)

Свойства

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

plugin

Тип в Ruby: Строка

Конкретные данные атрибутов Ohai для перезагрузки. Это свойство ведет себя подобно указанию атрибутов при запуске Ohai в командной строке и принимает атрибут, который вы хотите перезагрузить, вместо фактического имени плагина. Например, вы можете передать ipaddress для перезагрузки node['ipaddress'], даже несмотря на то, что эти данные поступают от плагина Network. Если это свойство не указано, 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: Целое число | Значение по умолчанию: 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.

Примеры

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

Перезагрузка всех плагинов Ohai

ohai 'reload' do
  action :reload
end

Перезагрузка одного плагина Ohai

ohai 'reload' do
  plugin 'ipaddress'
  action :reload
end

Перезагрузка Ohai после создания нового пользователя

ohai 'reload_passwd' do
  action :nothing
  plugin 'etc'
end

user 'daemon_user' do
  home '/dev/null'
  shell '/sbin/nologin'
  system true
  notifies :reload, 'ohai[reload_passwd]', :immediately
end

ruby_block 'just an example' do
  block do
    # These variables will now have the new values
    puts node['etc']['passwd']['daemon_user']['uid']
    puts node['etc']['passwd']['daemon_user']['gid']
  end
end