Ресурс alternatives

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

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

Используйте ресурс alternatives для настройки альтернативных команд в Linux с помощью пакетов alternatives или update-alternatives.

Новая функция в Chef Infra Client 16.0.

Синтаксис

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

alternatives 'name' do
  link           String # default value: "/usr/bin/LINK_NAME"
  link_name      String # default value: 'name' unless specified
  path           String
  priority       String, Integer
  action         Symbol # defaults to :install if not specified
end

где:

• alternatives — это ресурс.
• name — это имя, присвоенное блоку ресурса.
• action определяет действия, которые Chef Infra Client выполнит для приведения узла в нужное состояние.
• link, link_name, path, и priority — это доступные свойства этого ресурса.

Действия

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

:auto

Настроить альтернативу в автоматическом режиме с автоматическим выбором наивысшего приоритета.

:install

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

:nothing

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

:refresh

Обновить альтернативы.

:remove

Удалить альтернативу и все связанные ссылки.

:set

Установить символическую ссылку для альтернативы.

Свойства

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

link

Тип в Ruby: Строка | Значение по умолчанию: /usr/bin/LINK_NAME

Путь к ссылке альтернативы.

link_name

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

Имя создаваемой ссылки. Это будет команда, которую вы введете в командной строке, например, ruby или gcc.

path

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

Абсолютный путь к исходному исполняемому файлу приложения, например, /usr/bin/ruby27.

priority

Тип в 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]', действие, которое должен выполнить ресурс, и :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.

Примеры

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

Установить альтернативу:

alternatives 'python install 2' do
  link_name 'python'
  path '/usr/bin/python2.7'
  priority 100
  action :install
end

Настроить альтернативу:

alternatives 'python set version 3' do
  link_name 'python'
  path '/usr/bin/python3'
  action :set
end

Установить автоматическое состояние альтернативы:

alternatives 'python auto' do
  link_name 'python'
  action :auto
end

Обновить альтернативу:

alternatives 'python refresh' do
  link_name 'python'
  action :refresh
end

Удалить альтернативу:

alternatives 'python remove' do
  link_name 'python'
  path '/usr/bin/python3'
  action :remove
end