Ресурс inspec_input

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

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

Используйте ресурс inspec_input для добавления ввода в фазу соответствия.

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

Синтаксис

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

inspec_input 'name' do
  input       Hash, String # default value: 'name' unless specified
  source      Hash, String # default value: 'name' unless specified
  action      Symbol # defaults to :add if not specified
end

где:

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

Действия

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

:add

Добавление ввода в фазу соответствия (по умолчанию)

:nothing

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

Свойства

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

input

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

source

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

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

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

Примеры

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

Активировать ввод по умолчанию в сегменте соответствия кулинарии openssh:

  inspec_input 'openssh' do
    action :add
  end

Активировать все вводы в сегменте соответствия кулинарии openssh:

  inspec_input 'openssh::.*' do
    action :add
  end

Добавить ввод InSpec в фазу соответствия из хэша:

  inspec_input { ssh_custom_path: '/whatever2' }

Добавить ввод InSpec в фазу соответствия, используя свойство «name» для идентификации ввода:

  inspec_input "setting my input" do
    source( { ssh_custom_path: '/whatever2' })
  end

Добавить ввод InSpec в фазу соответствия, используя файл TOML, JSON или YAML:

  inspec_input "/path/to/my/input.yml"

Добавить ввод InSpec в фазу соответствия, используя файл TOML, JSON или YAML, используя свойство «name»:

  inspec_input "setting my input" do
    source "/path/to/my/input.yml"
  end

Обратите внимание, что ресурс inspec_input не обновляется и не запускает уведомления (подобно ресурсу log). Это делается для сохранения возможности использования ресурса, не увеличивая счетчик обновленных ресурсов больше нуля. Поскольку ресурс не обновляет состояние управляемого узла, это поведение по-прежнему соответствует модели управления конфигурацией. Вместо этого вы должны использовать события для наблюдения за изменениями конфигурации фазы соответствия. Можно использовать ресурс notify_group для цепочки уведомлений двух ресурсов, но уведомления — это неправильная модель, и вы должны использовать чистые условные операторы ruby вместо этого. Конфигурация соответствия должна быть независимой от других ресурсов и должна зависеть только от состояния/атрибутов, а не от других ресурсов.