Ресурс chocolatey_source

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

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

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

Новое в Chef Infra Client 14.3.

Синтаксис

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

chocolatey_source 'name' do
  admin_only              true, false # default value: false
  allow_self_service      true, false # default value: false
  bypass_proxy            true, false # default value: false
  cert                    String
  cert_password           String
  password                String
  priority                Integer # default value: 0
  source                  String
  source_name             String # default value: 'name' unless specified
  username                String
  action                  Symbol # defaults to :add if not specified
end

где:

• chocolatey_source — это ресурс.
• name — имя, присвоенное блоку ресурса.
• action определяет действия, которые Chef Infra Client предпримет для приведения узла в желаемое состояние.
• admin_only, allow_self_service, bypass_proxy, cert, cert_password, password, priority, source, source_name, и username — доступные свойства этого ресурса.

Действия

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

:add

Добавляет источник Chocolatey (по умолчанию)

:disable

Отключает источник Chocolatey. Новое в Chef Infra Client 15.1.

:enable

Включает источник Chocolatey. Новое в Chef Infra Client 15.1.

:nothing

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

:remove

Удаляет источник Chocolatey.

Свойства

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

admin_only

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

Указывает, доступен ли источник только администраторам.

Новое в Chef Infra Client 15.1

allow_self_service

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

Указывает, используется ли источник для самообслуживания.

Новое в Chef Infra Client 15.1

bypass_proxy

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

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

cert

Тип Ruby: Строка

Сертификат, используемый для аутентификации с источником

Новое в Chef Infra Client 17.7

cert_password

Тип Ruby: Строка

Пароль для сертификата, используемого для аутентификации с источником

Новое в Chef Infra Client 17.7

password

Тип Ruby: Строка

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

Новое в Chef Infra Client 17.7

priority

Тип Ruby: Целое число | Значение по умолчанию: 0

Уровень приоритета источника.

source

Тип Ruby: Строка

URL источника.

source_name

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

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

username

Тип Ruby: Строка

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

Новое в Chef Infra Client 17.7

Общие функциональные возможности ресурсов

Ресурсы 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_source в рецептах:

Добавить источник Chocolatey

chocolatey_source 'MySource' do
  source 'http://example.com/something'
  action :add
end

Удалить источник Chocolatey

chocolatey_source 'MySource' do
  action :remove
end