smartos_package Resource — Chef 16

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

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

Используйте ресурс smartos_package для управления пакетами для платформы SmartOS.

Примечание

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

Синтаксис

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

smartos_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

где:

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

Действия

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

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

Свойства

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

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

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

Примеры

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

smartos_package Ресурс