Ресурс chocolatey_package

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

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

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

Новое в Chef Infra Client 12.7.

Синтаксис

Ресурс chocolatey_package управляет пакетами с помощью Chocolatey в среде Microsoft Windows. Наиболее простое использование ресурса chocolatey_package:

chocolatey_package 'package_name'

что установит указанный пакет со всеми значениями по умолчанию и стандартным действием (:install).

Полный синтаксис всех свойств ресурса 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

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

:reconfig

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

:remove

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

:uninstall

Удаляет пакет. Устарело начиная с Chef 13.7

: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]

Код(ы) возврата пакета chocolatey, указывающие на успех.

0: операция выполнена успешно, проблем не обнаружено

2: нет результатов (улучшенный)

ПРИМЕЧАНИЕ. Начиная с версии v0.10.12, если функция «useEnhancedExitCodes» включена, choco предоставляет улучшенные коды возврата, что позволяет лучше интегрировать и использовать сценарии.

Синтаксис для returns:

returns [0, 2, 1605, 1614, 1641]

Обновлено в Chef Infra Client 15.3.

Новое в 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 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.

Примеры

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

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

chocolatey_package 'name of package' do
  action :install
end

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

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