Ресурс windows_feature

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

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

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

Новинка в Chef Infra Client 14.0.

Синтаксис

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

windows_feature 'name' do
  all                   true, false # default value: false
  feature_name          Array, String # default value: 'name' unless specified
  install_method        Symbol # default value: :windows_feature_dism
  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 — это ресурс.
• name — имя, заданное для блока ресурса.
• action определяет действия, которые Chef Infra Client предпримет, чтобы привести узел к желаемому состоянию.
• all, feature_name, install_method, management_tools, source, и timeout — доступные свойства этого ресурса.

Действия

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

:delete

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

:install

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

:nothing

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

:remove

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

Свойства

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

all

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

Устанавливает все подфункции.

feature_name

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

Имя функции(й) или роли(ей) для установки, если они отличаются от имени блока ресурса. Одна и та же функция может иметь разные имена в зависимости от используемого базового метода установки (например, DHCPServer и DHCP; DNS-Server-Full-Role и DNS).

install_method

Тип Ruby: Символ | Значение по умолчанию: :windows_feature_dismДопустимые значения: :windows_feature_dism, :windows_feature_powershell, :windows_feature_servermanagercmd

Базовый метод установки для установки функций. Укажите :windows_feature_dism для DISM или :windows_feature_powershell для PowerShell.

management_tools

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

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

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 в рецептах:

Установка функции DHCP Server:

windows_feature 'DHCPServer' do
  action :install
end

Установка функции .Net 3.5.1 с использованием файлов репозитория на DVD:

windows_feature "NetFx3" do
  action :install
  source 'd:\sources\sxs'
end

Удаление функций Telnet Server и Client:

windows_feature %w(TelnetServer TelnetClient) do
  action :remove
end

Добавление функции SMTP Server с помощью поставщика PowerShell:

windows_feature 'smtp-server' do
  action :install
  all true
  install_method :windows_feature_powershell
end

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

windows_feature %w(Web-Asp-Net45 Web-Net-Ext45) do
  action :install
  install_method :windows_feature_powershell
end

Установите функцию службы политики и доступа к сети, включая инструменты управления:

windows_feature 'NPAS' do
  action :install
  management_tools true
  install_method :windows_feature_powershell
end