Ресурс dsc_resource

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

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

Windows PowerShell — это командная оболочка и язык сценариев на основе задач, разработанный Microsoft. Windows PowerShell использует ориентированный на документы подход для управления машинами на базе Microsoft Windows, аналогично подходу, используемому для управления машинами на базе Unix и Linux. Windows PowerShell — это платформа, не зависящая от инструментов, которая поддерживает использование Chef для управления конфигурацией.

Desired State Configuration (DSC) — это функция Windows PowerShell, которая предоставляет набор расширений языка, командлетов и ресурсов, которые можно использовать для декларативного конфигурирования программного обеспечения. DSC аналогичен Chef, так как оба инструмента идемпотентны, применяют похожие подходы к концепции ресурсов, описывают конфигурацию системы и выполняют необходимые действия по конфигурации. Наиболее важным отличием между Chef и DSC является то, что Chef использует Ruby, а DSC представлен как данные конфигурации изнутри Windows PowerShell.

Ресурс dsc_resource позволяет использовать любой ресурс DSC в рецепте Chef, а также любые пользовательские ресурсы, добавленные в вашу среду Windows PowerShell. Microsoft часто добавляет новые ресурсы в коллекцию ресурсов DSC.

Синтаксис

Блок ресурса dsc_resource позволяет использовать ресурсы DSC в рецепте Chef. Например, ресурс DSC Archive:

Archive ExampleArchive {
  Ensure = "Present"
  Path = "C:\Users\Public\Documents\example.zip"
  Destination = "C:\Users\Public\Documents\ExtractionPath"
}

а затем тот же dsc_resource с Chef:

dsc_resource 'example' do
   resource :archive
   property :ensure, 'Present'
   property :path, "C:\Users\Public\Documents\example.zip"
   property :destination, "C:\Users\Public\Documents\ExtractionPath"
 end```

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

dsc_resource 'name' do
  module_name                String
  module_version             String
  property                   Symbol
  reboot_action              Symbol # default value: :nothing
  resource                   Symbol
  timeout                    Integer
  action                     Symbol # defaults to :run if not specified
end

где:

• dsc_resource — это ресурс.
• name — имя, присвоенное блоку ресурса.
• action определяет действия, которые Chef Infra Client предпримет для приведения узла в желаемое состояние.
• property — ноль или более свойств в ресурсе DSC, каждое свойство указывается на отдельной строке, :dsc_property_name — это чувствительное к регистру имя этого свойства, а "property_value" — значение Ruby, которое должно быть применено Chef Infra Client.
• module_name, module_version, property, reboot_action, resource и timeout — свойства этого ресурса с указанным типом Ruby. Подробную информацию обо всех свойствах, которые могут использоваться с этим ресурсом, см. в разделе «Свойства».

Действия

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

:nothing

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

:run

По умолчанию. Используется для запуска конфигурации DSC, определенной в данном ресурсе.

Свойства

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

module_name

Тип Ruby: Строка

Имя модуля, из которого происходит ресурс DSC. Если это свойство не указано, оно будет определено автоматически.

module_version

Тип Ruby: Строка

Версия модуля для использования. PowerShell 5.0.10018.0 (или выше) поддерживает установку нескольких версий модуля. Это значение должно быть указано вместе с module_name.

Новое в Chef Client 12.21

property

Тип Ruby: Символ

Свойство из ресурса Desired State Configuration (DSC). Используйте это свойство несколько раз, по одному для каждого свойства в ресурсе Desired State Configuration (DSC). Формат этого свойства должен соответствовать property :dsc_property_name, "property_value" для каждого свойства DSC, добавленного в блок ресурса.

:dsc_property_name должно быть символом.

Используйте следующие типы Ruby для определения property_value:

...

Ruby	Windows PowerShell

Эти значения преобразуются в соответствующий тип Windows PowerShell во время выполнения Chef Infra Client.

reboot_action

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

Используется для запроса немедленного перезапуска или для помещения перезапуска в очередь с использованием действий :reboot_now (немедленный перезапуск) или :request_reboot (помещение перезапуска в очередь), встроенных в ресурс перезапуска.

Новое в Chef Client 12.6

resource

Тип Ruby: Символ

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

Для встроенных ресурсов DSC используйте следующие значения:

...

Любой ресурс DSC может использоваться в рецепте Chef. Например, набор ресурсов DSC содержит ресурсы для настройки компонентов Active Directory, таких как xADDomain, xADDomainController и xADUser. Предполагая, что эти ресурсы доступны для Chef Infra Client, соответствующие значения атрибута resource будут: :xADDomain, :xADDomainController и xADUser.

timeout

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

Примеры

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

Открыть Zip-архив

dsc_resource 'example' do
   resource :archive
   property :ensure, 'Present'
   property :path, 'C:\Users\Public\Documents\example.zip'
   property :destination, 'C:\Users\Public\Documents\ExtractionPath'
 end

Управление пользователями и группами

dsc_resource 'demogroupadd' do
  resource :group
  property :groupname, 'demo1'
  property :ensure, 'present'
end

dsc_resource 'useradd' do
  resource :user
  property :username, 'Foobar1'
  property :fullname, 'Foobar1'
  property :password, ps_credential('P@assword!')
  property :ensure, 'present'
end

dsc_resource 'AddFoobar1ToUsers' do
  resource :Group
  property :GroupName, 'demo1'
  property :MembersToInclude, ['Foobar1']
end

Создание и регистрация службы Windows

В следующем примере создается служба Windows, определяется ее путь выполнения и предотвращается запуск службы Windows, если исполняемый файл не находится в определенном месте:

dsc_resource 'NAME' do
  resource :service
  property :name, 'NAME'
  property :startuptype, 'Disabled'
  property :path, 'D:\\Sites\\Site_name\file_to_run.exe'
  property :ensure, 'Present'
  property :state, 'Stopped'
end

Создание очереди сообщений для тестирования

В следующем примере создается файл на узле (на основе файла, расположенного в кулинарной книге), распаковывается модуль Windows PowerShell MessageQueue.zip, а затем с помощью dsc_resource обеспечивается установка подфункций очередей сообщений (MSMQ), создается тестовая очередь и устанавливаются разрешения на тестовую очередь:

cookbook_file 'cMessageQueue.zip' do
  path "#{Chef::Config[:file_cache_path]}\\MessageQueue.zip"
  action :create_if_missing
end

windows_zipfile "#{ENV['PROGRAMW6432']}\\WindowsPowerShell\\Modules" do
  source "#{Chef::Config[:file_cache_path]}\\MessageQueue.zip"
  action :unzip
end

dsc_resource 'install-sub-features' do
  resource :windowsfeature
  property :ensure, 'Present'
  property :name, 'msmq'
  property :IncludeAllSubFeature, true
end

dsc_resource 'create-test-queue' do
  resource :cPrivateMsmqQueue
  property :ensure, 'Present'
  property :name, 'Test_Queue'
end

dsc_resource 'set-permissions' do
  resource :cPrivateMsmqQueuePermissions
  property :ensure, 'Present'
  property :name, 'Test_Queue_Permissions'
  property :QueueNames, 'Test_Queue'
  property :ReadUsers, node['msmq']['read_user']
end

Пример использования свойств модуля

dsc_resource 'test-cluster' do
  resource :xCluster
  module_name 'xFailOverCluster'
  module_version '1.6.0.0'
  property :name, 'TestCluster'
  property :staticipaddress, '10.0.0.3'
  property :domainadministratorcredential, ps_credential('abcd')
end