Ресурс windows_shortcut

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

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

Используйте ресурс windows_shortcut для создания ярлыков файлов в Windows.

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

Синтаксис

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

windows_shortcut 'name' do
  arguments          String
  cwd                String
  description        String
  iconlocation       String
  shortcut_name      String # default value: 'name' unless specified
  target             String
  action             Symbol # defaults to :create if not specified
end

где:

• windows_shortcut — это ресурс.
• name — имя блока ресурса.
• action определяет шаги, которые Chef Infra Client предпримет для приведения узла к нужному состоянию.
• arguments, cwd, description, iconlocation, shortcut_name, и target — доступные свойства этого ресурса.

Действия

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

:create

По умолчанию. Создает или изменяет ярлык Windows.

:nothing

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

Свойства

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

arguments

Тип Ruby: Строка

Аргументы, передаваемые целевому объекту при выполнении ярлыка.

cwd

Тип Ruby: Строка

Рабочая директория, используемая при выполнении целевого объекта.

description

Тип Ruby: Строка

Описание ярлыка

iconlocation

Тип Ruby: Строка

Иконка для ярлыка. Принимает формат path, index, где индекс — это файл иконки. Подробности см. в документации Microsoft здесь.

shortcut_name

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

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

target

Тип 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.

Примеры

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

Создание ярлыка с описанием:

windows_shortcut 'C:\shortcut_dir.lnk' do
  target 'C:\original_dir'
  description 'Make a shortcut to C:\original_dir'
end