Ресурс windows_feature_powershell

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

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

Используйте ресурс windows_feature_powershell для добавления, удаления или полного удаления функций и ролей Windows с помощью PowerShell. Этот ресурс значительно ускоряет работу по сравнению с ресурсом windows_feature_dism, но требует установки Remote Server Administration Tools на несерверных версиях Windows.

Новое в Chef Infra Client 14.0.

Синтаксис

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

windows_feature_powershell 'name' do
  all                   true, false # default value: false
  feature_name          Array, String # default value: 'name' unless specified
  management_tools      true, false # default value: false
  source                String
  timeout               Integer # default value: 600
  action                Symbol # defaults to :install if not specified
end

где:

• windows_feature_powershell — это ресурс.
• name — имя блока ресурса.
• action определяет, какие действия Chef Infra Client предпримет для приведения узла в желаемое состояние.
• all, feature_name, management_tools, source, и timeout — доступные свойства этого ресурса.

Действия

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

:delete

Удаление роли/функции Windows из образа с помощью PowerShell.

:install

Установка роли/функции Windows с помощью PowerShell (по умолчанию).

:nothing

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

:remove

Удаление роли/функции Windows с помощью PowerShell.

Свойства

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

all

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

Устанавливает все подфункции. При значении true, это эквивалентно указанию переключателя -InstallAllSubFeatures с Add-WindowsFeature.

feature_name

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

Имя функции(ей) или роли(ей) для установки, если они отличаются от имени блока ресурса.

management_tools

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

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

source

Тип Ruby: Строка

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

timeout

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

Устанавливает таймаут (в секундах) для установки функции.

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

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

Добавление функции SMTP Server:

windows_feature_powershell "smtp-server" do
  action :install
  all true
end

Установка нескольких функций с помощью одного ресурса:

windows_feature_powershell ['Web-Asp-Net45', 'Web-Net-Ext45'] do
  action :install
end

Установка функции Network Policy and Access Service:

windows_feature_powershell 'NPAS' do
  action :install
  management_tools true
end