Ресурс dmg_package

Изменить эту страницу в репозитории Chef

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

Используйте ресурс 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 Client, чтобы привести узел в желаемое состояние.
• 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

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

allow_untrusted

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

Разрешить установку пакетов, которые не имеют доверенных сертификатов.

app

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

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

checksum

Тип Ruby: String

Контрольная сумма sha256 файла .dmg, который необходимо загрузить.

destination

Тип Ruby: String | Значение по умолчанию: /Applications

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

dmg_name

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

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

dmg_passphrase

Тип Ruby: String

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

file

Тип Ruby: String

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

headers

Тип Ruby: Hash

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

owner

Тип Ruby: String, Integer

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

package_id

Тип Ruby: String

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

source

Тип Ruby: String

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

type

Тип Ruby: String | Значение по умолчанию: appДопустимые значения: "app", "mpkg", "pkg"

Тип пакета.

volumes_dir

Тип Ruby: String | Значение по умолчанию: 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: Integer | Значение по умолчанию: 0

Количество попыток перехвата исключений и повтора попытки ресурса.

retry_delay

Тип Ruby: Integer | Значение по умолчанию: 2

Задержка повтора (в секундах).

sensitive

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

Убедитесь, что конфиденциальные данные ресурса не регистрируются Chef InfraClient.

Уведомления

notifies

Тип Ruby: Symbol, '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: Symbol, '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

Средства защиты

Свойство guard можно использовать для оценки состояния узла во время фазы выполнения Chef Infra Client. На основе результатов этой оценки свойство guard затем используется, чтобы сообщить Chef Infra Client, следует ли продолжать выполнение ресурса. Свойство guard принимает либо строковое значение, либо значение блока 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