ips_package Resource — Chef 16

Эта страница сгенерирована из исходного кода Chef. Чтобы предложить изменение, отредактируйте файл ips_package.rb и отправьте запрос на вытягивание в репозиторий Chef.

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

Используйте ресурс ips_package для управления пакетами (используя систему упаковки изображений (IPS)) на платформе Solaris 11.

Примечание

Во многих случаях лучше использовать ресурс package вместо этого. Это связано с тем, что когда ресурс package используется в рецепте, Chef Infra Client будет использовать данные, собранные Ohai в начале выполнения Chef Infra Client, чтобы определить правильное приложение пакета. Использование ресурса package позволяет автору рецепта использовать его на многих платформах.

Синтаксис

Блок ресурса ips_package управляет пакетом на узле, обычно устанавливая его. Самое простое использование ресурса ips_package:

ips_package 'package_name'

что установит пакет с заданным именем, используя все значения по умолчанию и стандартное действие (:install).

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

ips_package 'name' do
  accept_license             true, false # default value: false
  options                    String
  package_name               String, Array
  source                     String
  timeout                    String, Integer
  version                    String, Array
  action                     Symbol # defaults to :install if not specified
end

где:

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

Действия

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

:install: По умолчанию. Установить пакет. Если указана версия, установить указанную версию пакета.
:nothing: Этот блок ресурса не выполняет действий, пока не получит уведомление от другого ресурса о выполнении действия. После уведомления этот блок ресурса либо выполняется немедленно, либо помещается в очередь для выполнения в конце выполнения Chef Infra Client.
:remove: Удалить пакет.
:upgrade: Установить пакет и/или убедиться, что пакет является последней версией.

Свойства

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

accept_license: Тип Ruby: true, false | Значение по умолчанию: false
Принять лицензионное соглашение с конечным пользователем автоматически.

options: Тип Ruby: Строка
Дополнительные параметры команды (или несколько), передаваемые команде.

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

source: Тип Ruby: Строка
Необязательный путь к пакету в локальной файловой системе.

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, которая вызовет ошибку, если другой ресурс не существует.

: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.

Примеры

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

Установить пакет

ips_package 'name of package' do
  action :install
end

Ресурс ips_package