Ресурс homebrew_tap

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

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

Используйте ресурс homebrew_tap для добавления дополнительных формульных репозиториев в менеджер пакетов Homebrew.

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

Синтаксис

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

homebrew_tap 'name' do
  full               true, false # default value: false
  homebrew_path      String # default value: "/usr/local/bin/brew"
  owner              String
  tap_name           String # default value: 'name' unless specified
  url                String
  action             Symbol # defaults to :tap if not specified
end

где:

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

Действия

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

:nothing

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

:tap

По умолчанию. Добавляет формульный репозиторий Homebrew.

:untap

Удаляет формульный репозиторий Homebrew.

Свойства

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

full

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

Выполнить полное клонирование репозитория, а не поверхностное.

homebrew_path

Тип Ruby: Строка | Значение по умолчанию: /usr/local/bin/brew

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

owner

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

Владелец установки Homebrew.

tap_name

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

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

url

Тип Ruby: Строка

URL репозитория.

Общие функциональные возможности ресурсов

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

Уведомления

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.

Примеры

У этого ресурса нет примеров.