Ресурс chef_gem

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

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

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

Ресурс chef_gem работает со всеми теми же свойствами и опциями, что и ресурс gem_package, но не принимает свойство gem_binary, так как всегда использует CurrentGemEnvironment, в котором работает chef-client. В дополнение к выполнению действий, аналогичных ресурсу gem_package, ресурс chef_gem выполняет следующие действия:

• Выполняет свои действия немедленно, до сходимости, позволяя использовать gem в рецепте сразу после его установки.
• Выполняет Gem.clear_paths после действия, гарантируя, что gem осведомлен о изменениях, чтобы его можно было потребовать сразу после установки.

Синтаксис

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

chef_gem '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

где:

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

Действия

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

:install

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

:nothing

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

:purge

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

:reconfig

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

:remove

Удаление gem.

:upgrade

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

Свойства

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

clear_sources

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

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

gem_binary

Тип Ruby: Строка | Значение по умолчанию: The `gem` binary included with Chef Infra Client.

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

include_default_source

Тип Ruby: true, false

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

Новая функция в Chef Client 13.0

options

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

Опции для установки gem, либо хеш, либо строка. Если задан хеш, опции передаются в Gem::DependencyInstaller.new, и gem будет установлен через API gem. Если задана строка, gem будет установлен путём вызова команды gem. Использование хеша опций со явным gem_binary может привести к неопределённому поведению.

package_name

Тип Ruby: Строка

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

source

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

Необязательно. URL или список URL, по которым расположен пакет gem. Этот список добавляется к источнику, настроенному в Chef::Config[:rubygems_url] (см. также include_default_source), чтобы построить полный список источников rubygems. Пользователям в «изолированной» среде следует установить 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[Строка]'

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

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

Примеры

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

Установка gem во время компиляции и слияния

Чтобы установить gem во время конфигурации узла Chef Infra Client (фаза слияния), установите свойство compile_time в значение false:

chef_gem 'loofah' do
  compile_time false
  action :install
end

Чтобы установить gem во время построения коллекции ресурсов (фаза компиляции), установите свойство compile_time в значение true:

chef_gem 'loofah' do
  compile_time true
  action :install
end

Установка gem MySQL в Chef Infra Client*

apt_update

build_essential 'install compilation tools' do
  compile_time true
end

chef_gem 'mysql'