Ресурс 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 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
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]', :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