Ресурс windows_env

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

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

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

Этот ресурс ранее назывался ресурсом env; его имя было обновлено в Chef Infra 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 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, который вызовет ошибку, если другой ресурс не существует.

Таймер указывает момент во время выполнения 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