Ресурс dsc_resource

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

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

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 предпримет, чтобы привести узел в желаемое состояние.
• property — это ноль (или более) свойств в ресурсе DSC, где каждое свойство вводится на отдельной строке, :dsc_property_name — это нечувствительное к регистру имя этого свойства, а "property_value" — это значение Ruby, которое будет применено клиентом Chef Infra.
• 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
Array	Object[]
Chef::Util::Powershell:PSCredential	PSCredential
False	bool($false)
Fixnum	Integer
Float	Double
Hash	Hashtable
True	bool($true)

Эти значения преобразуются в соответствующий тип 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 используйте следующие значения:

Значение	Описание
:archive	Используется для распаковки архивов (.zip).
:environment	Используется для управления переменными среды системы.
:file	Используется для управления файлами и каталогами.
:group	Используется для управления локальными группами.
:log	Используется для логирования сообщений конфигурации.
:package	Используется для установки и управления пакетами.
:registry	Используется для управления ключами реестра и значениями ключей реестра.
:script	Используется для выполнения блоков скриптов PowerShell.
:service	Используется для управления службами.
:user	Используется для управления локальными учетными записями пользователей.
:windowsfeature	Используется для добавления или удаления функций и ролей Windows.
:windowsoptionalfeature	Используется для конфигурации дополнительных компонентов Microsoft Windows.
:windowsprocess	Используется для конфигурации процессов Windows.

Любой ресурс DSC может использоваться в рецепте Chef. Например, DSC Resource Kit содержит ресурсы для конфигурации компонентов 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 Infra Client.

Уведомления

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]', действие, которое необходимо выполнить, и затем :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 для обеспечения установки подфункций Message Queuing (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