Ресурс пакетной обработки

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

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

Используйте ресурс batch для выполнения пакетного скрипта с интерпретатором cmd.exe в Windows. Ресурс batch создаёт и выполняет временный файл (аналогично тому, как работает ресурс script), а не выполняет команду непосредственно. Команды, выполняемые с помощью этого ресурса, по своей природе не идемпотентны, так как они обычно уникальны для среды, в которой они выполняются. Используйте not_if и only_if для защиты этого ресурса от идемпотентности.

Синтаксис

Блок ресурса batch выполняет пакетный скрипт с интерпретатором cmd.exe:

batch 'echo some env vars' do
  code <<-EOH
    echo %TEMP%
    echo %SYSTEMDRIVE%
    echo %PATH%
    echo %WINDIR%
  EOH
end

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

batch 'name' do
  architecture               Symbol
  code                       String
  command                    String, Array
  creates                    String
  cwd                        String
  flags                      String
  group                      String, Integer
  guard_interpreter          Symbol
  interpreter                String
  returns                    Integer, Array
  timeout                    Integer, Float
  user                       String
  password                   String
  domain                     String
  action                     Symbol # defaults to :run if not specified
end

где:

• batch — это ресурс.
• name — имя, присвоенное блоку ресурса.
• action определяет, какие действия Chef Infra Client предпримет для перевода узла в нужное состояние.
• architecture, code, command, creates, cwd, flags, group, guard_interpreter, interpreter, returns, timeout, user, password и domain — свойства этого ресурса, с указанным типом Ruby. Подробнее о всех свойствах, которые могут быть использованы с этим ресурсом, см. раздел «Свойства».

Действия

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

:nothing

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

:run

Выполнить пакетный файл.

Свойства

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

architecture

Тип Ruby: Символ

Архитектура процесса, в котором выполняется скрипт. Если значение не указано, Chef Infra Client использует правильное значение для архитектуры, определенное Ohai. При попытке использовать другое, отличное от :i386, значение для 32-битного процесса возникает исключение. Возможные значения: :i386 (для 32-битных процессов) и :x86_64 (для 64-битных процессов).

code

Тип Ruby: Строка | REQUIRED

Заключённая в кавычки строка кода для выполнения.

command

Тип Ruby: Строка, Массив

Имя команды для выполнения.

creates

Тип Ruby: Строка

Предотвращение создания командой файла, если такой файл уже существует.

cwd

Тип Ruby: Строка

Текущая рабочая директория, из которой будет выполняться команда.

flags

Тип Ruby: Строка

Одна или несколько командных флагов, передаваемых интерпретатору при вызове команды.

group

Тип Ruby: Строка, Целое число

Имя или идентификатор группы, который необходимо изменить перед выполнением команды.

guard_interpreter

Тип Ruby: Символ | Значение по умолчанию: :batch

Когда это свойство установлено в значение :batch, для оценки строковых значений свойств not_if и only_if будет использована 64-битная версия оболочки cmd.exe. Установите это значение в :default, чтобы использовать 32-битную версию оболочки cmd.exe.

interpreter

Тип Ruby: Строка

Интерпретатор скриптов для использования во время выполнения кода. Изменение значения по умолчанию этого свойства не поддерживается.

returns

Тип Ruby: Целое число, Массив | Значение по умолчанию: 0

Возвращаемое значение команды. Это может быть массив допустимых значений. При несоответствии возвращаемого значения(й) генерируется исключение.

timeout

Тип Ruby: Целое число, Строка, Число с плавающей точкой | Значение по умолчанию: 3600

Время ожидания (в секундах) команды перед истечением времени.

user

Тип Ruby: Строка

Имя пользователя для идентичности пользователя, с которой будет запущен новый процесс. Имя пользователя может быть указано необязательно с доменом, например, domainuser или user@my.dns.domain.com в формате Universal Principal Name (UPN). Также его можно указать без домена просто как user, если вместо этого домен указан в атрибуте domain. Только в Windows, если это свойство указано, свойство password также должно быть указано.

password

Тип Ruby: Строка

Только Windows: Пароль пользователя, указанного свойством user. Это свойство обязательно, если user указано в Windows, и может быть указано только при указании user. Свойство sensitive для этого ресурса автоматически будет установлено в значение true, если указан пароль.

domain

Тип Ruby: Строка

Только Windows: Домен пользователя, указанного свойством user. Если не указано, имя пользователя и пароль, указанные свойствами user и password, будут использованы для поиска этого пользователя в домене, к которому присоединена система, на которой выполняется Chef Infra Client, или, если система не присоединена к домену, она будет найдена как локальный учётная запись в этой системе. Альтернативный способ указания домена — оставить это свойство не указанным и указать домен в свойстве user.

Общая функциональность ресурсов

Ресурсы 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[Строка]'

Ресурс может уведомить другой ресурс о выполнении действия при изменении своего состояния. Укажите '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.

Примеры

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

Разархивировать файл и затем переместить его

Для выполнения пакетного файла, который разархивирует и затем переместит Ruby, сделайте что-то вроде:

batch 'unzip_and_move_ruby' do
  code <<-EOH
    7z.exe x #{Chef::Config[:file_cache_path]}/ruby-1.8.7-p352-i386-mingw32.7z
      -oC:\\source -r -y
    xcopy C:\\source\\ruby-1.8.7-p352-i386-mingw32 C:\\ruby /e /y
  EOH
end

batch 'echo some env vars' do
  code <<-EOH
    echo %TEMP%
    echo %SYSTEMDRIVE%
    echo %PATH%
    echo %WINDIR%
  EOH
end

или:

batch 'unzip_and_move_ruby' do
  code <<-EOH
    7z.exe x #{Chef::Config[:file_cache_path]}/ruby-1.8.7-p352-i386-mingw32.7z
      -oC:\\source -r -y
    xcopy C:\\source\\ruby-1.8.7-p352-i386-mingw32 C:\\ruby /e /y
  EOH
end

batch 'echo some env vars' do
  code 'echo %TEMP%\\necho %SYSTEMDRIVE%\\necho %PATH%\\necho %WINDIR%'
end

Выполнить команду от имени другого пользователя

Примечание: Когда Chef работает как служба, эта функция требует, чтобы пользователь, от имени которого работает Chef, имел право «SeAssignPrimaryTokenPrivilege» (также известное как «SE_ASSIGNPRIMARYTOKEN_NAME»). По умолчанию только LocalSystem и NetworkService имеют это право при запуске как служба. Это необходимо даже если пользователь является администратором.

Это право можно добавить и проверить в рецепте, используя этот пример:

# Add 'SeAssignPrimaryTokenPrivilege' for the user
Chef::ReservedNames::Win32::Security.add_account_right('<user>', 'SeAssignPrimaryTokenPrivilege')

# Check if the user has 'SeAssignPrimaryTokenPrivilege' rights
Chef::ReservedNames::Win32::Security.get_account_right('<user>').include?('SeAssignPrimaryTokenPrivilege')

Следующий пример показывает, как запустить mkdir test_dir из выполнения Chef Infra Client от имени другого пользователя.

# Passing only username and password
batch 'mkdir test_dir' do
 code "mkdir test_dir"
 cwd Chef::Config[:file_cache_path]
 user "username"
 password "password"
end

# Passing username and domain
batch 'mkdir test_dir' do
 code "mkdir test_dir"
 cwd Chef::Config[:file_cache_path]
 domain "domain"
 user "username"
 password "password"
end

# Passing username = 'domain-name\\username'. No domain is passed
batch 'mkdir test_dir' do
 code "mkdir test_dir"
 cwd Chef::Config[:file_cache_path]
 user "domain-name\\username"
 password "password"
end

# Passing username = 'username@domain-name'. No domain is passed
batch 'mkdir test_dir' do
 code "mkdir test_dir"
 cwd Chef::Config[:file_cache_path]
 user "username@domain-name"
 password "password"
end