Ресурс bff_package

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

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

Используйте ресурс bff_package для управления пакетами для платформы AIX с помощью утилиты installp. При установке пакета из локального файла он должен быть добавлен в узел с помощью ресурсов remote_file или cookbook_file.

Синтаксис

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

bff_package 'name' do
  options           String, Array
  package_name      String
  source            String
  timeout           String, Integer
  version           String
  action            Symbol # defaults to :install if not specified
end

где:

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

Действия

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

:install

По умолчанию. Устанавливает пакет. Если указана версия, устанавливает указанную версию пакета.

:nothing

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

:purge

Очистка пакета. Это действие обычно удаляет как конфигурационные файлы, так и сам пакет.

:remove

Удаление пакета.

Свойства

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

options

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

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

package_name

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

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

source

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

Обязательное. Путь к пакету в локальной файловой системе. Платформа AIX требует, чтобы source был путем в локальной файловой системе, поскольку installp не извлекает пакеты с помощью HTTP или FTP.

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[Строка]'

Ресурс может уведомить другой ресурс о выполнении действия при изменении его состояния. Укажите '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[Строка]'

Ресурс может прослушивать другой ресурс и выполнять действие, если состояние прослушиваемого ресурса изменяется. Укажите '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.

Примеры

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

Ресурс bff_package является поставщиком пакета по умолчанию для платформы AIX. Базовый ресурс package может быть использован, и когда платформа — AIX, Chef Infra Client определит правильного поставщика пакета. Следующие примеры показывают, как установить часть компилятора IBM XL C/C++.

Установка с помощью базового ресурса package

package 'xlccmp.13.1.0' do
  source '/var/tmp/IBM_XL_C_13.1.0/usr/sys/inst.images/xlccmp.13.1.0'
  action :install
end

Установка с помощью ресурса bff_package