portage_package Resource — Chef 16

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

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

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

Примечание

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

Синтаксис

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

portage_package 'package_name'

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

Ресурс portage_package имеет следующий синтаксис:

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

где:

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

Действия

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

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

Свойства

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

Блокировки

Свойство блокировки может использоваться для оценки состояния узла на этапе выполнения 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.

Примеры

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

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

portage_package 'name of package' do
  action :install
end