paludis_package Resource — Chef 16

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

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

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

Синтаксис

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

paludis_package 'package_name'

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

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

paludis_package 'name' do
  options           String
  package_name      String
  source            String
  timeout           Integer # default value: 3600
  version           String
  action            Symbol # defaults to :install if not specified
end

где:

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

Действия

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

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

Свойства

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

options: Тип в Ruby: Строка
Один или несколько дополнительных параметров команды, передаваемых в команду.

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

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

timeout: Тип в Ruby: Строка, Целое число | Значение по умолчанию: 3600
Время ожидания (в секундах) перед истечением времени ожидания.

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

Защитные свойства

Свойство guard может использоваться для оценки состояния узла во время фазы выполнения Chef Infra Client. На основе результатов этой оценки свойство guard используется для указания Chef Infra Client, следует ли ему продолжать выполнение ресурса. Свойство guard принимает либо строковое значение, либо значение блока Ruby:

Строка выполняется как команда оболочки. Если команда возвращает 0, guard применяется. Если команда возвращает любое другое значение, то свойство guard не применяется. Строковые guard в powershell_script выполняют команды Windows PowerShell и могут возвращать true в дополнение к 0.
Блок выполняется как код Ruby, который должен вернуть либо true либо false. Если блок возвращает true, свойство guard применяется. Если блок возвращает false, свойство guard не применяется.

Свойство guard полезно для обеспечения идемпотентности ресурса, позволяя этому ресурсу проверять желаемое состояние по мере его выполнения, а затем, если желаемое состояние присутствует, Chef Infra Client ничего не делает.

Свойства

Следующие свойства могут использоваться для определения guard, который оценивается во время фазы выполнения Chef Infra Client:

not_if: Предотвратить выполнение ресурса, когда условие возвращает true.
only_if: Разрешить выполнение ресурса только в том случае, если условие возвращает true.

Примеры

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

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

paludis_package 'name of package' do
  action :install
end

Ресурс paludis_package