Ресурс gem_package

Редактировать эту страницу в репозитории Chef

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

Используйте ресурс gem_package для управления пакетами gem, которые включены только в рецепты. Когда gem устанавливается из локального файла, его необходимо добавить в узел с помощью ресурсов remote_file или cookbook_file.

Синтаксис

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

gem_package 'name' do
  clear_sources               true, false
  gem_binary                  String
  include_default_source      true, false
  options                     String, Hash, Array
  package_name                String
  source                      String, Array
  timeout                     String, Integer
  version                     String
  action                      Symbol # defaults to :install if not specified
end

где:

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

Действия

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

:install

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

:nothing

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

:purge

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

:reconfig

Переконфигурирует пакет. Это действие требует файла отклика.

:remove

Удаляет пакет.

:upgrade

Устанавливает пакет и/или гарантирует, что пакет является последней версией.

Свойства

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

clear_sources

Тип Ruby: true, false | Значение по умолчанию: false

Установите в true, чтобы загрузить gem из пути, указанного свойством source (а не из RubyGems).

gem_binary

Тип Ruby: Строка

Путь к бинарному файлу gem, который следует использовать для установки. По умолчанию используется та же версия Ruby, что и у Chef Infra Client.

include_default_source

Тип Ruby: true, false

Установите в false, чтобы не включать Chef::Config[:rubygems_url] в источники.

Новое в Chef Client 13.0

options

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

Параметры для установки gem, либо Hash, либо Строка. При использовании Hash параметры передаются в Gem::DependencyInstaller.new, и gem будет установлен через API gems. При использовании Строки gem будет установлен с помощью вызова команды gem. Использование Hash параметров с явным gem_binary приведёт к неопределённому поведению.

package_name

Тип Ruby: Строка

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

source

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

Необязательно. URL или список URL, по которым расположен пакет gem. Этот список добавляется к источнику, настроенному в Chef::Config[:rubygems_url] (см. также include_default_source) для построения полного списка источников rubygems. Пользователи в среде «airgapped» должны установить Chef::Config[:rubygems_url] в свой локальный зеркало RubyGems.

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

Таймер указывает момент во время выполнения 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.

Примеры

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

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

Установка файла gem из локальной файловой системы

gem_package 'loofah' do
  source '/tmp/loofah-2.7.0.gem'
  action :install
end

Использование общего атрибута ignore_failure

gem_package 'syntax' do
  action :install
  ignore_failure true
end