Ресурс windows_env

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

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

Используйте ресурс windows_env для управления переменными среды в Microsoft Windows. После того, как переменная среды будет установлена, необходимо перезагрузить Microsoft Windows, чтобы она стала доступной для Планировщика задач.

Этот ресурс ранее назывался ресурсом env; его имя было обновлено в Chef Client 14.0, чтобы отразить тот факт, что поддерживается только Windows. Существующие кулинарные книги, использующие env, будут продолжать работать, но должны быть обновлены для использования нового имени.

Синтаксис

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

windows_env 'name' do
  delim         String, false
  key_name      String # default value: 'name' unless specified
  user          String # default value: "<System>"
  value         String
  action        Symbol # defaults to :create if not specified
end

где:

• windows_env — это ресурс.
• name — имя блока ресурса.
• action определяет шаги, которые Chef Infra Client предпримет для перевода узла в нужное состояние.
• delim, key_name, user, и value — доступные свойства этого ресурса.

Действия

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

:create

По умолчанию. Создает переменную среды. Если переменная среды уже существует (но не совпадает), обновите эту переменную среды, чтобы она соответствовала.

:delete

Удаляет переменную среды.

:modify

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

:nothing

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

Свойства

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

delim

Тип Ruby: Строка, false

Разделитель, используемый для разделения нескольких значений для одного ключа.

key_name

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

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

user

Тип Ruby: Строка | Значение по умолчанию: <System>

value

Тип Ruby: Строка | REQUIRED

Значение переменной среды для установки.

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

Ресурсы 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[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.

Примеры

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

Установка переменной среды:

windows_env 'ComSpec' do
  value 'C:\Windows\system32\cmd.exe'
end