chocolatey_config Resource — Chef 18

Эта страница сгенерирована из исходного кода Chef Infra Client. Чтобы предложить изменения, отредактируйте файл chocolatey_config.rb и отправьте запрос на вытягивание в репозиторий Chef Infra Client.

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

Используйте ресурс chocolatey_config для добавления или удаления ключей конфигурации Chocolatey.

Примечание

Менеджер пакетов Chocolatey по умолчанию не установлен в Windows. Вам необходимо установить его, добавив кулинарную книгу Chocolatey в список выполнения вашего узла.

Новое в Chef Infra Client 14.3.

Синтаксис

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

chocolatey_config 'name' do
  config_key      String # default value: 'name' unless specified
  value           String
  action          Symbol # defaults to :set if not specified
end

где:

chocolatey_config является ресурсом.
name — имя, заданное для блока ресурса.
action определяет действия, которые Chef Infra Client предпримет для приведения узла к желаемому состоянию.
config_key и value — доступные свойства этого ресурса.

Действия

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

:nothing: Этот блок ресурса не выполняется, пока другой ресурс не вызовет действие. После уведомления этот блок ресурса либо выполняется немедленно, либо ставится в очередь для выполнения в конце выполнения Chef Infra Client.
:set: Устанавливает значение конфигурации Chocolatey. (по умолчанию)
:unset: Сбрасывает значение конфигурации Chocolatey.

Свойства

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

config_key: Тип Ruby: Строка | Значение по умолчанию: The resource block's name
Необязательное свойство для установки имени ключа конфигурации, если оно отличается от имени блока ресурса.

value: Тип 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[Строка]'

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

: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_config в рецептах:

Установить конфигурацию Chocolatey cacheLocation:

chocolatey_config 'Set cacheLocation config' do
  config_key 'cacheLocation'
  value 'C:\temp\choco'
end

Сбросить конфигурацию Chocolatey:

chocolatey_config 'BogusConfig' do
  action :unset
end

Ресурс chocolatey_config