Ресурс cab_package

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

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

Используйте ресурс cab_package для установки или удаления пакетов Microsoft Windows cabinet (.cab).

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

Синтаксис

Полный синтаксис всех свойств ресурса cab_package:

cab_package 'name' do
  options           String, Array
  package_name      String
  source            String # default value: The package name.
  timeout           String, Integer
  version           String
  action            Symbol # defaults to :install if not specified
end

где:

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

Действия

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

:install

Устанавливает пакет cabinet.

:remove

Удаляет пакет cabinet.

Свойства

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

options

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

Один или несколько дополнительных параметров команд, передаваемых команде.

package_name

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

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

source

Тип в Ruby: Строка | Значение по умолчанию: The package name.

Локальный путь к файлу или URL-адрес пакета CAB.

timeout

Тип в Ruby: Строка, Целое число

Время ожидания (в секундах) перед истечением времени.

version

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

Версия пакета для установки или обновления.

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

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

Примеры

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

Использование локального пути в источнике

cab_package 'Install .NET 3.5 sp1 via KB958488' do
  source 'C:\Users\xyz\AppData\Local\Temp\Windows6.1-KB958488-x64.cab'
  action :install
end

cab_package 'Remove .NET 3.5 sp1 via KB958488' do
  source 'C:\Users\xyz\AppData\Local\Temp\Windows6.1-KB958488-x64.cab'
  action :remove
end

Использование URL-адреса в источнике

cab_package 'Install .NET 3.5 sp1 via KB958488' do
  source 'https://s3.amazonaws.com/my_bucket/Windows6.1-KB958488-x64.cab'
  action :install
end

cab_package 'Remove .NET 3.5 sp1 via KB958488' do
  source 'https://s3.amazonaws.com/my_bucket/Temp\Windows6.1-KB958488-x64.cab'
  action :remove
end