dmg_пакет Ресурс

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

Все страницы ресурсов Infra

Используйте ресурс dmg_package для установки пакета из файла .dmg. Ресурс извлечёт файл dmg из удалённого URL, смонтирует его с помощью hdidutil, скопирует приложение (.app каталог) в указанное место назначения (/Applications), и отсоединит образ с помощью hdiutil. Файл dmg будет сохранён в Chef::Config[:file_cache_path].

Новое в Chef Infra Client 14.0.

Синтаксис

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

dmg_package 'name' do
  accept_eula          true, false # default value: false
  allow_untrusted      true, false # default value: false
  app                  String # default value: 'name' unless specified
  checksum             String
  destination          String # default value: "/Applications"
  dmg_name             String # default value: The value passed for the application name.
  dmg_passphrase       String
  file                 String
  headers              Hash
  owner                String, Integer
  package_id           String
  source               String
  type                 String # default value: "app"
  volumes_dir          String # default value: The value passed for the application name.
  action               Symbol # defaults to :install if not specified
end

где:

• dmg_package является ресурсом.
• name — имя блока ресурса.
• action определяет, какие действия клиент Chef Infra выполнит для приведения узла в нужное состояние.
• accept_eula, allow_untrusted, app, checksum, destination, dmg_name, dmg_passphrase, file, headers, owner, package_id, source, type, и volumes_dir — доступные свойства этого ресурса.

Действия

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

:install

Устанавливает приложение. (по умолчанию)

:nothing

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

Свойства

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

accept_eula

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

Указывает, нужно ли принять EULA. Некоторые файлы dmg требуют принятия EULA перед монтированием.

allow_untrusted

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

Разрешить установку пакетов без надёжных сертификатов.

app

Тип Ruby: Строка | Значение по умолчанию: The resource block's name

Имя приложения, как оно отображается в каталоге /Volumes, если оно отличается от имени блока ресурса.

checksum

Тип Ruby: Строка

Сумма проверки sha256 загружаемого файла .dmg.

destination

Тип Ruby: Строка | Значение по умолчанию: /Applications

Каталог для копирования .app.

dmg_name

Тип Ruby: Строка | Значение по умолчанию: The value passed for the application name.

Имя файла .dmg, если оно отличается от имени приложения, или если имя содержит пробелы.

dmg_passphrase

Тип Ruby: Строка

Укажите пароль для расшифровки файла .dmg во время процесса монтирования.

file

Тип Ruby: Строка

Абсолютный путь к файлу .dmg на локальной системе.

headers

Тип Ruby: Хэш

Позволяет настраивать пользовательские HTTP-заголовки (например, куки) для ресурса remote_file.

owner

Тип Ruby: Строка, Целое число

Пользователь, которому должна принадлежать установка пакета.

package_id

Тип Ruby: Строка

Идентификатор пакета, зарегистрированный в pkgutil, при установке pkg или mpkg.

source

Тип Ruby: Строка

Удаленный URL для загрузки файла .dmg, если указан.

type

Тип Ruby: Строка | Значение по умолчанию: app Разрешенные значения: "app", "mpkg", "pkg"

Тип пакета.

volumes_dir

Тип Ruby: Строка | Значение по умолчанию: The value passed for the application name.

Каталог в /Volumes, где монтируется dmg, если он отличается от имени файла .dmg.

Общие функции ресурса

Ресурсы 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 Infra Client.

Уведомления

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.

Примеры

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

Установка Google Chrome через пакет DMG:

dmg_package 'Google Chrome' do
  dmg_name 'googlechrome'
  source   'https://dl-ssl.google.com/chrome/mac/stable/GGRM/googlechrome.dmg'
  checksum '7daa2dc5c46d9bfb14f1d7ff4b33884325e5e63e694810adc58f14795165c91a'
  action   :install
end

Установка VirtualBox из .mpkg:

dmg_package 'Virtualbox' do
  source 'http://dlc.sun.com.edgesuite.net/virtualbox/4.0.8/VirtualBox-4.0.8-71778-OSX.dmg'
  type   'mpkg'
end

Установка pgAdmin и автоматическое принятие EULA:

dmg_package 'pgAdmin3' do
  source   'http://wwwmaster.postgresql.org/redir/198/h/pgadmin3/release/v1.12.3/osx/pgadmin3-1.12.3.dmg'
  checksum '9435f79d5b52d0febeddfad392adf82db9df159196f496c1ab139a6957242ce9'
  accept_eula true
end