Ресурс chocolatey_package

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

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

Используйте ресурс chocolatey_package для управления пакетами с помощью менеджера пакетов Chocolatey на платформе Microsoft Windows.

Новое в Chef Infra Client 12.7.

Синтаксис

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

chocolatey_package 'name' do
  list_options      String
  options           String, Array
  package_name      String, Array
  password          String
  returns           Integer, Array # default value: [0, 2]
  source            String
  timeout           String, Integer
  user              String
  version           String, Array
  action            Symbol # defaults to :install if not specified
end

где:

• chocolatey_package — это ресурс.
• name — это имя блока ресурса.
• action определяет действия, которые Chef Infra Client предпримет для приведения узла к желаемому состоянию.
• list_options, options, package_name, password, returns, source, timeout, user и version — это доступные свойства этого ресурса.

Действия

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

:install

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

:nothing

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

:purge

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

:remove

Удалить пакет.

:upgrade

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

Свойства

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

list_options

Тип Ruby: Строка

Один или несколько дополнительных параметров списка, передаваемых команде.

Новое в Chef Infra Client 15.3

options

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

Один или несколько дополнительных параметров, передаваемых команде.

package_name

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

Имя пакета. Значение по умолчанию: имя блока ресурса.

password

Тип Ruby: Строка

Пароль для аутентификации на источнике.

Новое в Chef Infra Client 15.3

returns

Тип Ruby: Целое число, Массив | Значение по умолчанию: [0, 2]

Код(ы) выхода, возвращаемый командой choco, указывающий на успешное выполнение действия. См. Коды выхода Chocolatey для получения полного списка кодов выхода, используемых Chocolatey.

Новое в Chef Client 12.18

source

Тип Ruby: Строка

Необязательный путь к пакету в локальной файловой системе или доступном пути UNC. Убедитесь, что указанный путь указывает на папку, содержащую пакет Chocolatey(ей), а не на сам пакет.

timeout

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

Время ожидания в секундах до истечения времени.

user

Тип Ruby: Строка

Имя пользователя для аутентификации каналов.

Новое в Chef Infra Client 15.3

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 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.

Примеры

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

Установка пакета Chocolatey:

chocolatey_package 'name of package' do
  action :install
end

Установка пакета с параметрами с помощью опции Chocolatey’s --checksum:

chocolatey_package 'name of package' do
  options '--checksum 1234567890'
  action :install
end