Все ресурсы инфраструктуры

В данном справочнике описываются каждый из ресурсов, доступных клиенту Chef Infra, включая список действий, свойств и примеры использования.

Общие возможности

Свойства и действия в этом разделе применяются ко всем ресурсам.

Действия

Следующие действия могут быть использованы с любым ресурсом:

:nothing

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

Примеры

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

Использование действия :nothing

service 'memcached' do
  action :nothing
end

Свойства

Следующие свойства являются общими для каждого ресурса:

ignore_failure

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

Продолжать выполнение рецепта, если ресурс завершается ошибкой по любой причине.

retries

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

Количество попыток перехватить исключения и повторить ресурс.

retry_delay

Тип Ruby: Целое число | Значение по умолчанию: 2

Задержка в секундах между попытками повтора.

sensitive

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

Обеспечить, чтобы конфиденциальные данные ресурса не регистрировались клиентом Chef Infra.

Примеры

Следующие примеры показывают, как использовать общие свойства в рецепте.

Использование общего свойства ignore_failure

gem_package 'syntax' do
  action :install
  ignore_failure true
end

Использование общих свойств retries и retry_delay

service 'apache' do
  action [ :enable, :start ]
  retries 3
  retry_delay 5
end

Блокирующие условия

Свойство guard может использоваться для оценки состояния узла во время фазы выполнения процесса Chef Infra Client. На основании результатов этой оценки свойство guard используется для определения, следует ли продолжить выполнение ресурса клиенту Chef Infra. Свойство guard принимает либо строковое значение, либо значение Ruby-блока:

• Строка выполняется как команда оболочки. Если команда возвращает 0, блокирующее условие применяется. Если команда возвращает любое другое значение, то свойство guard не применяется. Строковые блокирующие условия в powershell_script выполняют команды Windows PowerShell и могут возвращать true в дополнение к 0.
• Блок выполняется как код Ruby, который должен возвращать либо true, либо false. Если блок возвращает true, свойство guard применяется. Если блок возвращает false, свойство guard не применяется.

Свойство guard полезно для обеспечения идемпотентности ресурса, позволяя этому ресурсу проверить желаемое состояние по мере его выполнения, а затем, если желаемое состояние присутствует, клиенту Chef Infra ничего не делать.

Свойства

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

not_if

Запретить выполнение ресурса, когда условие возвращает true.

only_if

Разрешить выполнение ресурса только в том случае, если условие возвращает true.

Аргументы

Следующие аргументы могут использоваться со свойствами блокирующих условий not_if или only_if:

:user

Укажите пользователя, от имени которого будет выполняться команда. Например:

not_if 'grep adam /etc/passwd', user: 'adam'

:group

Укажите группу, от имени которой будет выполняться команда. Например:

not_if 'grep adam /etc/passwd', group: 'adam'

:environment

Укажите хеш переменных среды, которые должны быть установлены. Например:

not_if 'grep adam /etc/passwd', environment: {
  'HOME' => '/home/adam',
}

:cwd

Установите текущую рабочую директорию перед запуском команды. Например:

not_if 'grep adam passwd', cwd: '/etc'

:timeout

Установите таймаут для команды. Например:

not_if 'sleep 10000', timeout: 10

Примеры not_if

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

Создать файл, но не если атрибут имеет определенное значение

Следующий пример демонстрирует, как использовать условие not_if для создания файла на основе шаблона и использование наличия значения атрибута на узле для указания условия:

template '/tmp/somefile' do
  mode '0755'
  source 'somefile.erb'
  not_if { node['some_value'] }
end

Создать файл с Ruby-блоком, но не если “/etc/passwd” существует

Следующий пример демонстрирует, как использовать условие not_if для создания файла на основе шаблона и затем код Ruby для указания условия:

template '/tmp/somefile' do
  mode '0755'
  source 'somefile.erb'
  not_if do
    ::File.exist?('/etc/passwd')
  end
end

Создать файл с Ruby-блоком, имеющим фигурные скобки, но не если “/etc/passwd” существует

Следующий пример демонстрирует, как использовать условие not_if для создания файла на основе шаблона и использование Ruby-блока (с фигурными скобками) для указания условия:

template '/tmp/somefile' do
  mode '0755'
  source 'somefile.erb'
  not_if { ::File.exist?('/etc/passwd') }
end

Создать файл с помощью строки, но не если “/etc/passwd” существует

Следующий пример демонстрирует, как использовать условие not_if для создания файла на основе шаблона и используя строку для указания условия:

template '/etc/some_config' do
  mode '0640'
  source 'some_config.erb'
  not_if 'some_app --check-config'
end

Примеры only_if

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

Создать файл, но только если атрибут имеет определенное значение

Следующий пример демонстрирует, как использовать условие only_if для создания файла на основе шаблона и использование наличия атрибута на узле для указания условия:

template '/tmp/somefile' do
  mode '0755'
  source 'somefile.erb'
  only_if { node['some_value'] }
end

Создать файл с Ruby-блоком, но только если “/etc/passwd” не существует

Следующий пример демонстрирует, как использовать условие only_if для создания файла на основе шаблона, а затем использовать Ruby для указания условия:

template '/etc/some_app/some_config' do
  mode '0640'
  source 'some_config.erb'
  only_if { ::File.exist?('/etc/some_app/') }
end

Создать файл с помощью строки, но только если “/etc/passwd” существует

Следующий пример демонстрирует, как использовать условие only_if для создания файла на основе шаблона и используя строку для указания условия:

template '/tmp/somefile' do
  mode '0755'
  source 'somefile.erb'
  only_if 'test -f /etc/passwd'
end

Интерпретаторы блокирующих условий

Любой ресурс, который передает строковую команду, также может указать интерпретатор, который будет использоваться для оценки этой строковой команды. Это делается с помощью свойства guard_interpreter для указания ресурса на основе script.

Атрибуты

Свойство guard_interpreter может быть установлено на любое из следующих значений:

:bash

Вычисляет строковую команду с помощью ресурса bash.

:batch

Вычисляет строковую команду с помощью ресурса batch. Значение по умолчанию (внутри блока ресурса batch): :batch.

:csh

Вычисляет строковую команду с помощью ресурса csh.

:default

По умолчанию. Выполняет интерпретатор по умолчанию, определенный клиентом Chef Infra.

:perl

Вычисляет строковую команду с помощью ресурса perl.

:powershell_script

Вычисляет строковую команду с помощью ресурса powershell_script. Значение по умолчанию (внутри блока ресурса powershell_script): :powershell_script.

:python

Вычисляет строковую команду с помощью ресурса python.

:ruby

Вычисляет строковую команду с помощью ресурса ruby.

Наследование

Свойство guard_interpreter устанавливается по умолчанию на :default для ресурсов bash, csh, perl, python и ruby. Когда свойство guard_interpreter установлено на :default, not_if или only_if операторы блокирующих условий не наследуют свойства, определенные ресурсом на основе script.

Например, оператор блокирующего условия not_if в следующем примере ресурса не наследует свойство environment:

bash 'javatooling' do
  environment 'JAVA_HOME' => '/usr/lib/java/jdk1.7/home'
  code 'java-based-daemon-ctl.sh -start'
  not_if 'java-based-daemon-ctl.sh -test-started'
end

и требует добавления свойства environment к оператору блокирующего условия not_if, чтобы он мог использовать путь JAVA_HOME в качестве части своего вычисления:

bash 'javatooling' do
  environment 'JAVA_HOME' => '/usr/lib/java/jdk1.7/home'
  code 'java-based-daemon-ctl.sh -start'
  not_if 'java-based-daemon-ctl.sh -test-started', :environment => 'JAVA_HOME' => '/usr/lib/java/jdk1.7/home'
end

Чтобы наследоваться, добавьте свойство guard_interpreter в блок ресурса и установите его на соответствующее значение:

• :bash для bash
• :csh для csh
• :perl для perl
• :python для python
• :ruby для ruby

Например, используя тот же пример, что и выше, но на этот раз добавляя свойство guard_interpreter и устанавливая его на :bash:

bash 'javatooling' do
  guard_interpreter :bash
  environment 'JAVA_HOME' => '/usr/lib/java/jdk1.7/home'
  code 'java-based-daemon-ctl.sh -start'
  not_if 'java-based-daemon-ctl.sh -test-started'
end

Оператор блокирующего условия not_if теперь наследует свойство environment и будет использовать путь JAVA_HOME в качестве части своего вычисления.

Примеры

Например, следующий блок кода гарантирует, что команда будет вычислена с использованием интерпретатора по умолчанию, определенного клиентом Chef Infra:

resource 'name' do
  guard_interpreter :default
  # code
end

Ленивое вычисление

В некоторых случаях значение свойства нельзя узнать до фазы выполнения выполнения Chef Infra Client. В этой ситуации использование ленивой оценки значений свойств может быть полезно. Вместо присваивания значения свойству, ему может быть присвоен блок кода. Синтаксис использования ленивой оценки следующий:

property_name lazy { code_block }

где lazy используется для того, чтобы указать Chef Infra Client на необходимость оценки содержимого блока кода позже в процессе оценки ресурса (а не сразу), а { code_block } — это произвольный код Ruby, предоставляющий значение.

Например, ресурс, который не использует ленивую оценку:

template 'template_name' do
  # some properties
  path '/foo/bar'
end

и блок ресурса, использующий ленивую оценку:

template 'template_name' do
  # some properties
  path lazy { ' some Ruby code ' }
end

В предыдущих примерах первый ресурс использует значение /foo/bar, а второй — значение, предоставляемое блоком кода, при условии, что содержимое этого блока кода является допустимым свойством ресурса.

Следующий пример демонстрирует использование ленивой оценки со переменными шаблонов:

template '/tmp/canvey_island.txt' do
  source 'canvey_island.txt.erb'
  variables(
    lazy do
      { canvey_island: node.run_state['sea_power'] }
    end
  )
end

Уведомления

Уведомление — это свойство ресурса, которое отслеживает другие ресурсы в коллекции ресурсов, а затем выполняет действия в зависимости от типа уведомления (notifies или subscribes).

Таймеры

Таймер определяет момент во время выполнения Chef Infra Client, в котором выполняется уведомление. Доступны следующие таймеры:

:before

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

:delayed

По умолчанию. Указывает, что уведомление должно быть помещено в очередь, а затем выполнено в конце выполнения Chef Infra Client.

:immediate, :immediately

Указывает, что уведомление должно быть выполнено немедленно, по каждому уведомленному ресурсу.

Уведомления (Notifies)

Ресурс может уведомлять другой ресурс о выполнении действия при изменении его состояния. Укажите 'resource[name]', действие, которое должен предпринять ресурс, и затем :timer для этого действия. Ресурс может уведомлять более одного ресурса; для каждого уведомляемого ресурса используйте инструкцию notifies.

Если указанный ресурс не существует, генерируется ошибка. В отличие от этого, subscribes не завершится ошибкой, если исходный ресурс не найден.

Синтаксис для notifies:

notifies :action, 'resource[name]', :timer

Примеры

В следующих примерах показано, как использовать уведомление notifies в рецепте.

Задержка уведомлений

template '/etc/nagios3/configures-nagios.conf' do
  # other parameters
  notifies :run, 'execute[test-nagios-config]', :delayed
end

Немедленное уведомление

По умолчанию уведомления :delayed, то есть они помещаются в очередь по мере их возникновения и выполняются в конце выполнения Chef Infra Client. Для немедленного выполнения действия используйте :immediately:

template '/etc/nagios3/configures-nagios.conf' do
  # other parameters
  notifies :run, 'execute[test-nagios-config]', :immediately
end

а затем Chef Infra Client немедленно выполнит следующее:

execute 'test-nagios-config' do
  command 'nagios3 --verify-config'
  action :nothing
end

Уведомление нескольких ресурсов

template '/etc/chef/server.rb' do
  source 'server.rb.erb'
  owner 'root'
  group 'root'
  mode '0755'
  notifies :restart, 'service[chef-elasticsearch]', :delayed
  notifies :restart, 'service[chef-server]', :delayed
end

Уведомление в определенном порядке

Для уведомления нескольких ресурсов и выполнения их в определенном порядке можно сделать следующее:

execute 'foo' do
  command '...'
  notifies :create, 'template[baz]', :immediately
  notifies :install, 'package[bar]', :immediately
  notifies :run, 'execute[final]', :immediately
end

template 'baz' do
  ...
  notifies :run, 'execute[restart_baz]', :immediately
end

package 'bar'

execute 'restart_baz'

execute 'final' do
  command '...'
end

где последовательность будет соответствовать порядку перечисления ресурсов в рецепте: execute 'foo', template 'baz', execute [restart_baz], package 'bar' и execute 'final'.

Перезагрузка службы

template '/tmp/somefile' do
  mode '0755'
  source 'somefile.erb'
  notifies :reload, 'service[apache]', :immediately
end

Перезапуск службы при изменении шаблона

template '/etc/www/configures-apache.conf' do
  notifies :restart, 'service[apache]', :immediately
end

Отправка уведомлений нескольким ресурсам

Для отправки уведомлений нескольким ресурсам просто используйте несколько атрибутов. Несколько атрибутов будут отправлены уведомленным ресурсам в указанном порядке.

template '/etc/netatalk/netatalk.conf' do
  notifies :restart, 'service[afpd]', :immediately
  notifies :restart, 'service[cnid]', :immediately
end

service 'afpd'
service 'cnid'

Выполнение команды с использованием шаблона

Следующий пример демонстрирует настройку IPv4 пакетов переадресации с использованием ресурса execute для выполнения команды forward_ipv4, использующей шаблон, определенный ресурсом template:

execute 'forward_ipv4' do
  command 'echo > /proc/.../ipv4/ip_forward'
  action :nothing
end

template '/etc/file_name.conf' do
  source 'routing/file_name.conf.erb'
  notifies :run, 'execute[forward_ipv4]', :delayed
end

где свойство command ресурса execute содержит команду, которая должна быть выполнена, а свойство source ресурса template указывает, какой шаблон использовать. Свойство notifies для template указывает, что execute[forward_ipv4] (которое определено ресурсом execute) должно быть помещено в очередь и выполнено в конце выполнения Chef Infra Client.

Перезапуск одной службы и последующее уведомление другой службы

Следующий пример демонстрирует запуск службы example_service и немедленное уведомление службы Nginx о перезапуске.

service 'example_service' do
  action :start
  notifies :restart, 'service[nginx]', :immediately
end

Перезапуск одной службы до перезапуска другой

В этом примере используется уведомление :before для перезапуска службы php-fpm перед перезапуском nginx:

service 'nginx' do
  action :restart
  notifies :restart, 'service[php-fpm]', :before
end

С уведомлением :before действие, указанное для ресурса nginx, не будет выполнено, пока не будет выполнено действие для уведомленного ресурса (php-fpm).

Уведомление при изменении удаленного источника

remote_file '/tmp/couch.png' do
  source 'http://couchdb.apache.org/img/sketch.png'
  action :nothing
end

http_request 'HEAD http://couchdb.apache.org/img/sketch.png' do
  message ''
  url 'http://couchdb.apache.org/img/sketch.png'
  action :head
  if ::File.exist?('/tmp/couch.png')
    headers 'If-Modified-Since' => File.mtime('/tmp/couch.png').httpdate
  end
  notifies :create, 'remote_file[/tmp/couch.png]', :immediately
end

Подписки (Subscribes)

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

Синтаксис для subscribes:

subscribes :action, 'resource[name]', :timer

Примеры

В следующих примерах показано, как использовать уведомление subscribes в рецепте.

Предотвращение перезапуска и переконфигурации при ошибке конфигурации

Используйте действие :nothing (общее для всех ресурсов) для предотвращения автоматического запуска теста, а затем используйте уведомление subscribes для выполнения теста конфигурации при обнаружении изменений в шаблоне:

execute 'test-nagios-config' do
  command 'nagios3 --verify-config'
  action :nothing
  subscribes :run, 'template[/etc/nagios3/configures-nagios.conf]', :immediately
end

Перезагрузка службы с использованием шаблона

Для перезагрузки службы, основанной на шаблоне, используйте ресурсы template и service вместе в одном рецепте, аналогично следующему:

template '/tmp/somefile' do
  mode '0755'
  source 'somefile.erb'
end

service 'apache' do
  action :enable
  subscribes :reload, 'template[/tmp/somefile]', :immediately
end

где уведомление subscribes используется для перезагрузки службы всякий раз, когда шаблон изменяется.

Хранение файла в пакете данных

Следующий пример показывает, как использовать ресурс ruby_block для хранения файла BitTorrent в пакете данных, чтобы его можно было распространить на узлы в организации.

# the following code sample comes from the ``seed`` recipe
# in the following cookbook: https://github.com/mattray/bittorrent-cookbook

ruby_block 'share the torrent file' do
  block do
    f = File.open(node['bittorrent']['torrent'], 'rb')
    #read the .torrent file and base64 encode it
    enc = Base64.encode64(f.read)
    data = {
      'id' => bittorrent_item_id(node['bittorrent']['file']),
      'seed' => node['ipaddress'],
      'torrent' => enc,
    }
    item = Chef::DataBagItem.new
    item.data_bag('bittorrent')
    item.raw_data = data
    item.save
  end
  action :nothing
  subscribes :create, "bittorrent_torrent[#{node['bittorrent']['torrent']}]", :immediately
end

Относительные пути

Следующие относительные пути могут быть использованы с любым ресурсом:

#{ENV['HOME']}

Используется для возвращения пути ~ в Linux и macOS или пути %HOMEPATH% в Microsoft Windows.

Примеры

template "#{ENV['HOME']}/chef-getting-started.txt" do
  source 'chef-getting-started.txt.erb'
  mode '0755'
end

Выполнение в фазе компиляции

Chef Infra Client обрабатывает рецепты в двух фазах:

1. Сначала каждый ресурс в объекте узла идентифицируется, и создается коллекция ресурсов. Все рецепты загружаются в определенном порядке, а затем идентифицируются действия, указанные в каждом из них. Это также называется «фазой компиляции».
2. Затем Chef Infra Client настраивает систему в соответствии с порядком ресурсов в коллекции ресурсов. Каждый ресурс затем анализирует узел и выполняет необходимые шаги для завершения действия. Это также называется «фазой выполнения».

Обычно действия обрабатываются на фазе выполнения Chef Infra Client. Однако иногда необходимо выполнить действие на фазе компиляции. Например, ресурс может быть настроен на установку пакета на фазе компиляции, чтобы убедиться, что приложение доступно другим ресурсам на фазе выполнения.

run_action

Используйте .run_action(:some_action) в конце блока ресурса, чтобы выполнить указанное действие на фазе компиляции. Например:

build_essential 'Install compilers' do
  action :nothing
end.run_action(:install)

где action установлено в :nothing, чтобы убедиться, что run_action выполняется на фазе компиляции, а не позже на фазе выполнения.

Это можно упростить, используя флаг compile_time в Chef Infra Client 16 и более поздних версиях:

build_essential 'Install compilers' do
  compile_time true
end

Этот флаг как вынуждает ресурс работать во время компиляции, так и устанавливает действие слияния на :nothing.

Следующие примеры показывают, когда (и когда не нужно) использовать run_action.

Использование пользовательских ресурсов предпочтительнее принудительного выполнения на стадии компиляции

Выполнение на стадии компиляции часто используется для установки библиотек перед их использованием в коде рецепта.

Это плохая практика, так как библиотеки могут зависеть от системных библиотек, которые, в свою очередь, могут потребовать установки компиляторов на стадии компиляции.

build_essential 'Install compilers' do
  compile_time true
end

chef_gem 'aws-dsk' do
  compile_time true
end

require 'aws-sdk'

Лучшая стратегия — перемещение кода, требующего использования gem, в пользовательский ресурс. Поскольку все действия пользовательских ресурсов выполняются во время слияния, это откладывает требование к gem до более позднего этапа выполнения Chef Infra Client. Режим унификации также может быть использован в ресурсе для полного устранения проблем, связанных с режимами компиляции/слияния:

unified_mode true

action :run do
  build_essential 'Install compilers'

  chef_gem 'aws-sdk'

  require 'aws-sdk'
end

Загрузка и парсинг файла конфигурации

Частый случай использования — это загрузка файла конфигурации, его парсинг и последующее использование значений в шаблонах и для управления другими настройками.

Важно отметить, что загруженный файл конфигурации существует только временно, для использования Chef Infra Client. Он не будет использоваться напрямую системой или приложениями, управляемыми Chef Infra Client.

Для загрузки и парсинга JSON-файла и его рендеринга в шаблоне целесообразно загрузить файл во время компиляции:

  # the remote_file is being downloaded to a temporary file
  remote_file "#{Chef::Config[:file_cache_path]}/users.json" do
    source "https://jsonplaceholder.typicode.com/users"
    compile_time true
  end

  # this parsing needs to happen after the remote_file is downloaded, but will
  # be executed at compile time.
  array = JSON.parse(IO.read("#{Chef::Config[:file_cache_path]}/users.json")

  # the `array.last["phone"]` expression here will also be evaluated at compile
  # time and must be lazied via wrapping the expresssion in `lazy {}`
  file "/tmp/phone_number.txt" do
    content array.last["phone"]
  end

Это значительно чище, чем альтернативный вариант ленивой оценки парсинга JSON и рендеринга данных в шаблон файла, что произойдет, если ресурс remote_file не выполняется во время компиляции:

  # the execution of this is now deferred
  remote_file "#{Chef::Config[:file_cache_path]}/users.json" do
    source "https://jsonplaceholder.typicode.com/users"
  end

  # it is necessary due to lexical scoping issues to create this variable here
  array = nil

  # the parsing of the JSON is now deferred due to the ruby_block
  ruby_block "parse JSON" do
    block do
      array = JSON.parse(IO.read("#{Chef::Config[:file_cache_path]}/users.json")
    end
  end

  # the argument to the content property must now also be deferred
  file "/tmp/phone_number.txt" do
    content lazy { array.last["phone"] }
  end

Это пример кода, который чрезмерно использует отложенное выполнение, использует более «ленивую» оценку и значительно сложнее понять и правильно написать.

Уведомления не будут работать

Ресурсы, которые выполняются на этапе компиляции, не могут уведомлять другие ресурсы. Например:

execute 'ifconfig'

package 'vim-enhanced' do
  compile_time true
  notifies :run, 'execute[ifconfig]', :immediately
end

Лучший подход в такой ситуации — установка пакета до создания коллекции ресурсов, чтобы гарантировать его доступность для других ресурсов позже.

Лучший подход к этой проблеме — использовать unified mode, что устраняет различие между временем компиляции и временем слияния, при этом позволяя уведомлениям работать правильно.

Ресурсы, которые по умолчанию выполняются во время компиляции

Ресурсы ohai_hint и hostname по умолчанию выполняются во время компиляции.

Это связано с тем, что последующие ресурсы могут потреблять атрибуты узла, устанавливаемые этими ресурсами, что приводит к чрезмерному использованию lazy в последующих ресурсах (и аналогичным проблемам, как в примере remote_file выше).

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

Атомарные обновления файлов

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

Атомарные обновления включены по умолчанию. Их можно управлять глобально, используя настройку file_atomic_update в файле client.rb. Их можно управлять на уровне каждого ресурса, используя свойство atomic_update, доступное для ресурсов cookbook_file, file, remote_file и template.

Безопасность файлов в Windows

Для поддержки безопасности Microsoft Windows ресурсы template, file, remote_file, cookbook_file, directory и remote_directory поддерживают использование наследования и списков управления доступом (ACL) в рецептах.

Списки управления доступом (ACL)

Свойство rights можно использовать в рецепте для управления списками управления доступом (ACL), которые позволяют предоставлять разрешения нескольким пользователям и группам. Свойство rights можно использовать любое количество раз; Chef Infra Client применит их к файлу или каталогу по мере необходимости. Синтаксис свойства rights следующий:

rights permission, principal, option_type => value

где

permission

Используется для указания прав, предоставляемых principal. Возможные значения: :read, :write, read_execute, :modify, :full_control или целое число.

Целые числа, используемые для разрешений, должны соответствовать следующему списку FileSystemRights Enum полям.

These permissions are cumulative. If `:write` is specified, then it
includes `:read`. If `:full_control` is specified, then it includes
both `:write` and `:read`.

(For those who know the Microsoft Windows API: `:read` corresponds
to `GENERIC_READ`; `:write` corresponds to `GENERIC_WRITE`;
`:read_execute` corresponds to `GENERIC_READ` and `GENERIC_EXECUTE`;
`:modify` corresponds to `GENERIC_WRITE`, `GENERIC_READ`,
`GENERIC_EXECUTE`, and `DELETE`; `:full_control` corresponds to
`GENERIC_ALL`, which allows a user to change the owner and other
metadata about a file.)

principal

Используется для указания группы или пользователя. Субъект может быть указан либо по имени, либо по SID. При использовании имени это идентично тому, что вводится в поле входа в систему Microsoft Windows, например, user_name, domain\user_name или user_name@fully_qualified_domain_name. При использовании SID можно использовать либо стандартное строковое представление SID (S-R-I-S-S), либо одно из постоянных строк SDDL. Chef Infra Client не нужно знать, пользователь это или группа.

option_type

Хэш, содержащий расширенные параметры прав. Например, права на каталог, которые применяются только к первому уровню потомков, могут выглядеть следующим образом: rights :write, 'domain\group_name', :one_level_deep => true. Возможные типы параметров:

Тип параметра	Описание
:applies_to_children	Указывает, как разрешения применяются к потомкам. Возможные значения: true — наследование как для подкаталогов, так и для файлов; false — не наследоваться ни для подкаталогов, ни для файлов; :containers_only — наследоваться только для подкаталогов (но не для файлов); :objects_only — рекурсивно наследоваться для файлов (но не для подкаталогов).
:applies_to_self	Указывает, применяется ли разрешение к родительскому каталогу. Возможные значения: true — применять к родительскому каталогу или файлу и его потомкам; false — не применять только к подкаталогам и файлам.
:one_level_deep	Указывает глубину, до которой будут применяться разрешения. Возможные значения: true — применять только к первому уровню потомков; false — применять ко всем потомкам.

Например:

resource 'x.txt' do
  rights :read, 'S-1-1-0'
  rights :write, 'domain\group'
  rights :full_control, 'group_name_or_user_name'
  rights :full_control, 'user_name', applies_to_children: true
end

или:

rights :read, %w(Administrators Everyone)
rights :full_control, 'Users', applies_to_children: true
rights :write, 'Sally', applies_to_children: :containers_only, applies_to_self: false, one_level_deep: true

Некоторые другие важные моменты, которые следует знать при использовании атрибута rights:

• Остаются только унаследованные права. Все существующие явные права на объект удаляются и заменяются.
• Если права не указаны, ничего не изменится. Chef Infra Client не очищает права на файл или каталог, если права не указаны.
• Изменение унаследованных прав может быть дорогостоящим. Microsoft Windows будет рекурсивно распространять права на всех потомков из-за наследования. Это обычный аспект Microsoft Windows, поэтому подумайте о частоте необходимости такого действия и примите меры для управления такими действиями, если производительность является главным фактором.

Используйте свойство deny_rights, чтобы запретить определенные права определенным пользователям. Порядок не зависит от использования свойства rights. Например, неважно, помещены ли права на доступ для всех перед или после deny_rights :read, ['Julian', 'Lewis'], и Джулиан, и Луис не смогут прочитать документ. Например:

resource 'x.txt' do
  rights :read, 'Everyone'
  rights :write, 'domain\group'
  rights :full_control, 'group_name_or_user_name'
  rights :full_control, 'user_name', applies_to_children: true
  deny_rights :read, %w(Julian Lewis)
end

или:

deny_rights :full_control, ['Sally']

Наследование

По умолчанию файл или каталог наследует права от родительского каталога. В большинстве случаев это предпочтительное поведение, но иногда может потребоваться предпринять шаги для более точного управления правами. Свойство inherits можно использовать для того, чтобы явно указать Chef Infra Client применять (или не применять) унаследованные права от родительского каталога.

Например, в следующем примере указаны права для каталога:

directory 'C:\mordor' do
  rights :read, 'MORDOR\Minions'
  rights :full_control, 'MORDOR\Sauron'
end

а затем в следующем примере показано, как использовать наследование для запрета доступа к подкаталогу:

directory 'C:\mordor\mount_doom' do
  rights :full_control, 'MORDOR\Sauron'
  inherits false # Sauron is the only person who should have any sort of access
end

Если вместо этого было бы использовано разрешение deny_rights, что-то могло бы проскользнуть, если бы не было запрещено для всех пользователей и групп.

Еще один пример также демонстрирует, как задать права для каталога:

directory 'C:\mordor' do
  rights :read, 'MORDOR\Minions'
  rights :full_control, 'MORDOR\Sauron'
  rights :write, 'SHIRE\Frodo' # Who put that there I didn't put that there
end

но затем не использовать свойство inherits, чтобы запретить эти права в подкаталоге:

directory 'C:\mordor\mount_doom' do
  deny_rights :read, 'MORDOR\Minions' # Oops, not specific enough
end

Поскольку свойство inherits не указано, Chef Infra Client установит его по умолчанию в true, что гарантирует сохранение настроек безопасности существующих файлов без изменений.

Ресурсы

В Chef Infra Client встроены следующие ресурсы:

Ресурс alternatives

Используйте ресурс alternatives для настройки альтернативных команд в Linux с помощью пакетов alternatives или update-alternatives.

Новое в Chef Infra Client 16.0.

Синтаксис

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

alternatives 'name' do
  link           String # default value: "/usr/bin/LINK_NAME"
  link_name      String # default value: 'name' unless specified
  path           String
  priority       String, Integer
  action         Symbol # defaults to :install if not specified
end

где:

• alternatives — ресурс.
• name — имя блока ресурса.
• action — определяет действия, которые Chef Infra Client предпримет для перевода узла в желаемое состояние.
• link, link_name, path и priority — доступные свойства этого ресурса.

Действия

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

:auto

Установить альтернативу в автоматическом режиме с автоматически выбранным наивысшим приоритетом.

:install

Установить альтернативу в системе, включая символические ссылки. (по умолчанию)

:nothing

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

:refresh

Обновить альтернативы.

:remove

Удалить альтернативу и все связанные ссылки.

:set

Установить символическую ссылку для альтернативы.

Свойства

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

link

Тип Ruby: Строка | Значение по умолчанию: /usr/bin/LINK_NAME

Путь к ссылке альтернативы.

link_name

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

Имя ссылки для создания. Это будет команда, которую вы введёте в командной строке, например ruby или gcc.

path

Тип Ruby: Строка

Абсолютный путь к исходному исполняемому файлу приложения, например /usr/bin/ruby27.

priority

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

Приоритет альтернативы.

Общие функции ресурса

Ресурсы Chef включают общие свойства, уведомления и защитные механизмы ресурсов.

Общие свойства

Следующие свойства являются общими для всех ресурсов:

compile_time

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

Управление фазой, в которой ресурс выполняется на узле. Установите значение true, чтобы выполнить ресурс во время построения коллекции ресурсов (compile phase). Установите значение false, чтобы выполнить ресурс во время конфигурации узла Клиентом Chef Infra (converge phase).

ignore_failure

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

Продолжить выполнение рецепта, если ресурс завершился неудачей по любой причине. :quiet не будет отображать полный стек вызовов, и рецепт продолжит выполнение, если ресурс завершился неудачей.

retries

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

Количество попыток перехватить исключения и повторить ресурс.

retry_delay

Тип Ruby: Целое число | Значение по умолчанию: 2

Задержка в секундах между попытками повтора.

sensitive

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

Убедиться, что конфиденциальные данные ресурса не регистрируются Клиентом Chef Infra.

Уведомления

notifies

Тип Ruby: Символ, 'Chef::Resource[String]'

Ресурс может уведомить другой ресурс о выполнении действия при изменении его состояния. Укажите 'resource[name]', :action, которое должен выполнить ресурс, а затем :timer для этого действия. Один ресурс может уведомлять несколько ресурсов; для каждого уведомляемого ресурса используйте инструкцию notifies.

Если указанный ресурс не существует, генерируется ошибка. В отличие от subscribes, который не завершится ошибкой, если исходный ресурс не найден.

Таймер указывает момент во время выполнения Клиента Chef Infra, в который выполняется уведомление. Доступны следующие таймеры:

:before

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

:delayed

По умолчанию. Указывает, что уведомление должно быть помещено в очередь и выполнено в конце выполнения Клиента Chef Infra.

: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, в который выполняется уведомление. Доступны следующие таймеры:

:before

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

:delayed

По умолчанию. Указывает, что уведомление должно быть помещено в очередь и выполнено в конце выполнения Клиента Chef Infra.

:immediate, :immediately

Указывает, что уведомление должно быть выполнено немедленно, для каждого уведомлённого ресурса.

Синтаксис для subscribes:

subscribes :action, 'resource[name]', :timer

Защитные механизмы

Свойство защитного механизма может использоваться для оценки состояния узла на этапе выполнения Клиента Chef Infra. Основываясь на результатах этой оценки, свойство защитного механизма сообщает Клиенту Chef Infra, следует ли продолжить выполнение ресурса. Свойство защитного механизма принимает либо строковое значение, либо значение блока Ruby:

• Строка выполняется как команда оболочки. Если команда возвращает 0, защитный механизм применяется. Если команда возвращает любое другое значение, свойство защитного механизма не применяется. Строковые защитные механизмы в powershell_script выполняют команды Windows PowerShell и могут возвращать true помимо 0.
• Блок выполняется как код Ruby, который должен возвращать либо true, либо false. Если блок возвращает true, свойство защитного механизма применяется. Если блок возвращает false, свойство защитного механизма не применяется.

Свойство защитного механизма полезно для обеспечения идемпотентности ресурса, позволяя этому ресурсу проверить желаемое состояние во время выполнения, а затем, если желаемое состояние присутствует, Клиент Chef Infra ничего не делает.

Следующие свойства могут использоваться для определения защитного механизма, который оценивается на этапе выполнения Клиента Chef Infra:

not_if

Запретить выполнение ресурса, когда условие возвращает true.

only_if

Разрешить выполнение ресурса только в том случае, если условие возвращает true.

Примеры

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

Установить альтернативу:

alternatives 'python install 2' do
  link_name 'python'
  path '/usr/bin/python2.7'
  priority 100
  action :install
end

Назначить альтернативу:

alternatives 'python set version 3' do
  link_name 'python'
  path '/usr/bin/python3'
  action :set
end

Установить автоматическое состояние альтернативы:

alternatives 'python auto' do
  link_name 'python'
  action :auto
end

Обновить альтернативу:

alternatives 'python refresh' do
  link_name 'python'
  action :refresh
end

Удалить альтернативу:

alternatives 'python remove' do
  link_name 'python'
  path '/usr/bin/python3'
  action :remove
end

Ресурс apt_package

Используйте ресурс apt_package для управления пакетами на платформах Debian, Ubuntu и других платформах, использующих систему пакетов APT.

Синтаксис

Блок ресурса apt_package управляет пакетом на узле, обычно устанавливая его. Самый простой способ использования ресурса apt_package — это: apt_package 'package_name', который установит указанный пакет с использованием всех параметров по умолчанию и действия по умолчанию :install.

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

apt_package 'name' do
  default_release              String
  options                      String, Array
  overwrite_config_files       true, false # default value: false
  package_name                 String, Array
  response_file                String
  response_file_variables      Hash # default value: {}
  timeout                      String, Integer
  version                      String, Array
  action                       Symbol # defaults to :install if not specified
end

где:

• apt_package — это ресурс.
• name — это имя, заданное для блока ресурса.
• action определяет шаги, которые Клиент Chef Infra предпримет, чтобы привести узел в желаемое состояние.
• default_release, options, overwrite_config_files, package_name, response_file, response_file_variables, timeout и version — это доступные свойства этого ресурса.

Действия

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

:install

Установить пакет. Если указана версия, установить указанную версию пакета. (по умолчанию)

:lock

Заблокировать пакет apt до определённой версии.

:nothing

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

:purge

Удалить пакет. Это действие обычно также удаляет конфигурационные файлы вместе с пакетом.

:reconfig

Переконфигурировать пакет. Для этого действия требуется файл ответа.

:remove

Удалить пакет.

:unlock

Разблокировать пакет apt, чтобы его можно было обновить до более новой версии.

:upgrade

Установить пакет и/или убедиться, что пакет является последней версией.

Свойства

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

default_release

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

Значение по умолчанию для релиза. Например: stable.

options

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

Один или несколько дополнительных параметров, передаваемых команде. Например, обычные директивы apt-get, такие как --no-install-recommends. Полный список см. в документации apt-get.

overwrite_config_files

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

Перезаписывать существующие конфигурационные файлы файлами, предоставленными пакетом, если об этом запросит APT.

Новое в Chef Client 14.0

package_name

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

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

response_file

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

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

response_file_variables

Тип в Ruby: Словарь | Значение по умолчанию: {}

Словарь переменных файла ответа в формате {‘ПЕРЕМЕННАЯ’ => ‘ЗНАЧЕНИЕ’}.

timeout

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

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

version

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

Версия пакета, который нужно установить или обновить.

Несколько пакетов

Ресурс может указывать несколько пакетов и/или версий для платформ, использующих менеджеры пакетов Apt, Chocolatey, DNF, Homebrew, Pacman или Zypper. Указание нескольких пакетов и/или версий позволяет одной транзакции:

• Загрузить указанные пакеты и версии в рамках одной HTTP-транзакции
• Обновить или установить несколько пакетов с помощью одного ресурса во время выполнения Chef Infra Client

Например, установка нескольких пакетов:

package %w(package1 package2)

Установка нескольких пакетов с версиями:

package %w(package1 package2) do
  version [ '1.3.4-2', '4.3.6-1']
end

Обновление нескольких пакетов:

package %w(package1 package2) do
  action :upgrade
end

Удаление нескольких пакетов:

package %w(package1 package2) do
  action :remove
end

Удаление нескольких пакетов (очистка):

package %w(package1 package2) do
  action :purge
end

Уведомления через неявное имя:

package %w(package1 package2) do
  action :nothing
end

log 'call a notification' do
  notifies :install, 'package[package1, package2]', :immediately
end

Общие функциональные возможности ресурсов

Ресурсы 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.

Несколько пакетов

Ресурс может указывать несколько пакетов и/или версий для платформ, использующих менеджеры пакетов Apt, Chocolatey, DNF, Homebrew, Pacman или Zypper. Указание нескольких пакетов и/или версий позволяет одной транзакции:

• Загрузить указанные пакеты и версии в рамках одной HTTP-транзакции
• Обновить или установить несколько пакетов с помощью одного ресурса во время выполнения Chef Infra Client

Например, установка нескольких пакетов:

package %w(package1 package2)

Установка нескольких пакетов с версиями:

package %w(package1 package2) do
  version [ '1.3.4-2', '4.3.6-1']
end

Обновление нескольких пакетов:

package %w(package1 package2) do
  action :upgrade
end

Удаление нескольких пакетов:

package %w(package1 package2) do
  action :remove
end

Очистка нескольких пакетов:

package %w(package1 package2) do
  action :purge
end

Уведомления, через неявное имя:

package %w(package1 package2) do
  action :nothing
end

log 'call a notification' do
  notifies :install, 'package[package1, package2]', :immediately
end

Примеры

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

Установка пакета с помощью менеджера пакетов:

apt_package 'name of package' do
  action :install
end

Установка пакета без указания действия по умолчанию:

apt_package 'name of package'

Установка нескольких пакетов одновременно:

apt_package %w(package1 package2 package3)

Установка без использования рекомендуемых пакетов в качестве зависимости:

package 'apache2' do
  options '--no-install-recommends'
end

Ресурс apt_preference

Используйте ресурс apt_preference для создания файлов предпочтений APT файлы предпочтений. Файлы предпочтений используются для управления тем, какие версии пакетов и источники отдаются приоритет при установке.

Новое в Chef Infra Client 13.3.

Синтаксис

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

apt_preference 'name' do
  glob              String
  package_name      String # default value: 'name' unless specified
  pin               String
  pin_priority      String, Integer
  action            Symbol # defaults to :add if not specified
end

где:

• apt_preference — это ресурс.
• name — это имя, присвоенное блоку ресурса.
• action определяет, какие действия Chef Infra Client предпримет для приведения узла в желаемое состояние.
• glob, package_name, pin и pin_priority — это свойства, доступные для этого ресурса.

Действия

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

:add

Создаёт файл предпочтений в /etc/apt/preferences.d. (по умолчанию)

:nothing

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

:remove

Удаляет файл предпочтений, тем самым отменяя привязку пакета.

Свойства

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

glob

Тип Ruby: Строка

Привязка с помощью glob() выражения или с помощью регулярного выражения в /.

package_name

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

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

pin

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

Версия пакета или репозитория для привязки.

pin_priority

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

Устанавливает приоритет привязки для пакета. Подробнее см. https://wiki.debian.org/AptPreferences.

Общие функциональные возможности ресурса

Ресурсы 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.

Примеры

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

Привязка libmysqlclient16 к версии 5.1.49-3:

apt_preference 'libmysqlclient16' do
  pin          'version 5.1.49-3'
  pin_priority '700'
end

Примечание: pin_priority 700 гарантирует, что эта версия будет предпочтительнее любых других доступных версий.

Отмена привязки libmysqlclient16:

apt_preference 'libmysqlclient16' do
  action :remove
end

Зафиксировать все пакеты для предпочтения репозитория packages.dotdeb.org:

apt_preference 'dotdeb' do
  glob         '*'
  pin          'origin packages.dotdeb.org'
  pin_priority '700'
end

Ресурс apt_repository

Используйте ресурс apt_repository для указания дополнительных репозиториев APT. Добавление нового репозитория немедленно обновит кэш пакетов APT.

Новое в Chef Infra Client 12.9.

Синтаксис

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

apt_repository 'name' do
  arch               String, false
  cache_rebuild      true, false # default value: true
  components         Array # default value: `main` if using a PPA repository.
  cookbook           String, false
  deb_src            true, false # default value: false
  distribution       String, false # default value: The LSB codename of the node such as 'focal'.
  key                String, Array, false # default value: []
  key_proxy          String, false
  keyserver          String, false # default value: "keyserver.ubuntu.com"
  repo_name          String # default value: 'name' unless specified
  trusted            true, false # default value: false
  uri                String
  action             Symbol # defaults to :add if not specified
end

где:

• apt_repository — это ресурс.
• name — имя, данное блоку ресурса.
• action определяет действия, которые Chef Infra Client предпримет для приведения узла в нужное состояние.
• arch, cache_rebuild, components, cookbook, deb_src, distribution, key, key_proxy, keyserver, repo_name, trusted и uri — доступные для этого ресурса свойства.

Действия

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

:add

Создаёт файл репозитория в /etc/apt/sources.list.d/ и строит список репозитория. (по умолчанию)

:nothing

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

:remove

Удаляет список репозитория.

Свойства

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

arch

Тип Ruby: Строка, false

Ограничить пакеты определённой архитектурой процессора, такой как i386 или amd64.

cache_rebuild

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

Определяет, нужно ли перестроить кэш пакетов APT.

components

Тип Ruby: Массив | Значение по умолчанию: `main` if using a PPA repository.

Группировки пакетов, такие как «main» и «stable».

cookbook

Тип Ruby: Строка, false

Если ключ должен быть cookbook_file, укажите кулинарную книгу, где находится ключ для файлов/default. Значение по умолчанию — nil, поэтому будет использована кулинарная книга, где используется ресурс.

deb_src

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

Определяет, нужно ли добавлять репозиторий в качестве репозитория источников.

distribution

Тип Ruby: Строка, false | Значение по умолчанию: The LSB codename of the node such as 'focal'.

Обычно кодовое имя дистрибутива, например, xenial, bionic или focal.

key

Тип Ruby: Строка, массив, false | Значение по умолчанию: []

Если указан сервер ключей, предполагается, что это отпечаток; в противном случае это может быть URI ключа GPG для репозитория или cookbook_file.

key_proxy

Тип Ruby: Строка, false

Если задано, указанный прокси передаётся в GPG через http-proxy=.

keyserver

Тип Ruby: Строка, false | Значение по умолчанию: keyserver.ubuntu.com

Сервер ключей GPG, где должен извлекаться ключ для репозитория.

repo_name

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

Необязательное свойство для установки имени репозитория, если оно отличается от имени блока ресурса. Значение этого параметра не должно содержать пробелов.

Новое в Chef Client 14.1

trusted

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

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

uri

Тип Ruby: Строка

Основа дистрибутива Debian.

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

Ресурсы 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.

Примеры

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

Добавление репозитория с базовыми настройками:

apt_repository 'nginx' do
  uri        'http://nginx.org/packages/ubuntu/'
  components ['nginx']
end

Включить репозитории Ubuntu multiverse:

apt_repository 'security-ubuntu-multiverse' do
  uri          'http://security.ubuntu.com/ubuntu'
  distribution 'xenial-security'
  components   ['multiverse']
  deb_src      true
end

Добавить PPA Nginx, автоматически обнаружить ключ и URL репозитория:

apt_repository 'nginx-php' do
  uri          'ppa:nginx/stable'
end

Добавить PPA JuJu, получить ключ с сервера ключей Ubuntu и добавить репозиторий источников:

apt_repository 'juju' do
  uri 'ppa:juju/stable'
  components ['main']
  distribution 'xenial'
  key 'C8068B11'
  action :add
  deb_src true
end

Добавить репозиторий, требующий нескольких ключей для аутентификации пакетов:

apt_repository 'rundeck' do
  uri 'https://dl.bintray.com/rundeck/rundeck-deb'
  distribution '/'
  key ['379CE192D401AB61', 'http://rundeck.org/keys/BUILD-GPG-KEY-Rundeck.org.key']
  keyserver 'keyserver.ubuntu.com'
  action :add
end

Добавить репозиторий Cloudera Repo пакетов CDH4 для Ubuntu 16.04 на AMD64:

apt_repository 'cloudera' do
  uri          'http://archive.cloudera.com/cdh4/ubuntu/xenial/amd64/cdh'
  arch         'amd64'
  distribution 'xenial-cdh4'
  components   ['contrib']
  key          'http://archive.cloudera.com/debian/archive.key'
end

Удалить репозиторий из списка:

apt_repository 'zenoss' do
  action :remove
end

Ресурс apt_update

Используйте ресурс apt_update для управления обновлениями репозиториев APT на платформах Debian и Ubuntu.

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

Синтаксис

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

apt_update 'name' do
  frequency      Integer # default value: 86400
  action         Symbol # defaults to :periodic if not specified
end

где:

• apt_update — это ресурс.
• name — это имя, заданное для блока ресурса.
• action определяет, какие действия Chef Infra Client предпримет для приведения узла в нужное состояние.
• frequency — это свойство, доступное для данного ресурса.

Без имени

Этот ресурс может быть без имени. Добавьте сам ресурс в свой рецепт, чтобы получить поведение по умолчанию:

apt_update

будет вести себя так же, как:

apt_update 'update'

Действия

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

:nothing

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

:periodic

Обновить репозиторий Apt с интервалом, указанным свойством frequency. (по умолчанию)

:update

Обновить репозиторий Apt в начале выполнения задания Chef Infra Client.

Свойства

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

frequency

Тип Ruby: Целое число | Значение по умолчанию: 86400

Определяет частоту (в секундах) обновления репозиториев APT. Используйте это свойство, когда указано действие :periodic.

Общие функциональные возможности ресурсов

Ресурсы 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.

Примеры

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

Обновить репозиторий Apt с указанным интервалом:

apt_update 'all platforms' do
  frequency 86400
  action :periodic
end

Обновить репозиторий Apt в начале выполнения задания Chef Infra Client:

apt_update 'update'

Ресурс archive_file

Используйте ресурс archive_file для извлечения архивов на диск. Этот ресурс использует библиотеку libarchive для извлечения нескольких форматов архивов, включая tar, gzip, bzip и zip.

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

Синтаксис

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

archive_file 'name' do
  destination           String
  group                 String
  mode                  String, Integer # default value: "'755'"
  options               Array, Symbol
  overwrite             true, false, auto # default value: false
  owner                 String
  path                  String # default value: 'name' unless specified
  strip_components      Integer # default value: 0
  action                Symbol # defaults to :extract if not specified
end

где:

• archive_file — ресурс.
• name — имя, данное блоку ресурса.
• action определяет, какие шаги Chef Infra Client предпримет для приведения узла в желаемое состояние.
• destination, group, mode, options, overwrite, owner, path и strip_components — доступные свойства для данного ресурса.

Действия

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

:extract

Извлечение и архивирование файла. (по умолчанию)

:nothing

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

Свойства

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

destination

Тип Ruby: String | REQUIRED

Путь к файлу, куда будет извлечен архивный файл.

group

Тип Ruby: String

Группа извлечённых файлов.

mode

Тип Ruby: String, Integer | Значение по умолчанию: '755'

Режим извлечённых файлов. Целочисленные значения устарели, так как восьмеричные значения (например, 0755) не будут интерпретированы правильно.

options

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

Массив символов, представляющих флаги извлечения. Например: :no_overwrite, чтобы предотвратить перезапись файлов на диске. По умолчанию, это правильно устанавливает :time, сохраняя временные метки изменения файлов в архиве при их записи на диск.

overwrite

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

Нужно ли ресурсу перезаписывать содержимое файла назначения, если он уже существует? Если установлено значение :auto, дата изменения файлов в архиве будет сравниваться с датами на диске, и содержимое диска будет перезаписано, если они различаются. Это может вызвать нежелательные последствия, если временные метки диска изменяются между запусками, что приведёт к перезаписи файлов при каждом запуске клиента. Убедитесь, что вы правильно протестировали любое изменение этого свойства.

owner

Тип Ruby: String

Владелец извлечённых файлов.

path

Тип Ruby: String | Значение по умолчанию: The resource block's name

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

strip_components

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

Удалить указанное количество ведущих элементов пути. Пути с меньшим количеством элементов будут пропущены без ошибок. Это поведение аналогично аргументу командной строки tar’s –strip-components.

Новое в Chef Infra Client 17.5

Общие функциональные возможности ресурсов

Ресурсы 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.

Примеры

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

Извлечение zip-файла в указанный каталог:

archive_file 'Precompiled.zip' do
  path '/tmp/Precompiled.zip'
  destination '/srv/files'
end

Установление конкретных прав на извлечённые файлы:

archive_file 'Precompiled.zip' do
  owner 'tsmith'
  group 'staff'
  mode '700'
  path '/tmp/Precompiled.zip'
  destination '/srv/files'
end

ресурс bash

Используйте ресурс bash для выполнения скриптов с помощью интерпретатора Bash. Этот ресурс также может использовать любые действия и свойства, доступные ресурсу execute. Команды, выполняемые с помощью этого ресурса, по своей природе не являются идемпотентными, поскольку они обычно уникальны для среды, в которой они выполняются. Используйте not_if и only_if для защиты этого ресурса от идемпотентности.

Синтаксис

Блок ресурса bash выполняет скрипты с помощью Bash:

bash 'extract_module' do
  cwd ::File.dirname(src_filepath)
  code <<-EOH
    mkdir -p #{extract_path}
    tar xzf #{src_filename} -C #{extract_path}
    mv #{extract_path}/*/* #{extract_path}/
  EOH
  not_if { ::File.exist?(extract_path) }
end

где:

• cwd указывает директорию, из которой выполняется команда
• code указывает команду для выполнения

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

bash 'name' do
  code                       String
  creates                    String
  cwd                        String
  environment                Hash
  flags                      String
  group                      String, Integer
  path                       Array
  returns                    Integer, Array
  timeout                    Integer, Float
  user                       String, Integer
  umask                      String, Integer
  action                     Symbol # defaults to :run if not specified
end

где:

• bash — ресурс.
• name — имя, присвоенное блоку ресурса.
• action определяет шаги, которые Chef Infra Client выполнит для приведения узла в желаемое состояние.
• code, creates, cwd, environment, flags, group, path, returns, timeout, user и umask — свойства этого ресурса с указанным типом Ruby. Подробную информацию обо всех свойствах, которые можно использовать с этим ресурсом, см. в разделе «Свойства» ниже.

Действия

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

:nothing

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

:run

По умолчанию. Выполнить скрипт.

Свойства

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

code

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

Строка кода, заключенная в кавычки (" “), которая должна быть выполнена.

creates

Тип Ruby: Строка

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

cwd

Тип Ruby: Строка

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

environment

Тип Ruby: Хэш

Хэш переменных окружения в формате ({'ENV_VARIABLE' => 'VALUE'}). Примечание: эти переменные должны существовать для успешного выполнения команды.

flags

Тип Ruby: Строка

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

group

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

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

returns

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

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

timeout

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

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

user

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

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

umask

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

Маска создания режима файла или umask.

Общие функции ресурса

Ресурсы 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.

Примеры

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

Использование именованного провайдера для выполнения скрипта

bash 'install_something' do
  user 'root'
  cwd '/tmp'
  code <<-EOH
    wget http://www.example.com/tarball.tar.gz
    tar -zxf tarball.tar.gz
    cd tarball
    ./configure
    make
    make install
  EOH
end

Установка файла из удалённого расположения с помощью bash

Следующий пример показывает, как установить модуль foo123 для Nginx. Этот модуль добавляет функциональность в стиле оболочки в файл конфигурации Nginx и выполняет следующие действия:

• Объявляет три переменные
• Получает файл Nginx из удаленного расположения
• Устанавливает файл с помощью Bash по пути, указанному переменной src_filepath

# the following code sample is similar to the ``upload_progress_module``
# recipe in the ``nginx`` cookbook:
# https://github.com/chef-cookbooks/nginx

src_filename = "foo123-nginx-module-v#{
  node['nginx']['foo123']['version']
}.tar.gz"
src_filepath = "#{Chef::Config['file_cache_path']}/#{src_filename}"
extract_path = "#{
  Chef::Config['file_cache_path']
  }/nginx_foo123_module/#{
  node['nginx']['foo123']['checksum']
}"

remote_file 'src_filepath' do
  source node['nginx']['foo123']['url']
  checksum node['nginx']['foo123']['checksum']
  owner 'root'
  group 'root'
  mode '0755'
end

bash 'extract_module' do
  cwd ::File.dirname(src_filepath)
  code <<-EOH
    mkdir -p #{extract_path}
    tar xzf #{src_filename} -C #{extract_path}
    mv #{extract_path}/*/* #{extract_path}/
  EOH
  not_if { ::File.exist?(extract_path) }
end

Установка приложения из git с помощью bash

Следующий пример демонстрирует, как Bash можно использовать для установки плагина для rbenv под названием ruby-build, который находится в системе управления версиями Git. Сначала приложение синхронизируется, затем Bash изменяет текущую рабочую директорию на местоположение, в котором находится ruby-build, и затем выполняет команду.

git "#{Chef::Config[:file_cache_path]}/ruby-build" do
  repository 'git://github.com/sstephenson/ruby-build.git'
  revision 'master'
  action :sync
end

bash 'install_ruby_build' do
  cwd "#{Chef::Config[:file_cache_path]}/ruby-build"
  user 'rbenv'
  group 'rbenv'
  code <<-EOH
    ./install.sh
  EOH
  environment 'PREFIX' => '/usr/local'
end

Чтобы узнать больше о ruby-build, посетите: https://github.com/sstephenson/ruby-build.

Хранение определенных настроек

Следующий рецепт демонстрирует, как файл атрибутов можно использовать для хранения определенных настроек. Файл атрибутов расположен в каталоге attributes/ в том же кулинарном руководстве (cookbook), что и рецепт, вызывающий файл атрибутов. В этом примере файл атрибутов указывает определённые настройки для Python, которые затем используются на всех узлах, на которых будет выполняться этот рецепт.

У пакетов Python есть версии, каталоги установки, URL-адреса и файлы контрольных сумм. Файл атрибутов, предназначенный для поддержки этого типа рецепта, должен содержать настройки, подобные следующим:

default['python']['version'] = '2.7.1'

if python['install_method'] == 'package'
  default['python']['prefix_dir'] = '/usr'
else
  default['python']['prefix_dir'] = '/usr/local'
end

default['python']['url'] = 'http://www.python.org/ftp/python'
default['python']['checksum'] = '80e387...85fd61'

а затем методы в рецепте могут ссылаться на эти значения. Рецепт, используемый для установки Python, должен выполнить следующие действия:

• Определить каждый пакет, который нужно установить (в данном примере подразумевается, но не показано)
• Определить переменные для пакета version и install_path
• Получить пакет из удалённого места, но только если пакет еще не существует на целевой системе
• Использовать ресурс bash для установки пакета на узел, но только если пакет еще не установлен

#  the following code sample comes from the ``oc-nginx`` cookbook on |github|: https://github.com/cookbooks/oc-nginx

version = node['python']['version']
install_path = "#{node['python']['prefix_dir']}/lib/python#{version.split(/(^\d+\.\d+)/)[1]}"

remote_file "#{Chef::Config[:file_cache_path]}/Python-#{version}.tar.bz2" do
  source "#{node['python']['url']}/#{version}/Python-#{version}.tar.bz2"
  checksum node['python']['checksum']
  mode '0755'
  not_if { ::File.exist?(install_path) }
end

bash 'build-and-install-python' do
  cwd Chef::Config[:file_cache_path]
  code <<-EOF
    tar -jxvf Python-#{version}.tar.bz2
    (cd Python-#{version} && ./configure #{configure_options})
    (cd Python-#{version} && make && make install)
  EOF
  not_if { ::File.exist?(install_path) }
end

ресурс batch

Используйте ресурс 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. Возникает исключение, когда для 32-битного процесса задаётся значение отличное от :i386. Возможные значения: :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 в формате универсального имени принципала (UPN). Его также можно указать без домена просто как user, если домен вместо этого указан с помощью атрибута domain. Только в Windows, если это свойство указано, свойство password должно быть указано.

password

Тип Ruby: Строка

Только Windows: Пароль пользователя, указанного свойством user. Это свойство является обязательным, если в Windows указано user, и может быть указано только если указано 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[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.

Примеры

В следующих примерах демонстрируются различные подходы к использованию ресурса 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

ресурс bff_package

Используйте ресурс bff_package для управления пакетами для платформы AIX с помощью утилиты installp. При установке пакета из локального файла он должен быть добавлен в узел с помощью ресурсов remote_file или cookbook_file.

Синтаксис

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

bff_package 'name' do
  options           String, Array
  package_name      String
  source            String
  timeout           String, Integer
  version           String
  action            Symbol # defaults to :install if not specified
end

где:

• bff_package — это ресурс.
• name — это имя, данное блоку ресурса.
• action определяет шаги, которые Chef Infra Client предпримет, чтобы привести узел к желаемому состоянию.
• options, package_name, source, timeout и version — это доступные свойства этого ресурса.

Действия

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

:install

По умолчанию. Устанавливает пакет. Если указана версия, устанавливает указанную версию пакета.

:nothing

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

:purge

Удалить пакет. Это действие обычно удаляет конфигурационные файлы, а также пакет.

:remove

Удалить пакет.

Свойства

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

options

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

Одна или несколько дополнительных опций команды, которые передаются команде.

package_name

Тип Ruby: Строка

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

source

Тип Ruby: Строка

Обязательное свойство. Путь к пакету в локальной файловой системе. Платформа AIX требует, чтобы source был путём к локальной файловой системе, потому что installp не получает пакеты с помощью HTTP или FTP.

timeout

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

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

version

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

Примеры

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

Ресурс bff_package является поставщиком пакетов по умолчанию на платформе AIX. Базовый ресурс package может быть использован, и затем, когда платформа является AIX, Chef Infra Client определит правильного поставщика пакетов. Следующие примеры показывают, как установить часть компилятора IBM XL C/C++.

Установка с использованием базового ресурса package

package 'xlccmp.13.1.0' do
  source '/var/tmp/IBM_XL_C_13.1.0/usr/sys/inst.images/xlccmp.13.1.0'
  action :install
end

Установка с использованием ресурса bff_package

bff_package 'xlccmp.13.1.0' do
  source '/var/tmp/IBM_XL_C_13.1.0/usr/sys/inst.images/xlccmp.13.1.0'
  action :install
end

ресурс breakpoint

Используйте ресурс breakpoint для добавления точек останова в рецепты. Запустите chef-shell в режиме Chef Infra Client, а затем используйте эти точки останова для отладки рецептов. Точки останова игнорируются chef-client во время фактического выполнения chef-client. Тем не менее, точки останова обычно используются для отладки рецептов только при выполнении в среде, отличной от рабочей, после чего они удаляются из этих рецептов перед загрузкой родительского кулинарного руководства на сервер Chef.

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

Синтаксис

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

breakpoint 'name' do
  action      Symbol # defaults to :break if not specified
end

где:

• breakpoint — это ресурс.
• name — это имя, данное блоку ресурса.
• action определяет, какие шаги Chef Infra Client предпримет для приведения узла в желаемое состояние.

Действия

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

:break

Добавить точку останова для использования с chef-shell (по умолчанию)

:nothing

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

Свойства

Этот ресурс не имеет свойств.

Отладка рецептов с помощью chef-shell

Режимы

chef-shell — это инструмент, который запускается с использованием сессии Interactive Ruby (IRb). chef-shell в настоящее время поддерживает синтаксис файлов рецептов и атрибутов, а также интерактивные функции отладки. chef-shell имеет три режима запуска:

Настройка

chef-shell определяет, какой файл конфигурации загружать, на основе следующего:

1. Если файл конфигурации указан с помощью параметра -c, chef-shell будет использовать указанный файл конфигурации
2. Если задан NAMED_CONF, chef-shell загрузит ~/.chef/NAMED_CONF/chef_shell.rb
3. Если NAMED_CONF не задан, chef-shell загрузит ~/.chef/chef_shell.rb, если он существует
4. Если chef_shell.rb не найден, chef-shell переходит к загрузке:
   • /etc/chef/client.rb, если задан параметр -z.
   • /etc/chef/solo.rb, если задан параметр –solo-legacy-mode.
   • .chef/config.rb, если задан параметр -s.
   • .chef/knife.rb, если задан параметр -s.

chef-shell.rb

Файл chef-shell.rb можно использовать для настройки chef-shell так же, как файл client.rb используется для настройки Chef Infra Client. Например, чтобы настроить chef-shell для аутентификации на сервере Chef Infra, скопируйте настройки node_name, client_key и chef_server_url из файла config.rb:

node_name                'your-knife-clientname'
client_key               File.expand_path('~/.chef/my-client.pem')
chef_server_url          'https://api.opscode.com/organizations/myorg'

и добавьте их в файл chef-shell.rb. Другие возможности настройки включают отключение плагинов Ohai (что ускорит процесс запуска chef-shell) или включение произвольного кода Ruby в файл chef-shell.rb.

Запуск в качестве клиента Chef Infra

По умолчанию chef-shell загружается в автономном режиме и не подключается к серверу Chef Infra. chef-shell можно запустить как клиента Chef Infra для проверки функциональности, доступной только при подключении клиента Chef Infra к серверу Chef Infra, например, функциональности поиска или доступа к данным, хранящимся в пакетах данных.

chef-shell может использовать те же учетные данные, что и knife, при подключении к серверу Chef Infra. Убедитесь, что настройки в chef-shell.rb такие же, как в config.rb, а затем используйте параметр -z в команде. Например:

chef-shell -z

Управление

При настройке chef-shell для доступа к Chef Infra Server, chef-shell может перечислять, отображать, искать и редактировать кулинарии, клиентов, узлы, роли, среды, файлы политики и пакеты данных.

Синтаксис управления объектами на Chef Infra Server следующий:

chef-shell -z named_configuration

Где:

• named_configuration — это существующий файл конфигурации в ~/.chef/named_configuration/chef_shell.rb, такой как production, staging или test.

После входа в chef-shell команды могут выполняться над объектами следующим образом:

chef (preprod) > items.command

Где:

• items — это тип элемента для поиска: cookbooks, clients, nodes, roles, environments или пакет данных.
• command — это команда: list, show, find или edit.

Например, чтобы перечислить все узлы в конфигурации под названием «preprod», введите:

chef (preprod) > nodes.list

Что вернёт примерно следующее:

=> [node[i-f09a939b], node[i-049a936f], node[i-eaaaa581], node[i-9154b1fb],
    node[i-6a213101], node[i-c2687aa9], node[i-7abeaa11], node[i-4eb8ac25],
    node[i-9a2030f1], node[i-a06875cb], node[i-145f457f], node[i-e032398b],
    node[i-dc8c98b7], node[i-6afdf401], node[i-f49b119c], node[i-5abfab31],
    node[i-78b8ac13], node[i-d99678b3], node[i-02322269], node[i-feb4a695],
    node[i-9e2232f5], node[i-6e213105], node[i-cdde3ba7], node[i-e8bfb083],
    node[i-743c2c1f], node[i-2eaca345], node[i-aa7f74c1], node[i-72fdf419],
    node[i-140e1e7f], node[i-f9d43193], node[i-bd2dc8d7], node[i-8e7f70e5],
    node[i-78f2e213], node[i-962232fd], node[i-4c322227], node[i-922232f9],
    node[i-c02728ab], node[i-f06c7b9b]]

Команда list может принимать код блока, который будет применяться (но не сохраняться) к каждому объекту, возвращаемому сервером. Например:

chef (preprod) > nodes.list {|n| puts "#{n.name}: #{n.run_list}" }

вернёт примерно следующее:

=> i-f09a939b: role[lb], role[preprod], recipe[aws]
   i-049a936f: role[lb], role[preprod], recipe[aws]
   i-9154b1fb: recipe[erlang], role[base], role[couchdb], role[preprod],
   i-6a213101: role[chef], role[preprod]
   # more...

Команда show может использоваться для отображения конкретного узла. Например:

chef (preprod) > load_balancer = nodes.show('i-f09a939b')

вернёт примерно следующее:

=> node[i-f09a939b]

Или:

chef (preprod) > load_balancer.ec2.public_hostname

вернёт примерно следующее:

=> "ec2-111-22-333-44.compute-1.amazonaws.com"

Команда find может использоваться для поиска на Chef Infra Server из chef-shell. Например:

chef (preprod) > pp nodes.find(:ec2_public_hostname => 'ec2*')

Вы также можете форматировать результаты с помощью блока кода. Например:

chef (preprod) > pp nodes.find(:ec2_public_hostname => 'ec2*') {|n| n.ec2.ami_id } and nil

вернёт примерно следующее:

=> ["ami-f8927a91",
    "ami-f8927a91",
    "ami-a89870c1",
    "ami-a89870c1",
    "ami-a89870c1",
    "ami-a89870c1",
    "ami-a89870c1"
    # and more...

Или:

chef (preprod) > amis = nodes.find(:ec2_public_hostname => 'ec2*') {|n| n.ec2.ami_id }
chef (preprod) > puts amis.uniq.sort

вернёт примерно следующее:

=> ami-4b4ba522
   ami-a89870c1
   ami-eef61587
   ami-f8927a91

Использование точек останова

Пошаговое выполнение списка выполнения

Чтобы изучить, как использовать точку останова для ручного пошагового выполнения работы Chef Infra Client, создайте простой рецепт в chef-shell:

chef > recipe_mode
  chef:recipe > echo off
  chef:recipe > file "/tmp/before-breakpoint"
  chef:recipe > breakpoint "foo"
  chef:recipe > file "/tmp/after-breakpoint"

а затем запустите Chef Infra Client:

chef:recipe > run_chef
  [Fri, 15 Jan 2020 14:17:49 -0800] DEBUG: Processing file[/tmp/before-breakpoint]
  [Fri, 15 Jan 2020 14:17:49 -0800] DEBUG: file[/tmp/before-breakpoint] using Chef::Provider::File
  [Fri, 15 Jan 2020 14:17:49 -0800] INFO: Creating file[/tmp/before-breakpoint] at /tmp/before-breakpoint
  [Fri, 15 Jan 2020 14:17:49 -0800] DEBUG: Processing [./bin/../lib/chef/mixin/recipe_definition_dsl_core.rb:56:in 'new']
  [Fri, 15 Jan 2020 14:17:49 -0800] DEBUG: [./bin/../lib/chef/mixin/recipe_definition_dsl_core.rb:56:in 'new'] using Chef::Provider::Breakpoint

Chef Infra Client выполнил первый ресурс до точки останова (file[/tmp/before-breakpoint]), но затем остановился после выполнения. Chef Infra Client попытался назвать точку останова по её позиции в исходном файле, но Chef Infra Client запутался, потому что ресурс был введён интерактивно. Отсюда chef-shell может возобновить прерванную работу Chef Infra Client:

chef:recipe > chef_run.resume
  [Fri, 15 Jan 2020 14:27:08 -0800] INFO: Creating file[/tmp/after-breakpoint] at /tmp/after-breakpoint

Быстрый просмотр каталога /tmp показывает, что были созданы следующие файлы:

after-breakpoint
before-breakpoint

Вы можете перемотать и пройтись по выполнению Chef Infra Client:

chef:recipe > Chef::Log.level = :debug # debug logging won't turn on automatically in this case
    => :debug
  chef:recipe > chef_run.rewind
    => 0
  chef:recipe > chef_run.step
  [Fri, 15 Jan 2020 14:40:52 -0800] DEBUG: Processing file[/tmp/before-breakpoint]
  [Fri, 15 Jan 2020 14:40:52 -0800] DEBUG: file[/tmp/before-breakpoint] using Chef::Provider::File
    => 1
  chef:recipe > chef_run.step
  [Fri, 15 Jan 2020 14:40:54 -0800] DEBUG: Processing [./bin/../lib/chef/mixin/recipe_definition_dsl_core.rb:56:in 'new']
  [Fri, 15 Jan 2020 14:40:54 -0800] DEBUG: [./bin/../lib/chef/mixin/recipe_definition_dsl_core.rb:56:in 'new'] using Chef::Provider::Breakpoint
    => 2
  chef:recipe > chef_run.step
  [Fri, 15 Jan 2020 14:40:56 -0800] DEBUG: Processing file[/tmp/after-breakpoint]
  [Fri, 15 Jan 2020 14:40:56 -0800] DEBUG: file[/tmp/after-breakpoint] using Chef::Provider::File
    => 3

Из вывода показан перемотанный список выполнения, но когда ресурсы выполняются снова, они будут повторять свои проверки существования файлов. Если они существуют, Chef Infra Client пропустит их создание. Если файлы удалены, то:

chef:recipe > ls("/tmp").grep(/breakpoint/).each {|f| rm "/tmp/#{f}" }
    => ["after-breakpoint", "before-breakpoint"]

Перемотайте и возобновите выполнение Chef Infra Client, чтобы получить ожидаемые результаты:

chef:recipe > chef_run.rewind
  chef:recipe > chef_run.resume
  [Fri, 15 Jan 2020 14:48:56 -0800] DEBUG: Processing file[/tmp/before-breakpoint]
  [Fri, 15 Jan 2020 14:48:56 -0800] DEBUG: file[/tmp/before-breakpoint] using Chef::Provider::File
  [Fri, 15 Jan 2020 14:48:56 -0800] INFO: Creating file[/tmp/before-breakpoint] at /tmp/before-breakpoint
  [Fri, 15 Jan 2020 14:48:56 -0800] DEBUG: Processing [./bin/../lib/chef/mixin/recipe_definition_dsl_core.rb:56:in 'new']
  [Fri, 15 Jan 2020 14:48:56 -0800] DEBUG: [./bin/../lib/chef/mixin/recipe_definition_dsl_core.rb:56:in 'new'] using Chef::Provider::Breakpoint
  chef:recipe > chef_run.resume
  [Fri, 15 Jan 2020 14:49:20 -0800] DEBUG: Processing file[/tmp/after-breakpoint]
  [Fri, 15 Jan 2020 14:49:20 -0800] DEBUG: file[/tmp/after-breakpoint] using Chef::Provider::File
  [Fri, 15 Jan 2020 14:49:20 -0800] INFO: Creating file[/tmp/after-breakpoint] at /tmp/after-breakpoint

Отладка существующего рецепта

chef-shell можно использовать для отладки существующих рецептов. Рецепт сначала необходимо добавить в список выполнения для узла, чтобы он был кэширован при запуске chef-shell и затем использовался для отладки. chef-shell сообщит, какие рецепты кэшируются при запуске:

loading configuration: none (standalone session)
Session type: standalone
Loading.............done.

Welcome to the chef-shell 15.8.23
For usage see https://docs.chef.io/chef_shell.html

run `help' for help, `exit' or ^D to quit.

chef (15.8.23)>

Чтобы загрузить только один рецепт из списка выполнения, перейдите в рецепт и используйте команду include_recipe. Например:

chef > recipe_mode
  chef:recipe > include_recipe "getting-started"
    => [#< Chef::Recipe:0x10256f9e8 @cookbook_name="getting-started",
  ... output truncated ...

Чтобы загрузить все рецепты из списка выполнения, используйте код, подобный следующему:

node.run_list.expand(node.chef_environment).recipes.each do |r|
  include_recipe r
end

После загрузки рецептов, которые нужно отладить, используйте команду run_chef для их запуска.

Расширенная отладка

В chef-shell можно получить подробную отладку, используя функцию трассировки в Interactive Ruby (IRb). chef-shell предоставляет ярлык для включения и выключения трассировки. Например:

chef > tracing on
tracing is on
=> nil
chef >

и:

chef > tracing off
#0:(irb):2:Object:-: tracing off
#0:/opt/chef-workstation/embedded/lib/ruby/gems/2.6.0/gems/chef-15.8.23/lib/chef/shell/ext.rb:109:Shell::Extensions::ObjectCoreExtensions:>:       def off
#0:/opt/chef-workstation/embedded/lib/ruby/gems/2.6.0/gems/chef-15.8.23/lib/chef/shell/ext.rb:110:Shell::Extensions::ObjectCoreExtensions:-:         :off
#0:/opt/chef-workstation/embedded/lib/ruby/gems/2.6.0/gems/chef-15.8.23/lib/chef/shell/ext.rb:111:Shell::Extensions::ObjectCoreExtensions:<:       end
#0:/opt/chef-workstation/embedded/lib/ruby/gems/2.6.0/gems/chef-15.8.23/lib/chef/shell/ext.rb:272:main:>:       def tracing(on_or_off)
#0:/opt/chef-workstation/embedded/lib/ruby/gems/2.6.0/gems/chef-15.8.23/lib/chef/shell/ext.rb:273:main:-:         conf.use_tracer = on_or_off.on_off_to_bool
#0:/opt/chef-workstation/embedded/lib/ruby/gems/2.6.0/gems/chef-15.8.23/lib/chef/shell/ext.rb:162:Shell::Extensions::Symbol:>:       def on_off_to_bool
#0:/opt/chef-workstation/embedded/lib/ruby/gems/2.6.0/gems/chef-15.8.23/lib/chef/shell/ext.rb:163:Shell::Extensions::Symbol:-:         to_s.on_off_to_bool
#0:/opt/chef-workstation/embedded/lib/ruby/gems/2.6.0/gems/chef-15.8.23/lib/chef/shell/ext.rb:149:Shell::Extensions::String:>:       def on_off_to_bool
#0:/opt/chef-workstation/embedded/lib/ruby/gems/2.6.0/gems/chef-15.8.23/lib/chef/shell/ext.rb:150:Shell::Extensions::String:-:         case self
#0:/opt/chef-workstation/embedded/lib/ruby/gems/2.6.0/gems/chef-15.8.23/lib/chef/shell/ext.rb:154:Shell::Extensions::String:-:           false
#0:/opt/chef-workstation/embedded/lib/ruby/gems/2.6.0/gems/chef-15.8.23/lib/chef/shell/ext.rb:158:Shell::Extensions::String:<:       end
#0:/opt/chef-workstation/embedded/lib/ruby/gems/2.6.0/gems/chef-15.8.23/lib/chef/shell/ext.rb:164:Shell::Extensions::Symbol:<:       end
tracing is off
=> nil
chef >

Примеры отладки

В следующих примерах показано, как использовать chef-shell.

"Hello World"

В этом примере показано, как запустить chef-shell в автономном режиме. (Для режимов chef-solo или Chef Infra Client необходимо запустить chef-shell с помощью параметров командной строки -s или -z, а затем учесть необходимые параметры конфигурации.)

Когда Chef Infra Client установлен с помощью RubyGems или менеджера пакетов, chef-shell также должен быть установлен. Когда Chef Infra Client запускается из git-клона, он будет находиться в chef/bin/chef shell. Чтобы запустить chef-shell, просто запустите его без каких-либо параметров. Вы увидите сообщение о загрузке, затем баннер, а затем приглашение chef-shell:

bin/chef-shell

  loading configuration: none (standalone session)
  Session type: standalone
  Loading.............done.

  Welcome to the chef-shell 15.8.23
  For usage see https://docs.chef.io/chef_shell.html

  run `help' for help, `exit' or ^D to quit.

  chef (15.8.23)>

(Используйте команду help для вывода списка поддерживаемых команд.) Используйте команду recipe_mode, чтобы переключиться в контекст рецепта:

chef > recipe_mode
  chef:recipe_mode >

Ввод оценивается в том же контексте, что и рецепты. Создайте ресурс файла:

chef:recipe_mode > file "/tmp/ohai2u_shef"
    => #< Chef::Resource::File:0x1b691ac
       @enclosing_provider=nil,
       @resource_name=:file,
       @before=nil,
       @supports={},
       @backup=5,
       @allowed_actions=[:nothing, :create, :delete, :touch, :create_if_missing],
       @only_if=nil,
       @noop=nil,
       @collection=#< Chef::ResourceCollection:0x1b9926c
       @insert_after_idx=nil,
       @resources_by_name={"file[/tmp/ohai2u_shef]"=>0},
       @resources=[#< Chef::Resource::File:0x1b691ac ...>]>,
       @updated=false,
       @provider=nil,
       @node=< Chef::Node:0xdeeaae
       @name="eigenstate.local">,
       @recipe_name=nil,
       @not_if=nil,
       @name="/tmp/ohai2u_shef",
       @action="create",
       @path="/tmp/ohai2u_shef",
       @source_line="/Users/username/ruby/chef/chef/(irb#1) line 1",
       @params={},
       @actions={},
       @cookbook_name=nil,
       @ignore_failure=false>

(Предыдущий пример был отформатирован для представления.) На этом этапе chef-shell создал ресурс и поместил его в список выполнения, но ещё не создал файл. Чтобы начать выполнение Chef Infra Client, используйте команду run_chef:

chef:recipe_mode > run_chef
  [Fri, 15 Jan 2020 10:42:47 -0800] DEBUG: Processing file[/tmp/ohai2u_shef]
  [Fri, 15 Jan 2020 10:42:47 -0800] DEBUG: file[/tmp/ohai2u_shef] using Chef::Provider::File
  [Fri, 15 Jan 2020 10:42:47 -0800] INFO: Creating file[/tmp/ohai2u_shef] at /tmp/ohai2u_shef
    => true

chef-shell также может переключаться на тот же контекст, что и файлы атрибутов. Установите атрибут с помощью следующего синтаксиса:

chef:recipe_mode > attributes_mode
  chef:attributes > default[:hello] = "ohai2u-again"
    => "ohai2u-again"
  chef:attributes >

Вернитесь в контекст recipe_mode и используйте атрибуты:

chef:attributes > recipe_mode
    => :attributes
  chef:recipe_mode > file "/tmp/#{node.hello}"

Теперь запустите Chef Infra Client снова:

chef:recipe_mode > run_chef
  [Fri, 15 Jan 2020 10:53:22 -0800] DEBUG: Processing file[/tmp/ohai2u_shef]
  [Fri, 15 Jan 2020 10:53:22 -0800] DEBUG: file[/tmp/ohai2u_shef] using Chef::Provider::File
  [Fri, 15 Jan 2020 10:53:22 -0800] DEBUG: Processing file[/tmp/ohai2u-again]
  [Fri, 15 Jan 2020 10:53:22 -0800] DEBUG: file[/tmp/ohai2u-again] using Chef::Provider::File
  [Fri, 15 Jan 2020 10:53:22 -0800] INFO: Creating file[/tmp/ohai2u-again] at /tmp/ohai2u-again
    => true
  chef:recipe_mode >

Поскольку первый ресурс (file[/tmp/ohai2u_shef]) всё ещё в списке выполнения, он выполняется снова. И поскольку этот файл уже существует, Chef Infra Client не пытается его повторно создать. Наконец, файлы были созданы с помощью метода ls:

chef:recipe_mode > ls("/tmp").grep(/ohai/)
    => ["ohai2u-again", "ohai2u_shef"]
  Shell Tutorial

Получение конкретных узлов

Чтобы получить список узлов, использующих рецепт под названием postfix, используйте search(:node,"recipe:postfix"). Чтобы получить список узлов, использующих подрецепт под названием delivery, используйте chef-shell. Например:

search(:node, 'recipes:postfix\:\:delivery')

Примеры

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

Рецепт без точки останова

yum_key node['yum']['elrepo']['key'] do
  url  node['yum']['elrepo']['key_url']
  action :add
end

yum_repository 'elrepo' do
  description 'ELRepo.org Community Enterprise Linux Extras Repository'
  key node['yum']['elrepo']['key']
  mirrorlist node['yum']['elrepo']['url']
  includepkgs node['yum']['elrepo']['includepkgs']
  exclude node['yum']['elrepo']['exclude']
  action :create
end

Тот же рецепт с точками останова

В следующем примере имя каждой точки останова — произвольная строка.

breakpoint "before yum_key node['yum']['repo_name']['key']" do
  action :break
end

yum_key node['yum']['repo_name']['key'] do
  url  node['yum']['repo_name']['key_url']
  action :add
end

breakpoint "after yum_key node['yum']['repo_name']['key']" do
  action :break
end

breakpoint "before yum_repository 'repo_name'" do
  action :break
end

yum_repository 'repo_name' do
  description 'description'
  key node['yum']['repo_name']['key']
  mirrorlist node['yum']['repo_name']['url']
  includepkgs node['yum']['repo_name']['includepkgs']
  exclude node['yum']['repo_name']['exclude']
  action :create
end

breakpoint "after yum_repository 'repo_name'" do
  action :break
end

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

ресурс build_essential

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

Новое в Chef Infra Client 14.0.

Синтаксис

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

build_essential 'name' do
  raise_if_unsupported      true, false # default value: false
  action                    Symbol # defaults to :install if not specified
end

где:

• build_essential — это ресурс.
• name — это имя, заданное для блока ресурса.
• action — это идентификатор действий, которые Chef Infra Client предпримет для перевода узла в нужное состояние.
• raise_if_unsupported — это свойство, доступное для этого ресурса.

Без имени

Этот ресурс может быть без имени. Добавьте сам ресурс в свой рецепт, чтобы получить стандартное поведение:

build_essential

будет вести себя так же, как:

build_essential 'install tools'

Действия

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

:install

Установка пакетов build essential. (по умолчанию)

:nothing

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

:upgrade

Обновление Xcode CLI Tools на узлах macOS. Новое в Chef Infra Client 16

Свойства

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

raise_if_unsupported

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

Выбросить ошибку на платформах, где этот ресурс не поддерживается.

Новое в Chef Infra Client 15.5

Общие функциональные возможности ресурсов

Ресурсы 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.

Примеры

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

Установить пакеты компиляции:

build_essential

Установить пакеты компиляции во время фазы компиляции:

build_essential 'Install compilation tools' do
  compile_time true
end

Обновить пакеты компиляции на системах macOS:

build_essential 'Install compilation tools' do
  action :upgrade
end

Ресурс cab_package

Используйте ресурс cab_package для установки или удаления пакетов Microsoft Windows cabinet (.cab).

Новое в Chef Infra Client 12.15.

Синтаксис

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

cab_package 'name' do
  options           String, Array
  package_name      String
  source            String # default value: The package name.
  timeout           String, Integer
  version           String
  action            Symbol # defaults to :install if not specified
end

где:

• cab_package — это ресурс.
• name — имя, заданное для блока ресурса.
• action определяет шаги, которые клиент Chef Infra Client предпримет, чтобы привести узел в желаемое состояние.
• options, package_name, source, timeout и version — доступные свойства этого ресурса.

Действия

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

:install

Устанавливает пакет cabinet.

:nothing

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

:remove

Удаляет пакет cabinet.

Свойства

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

options

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

Дополнительные параметры команды, которые передаются команде.

package_name

Тип Ruby: Строка

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

source

Тип Ruby: Строка | Значение по умолчанию: The package name.

Локальный путь к файлу или URL-адрес пакета CAB.

timeout

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

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

version

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

Примеры

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

Использование локального пути в источнике

cab_package 'Install .NET 3.5 sp1 via KB958488' do
  source 'C:\Users\xyz\AppData\Local\Temp\Windows6.1-KB958488-x64.cab'
  action :install
end

cab_package 'Remove .NET 3.5 sp1 via KB958488' do
  source 'C:\Users\xyz\AppData\Local\Temp\Windows6.1-KB958488-x64.cab'
  action :remove
end

Использование URL-адреса в источнике

cab_package 'Install .NET 3.5 sp1 via KB958488' do
  source 'https://s3.amazonaws.com/my_bucket/Windows6.1-KB958488-x64.cab'
  action :install
end

cab_package 'Remove .NET 3.5 sp1 via KB958488' do
  source 'https://s3.amazonaws.com/my_bucket/Temp\Windows6.1-KB958488-x64.cab'
  action :remove
end

ресурс chef_acl

Используйте ресурс chef_acl для взаимодействия со списками управления доступом (ACL), которые существуют на сервере Chef Infra.

Синтаксис

Синтаксис использования ресурса chef_acl в рецепте следующий:

chef_acl 'name' do
  attribute 'value' # see properties section below
  ...
  action :action # see actions section below
end

где:

• chef_acl сообщает Chef Infra Client использовать поставщика Chef::Provider::ChefAcl во время выполнения Chef Infra Client
• name — имя блока ресурса; когда свойство path не указано в рецепте, name также является именем Chef Infra Client.
• attribute — ноль или более свойств, доступных для данного ресурса
• action определяет действия, которые Chef Infra Client предпримет для приведения узла в желаемое состояние

Действия

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

:create

По умолчанию.

:nothing

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

Свойства

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

chef_server

URL сервера Chef Infra.

complete

Указывает, определяет ли этот ресурс полностью chef-клиент. При значении true любые свойства, не указанные в этом ресурсе, будут сброшены до значений свойств по умолчанию.

ignore_failure

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

Продолжать выполнение рецепта, если ресурс завершается ошибкой по любой причине.

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

path

Путь к каталогу в chef-repo, к которому применяется ACL. Например: nodes, nodes/*, nodes/my_node, */*, **, roles/base, data/secrets, cookbooks/apache2, /users/* и так далее.

raw_json

Chef Infra Client в формате JSON. Например:

{
  "clientname": "client_name",
  "orgname": "org_name",
  "validator": false,
  "certificate": "-----BEGIN CERTIFICATE-----\n
                  ...
                  1234567890abcdefghijklmnopq\n
                  ...
                  -----END CERTIFICATE-----\n",
  "name": "node_name"
}

recursive

Используется для применения изменений к дочерним объектам. Используйте :on_change для применения изменений к дочерним объектам только в том случае, если меняется родительский объект. Установите в true, чтобы применять изменения даже если родительский объект не изменяется. Установите в false, чтобы предотвратить любые изменения. Значение по умолчанию: :on_change.

remove_rights

Используется для удаления прав. Например:

remove_rights :read, :users => 'jkeiser', :groups => [ 'admins', 'users' ]

или:

remove_rights [ :create, :read ], :users => [ 'jkeiser', 'adam' ]

или:

remove_rights :all, :users => [ 'jkeiser', 'adam' ]

rights

Используется для добавления прав. Синтаксис: :right, :right => 'user', :groups => [ 'group', 'group']. Например:

rights :read, :users => 'jkeiser', :groups => [ 'admins', 'users' ]

или:

rights [ :create, :read ], :users => [ 'jkeiser', 'adam' ]

или:

rights :all, :users => 'jkeiser'

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_client

Используйте ресурс chef_client для создания клиентов на вашем сервере Chef Infra внутри кода кулинарии Chef Infra.

Синтаксис

Синтаксис использования ресурса chef_client в рецепте:

chef_client 'name' do
  attribute 'value' # see properties section below
  ...
  action :action # see actions section below
end

где:

• chef_client сообщает Chef Infra Client использовать поставщик Chef::Provider::ChefClient во время выполнения Chef Infra Client
• name — имя блока ресурса; когда свойство name не указано в рецепте, name также является именем Chef Infra Client
• attribute — ноль (или более) свойств, доступных для этого ресурса
• action определяет, какие шаги Chef Infra Client предпримет, чтобы привести узел в желаемое состояние

Действия

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

:create

По умолчанию. Используется для создания chef-клиента.

:delete

Используется для удаления chef-клиента.

:nothing

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

:regenerate_keys

Используется для перегенерации открытого ключа RSA для chef-клиента.

Свойства

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

admin

Указывает, является ли Chef Infra Client клиентом API.

chef_server

URL сервера Chef Infra.

complete

Указывает, определяет ли этот ресурс chef-клиента полностью. Когда true, любые свойства, не указанные в этом ресурсе, будут сброшены до значений по умолчанию.

ignore_failure

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

Продолжить выполнение рецепта, если ресурс завершился сбоем по любой причине.

name

Имя 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

output_key_format

Указывает формат открытого ключа. Возможные значения: pem, der или openssh. Значение по умолчанию: openssh.

output_key_path

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

raw_json

Данные Chef Infra Client в формате JSON. Например:

{
  "clientname": "client_name",
  "orgname": "org_name",
  "validator": false,
  "certificate": "-----BEGIN CERTIFICATE-----\n
                  ...
                  1234567890abcdefghijklmnopq\n
                  ...
                  -----END CERTIFICATE-----\n",
  "name": "node_name"
}

source_key

Копирует открытый или закрытый ключ, но применяет разные format и password. Используется совместно с source_key_pass_phrase и source_key_path.

source_key_pass_phrase

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

source_key_path

Путь к открытому ключу. Используется совместно с source_key и source_key_pass_phrase.

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

validator

Указывает, является ли Chef Infra Client chef-валидатором.

Примеры

У этого ресурса нет примеров.

Ресурс chef_client_config

Используйте ресурс chef_client_config для создания файла client.rb в каталоге конфигурации Chef Infra Client. Смотрите документацию по файлу client.rb для получения более подробной информации об опциях, доступных в файле конфигурации client.rb.

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

Синтаксис

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

chef_client_config 'name' do
  additional_config              String
  chef_license                   String
  chef_server_url                String
  config_directory               String
  data_collector_server_url      String
  data_collector_token           String
  event_loggers                  Array # default value: []
  exception_handlers             Array # default value: []
  file_backup_path               String
  file_cache_path                String
  file_staging_uses_destdir      String
  formatters                     Array # default value: []
  ftp_proxy                      String
  group                          String
  http_proxy                     String
  https_proxy                    String
  log_level                      Symbol
  log_location                   String, Symbol
  minimal_ohai                   true, false
  named_run_list                 String
  no_proxy                       String, Array # default value: []
  node_name                      String
  ohai_disabled_plugins          Array # default value: []
  ohai_optional_plugins          Array # default value: []
  pid_file                       String
  policy_group                   String
  policy_name                    String
  policy_persist_run_list        true, false
  report_handlers                Array # default value: []
  ssl_verify_mode                Symbol, String
  start_handlers                 Array # default value: []
  user                           String
  action                         Symbol # defaults to :create if not specified
end

где:

• chef_client_config — ресурс.
• name — имя блока ресурса.
• action определяет, какие шаги Chef Infra Client предпримет, чтобы привести узел в желаемое состояние.
• additional_config, chef_license, chef_server_url, config_directory, data_collector_server_url, data_collector_token, event_loggers, exception_handlers, file_backup_path, file_cache_path, file_staging_uses_destdir, formatters, ftp_proxy, group, http_proxy, https_proxy, log_level, log_location, minimal_ohai, named_run_list, no_proxy, node_name, ohai_disabled_plugins, ohai_optional_plugins, pid_file, policy_group, policy_name, policy_persist_run_list, report_handlers, ssl_verify_mode, start_handlers и user — доступные для этого ресурса свойства.

Действия

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

:create

Создать конфигурационный файл client.rb для настройки Chef Infra Client. (по умолчанию)

:nothing

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

:remove

Удалить конфигурационный файл client.rb для настройки Chef Infra Client.

Свойства

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

additional_config

Тип Ruby: Строка

Дополнительный текст, добавляемый в конец файла client.rb. Его можно использовать для выполнения пользовательского Ruby-кода или добавления менее распространённых конфигурационных опций

chef_license

Тип Ruby: Строка Разрешенные значения: "accept", "accept-no-persist", "accept-silent"

Принять Лицензионное соглашение Chef

chef_server_url

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

URL сервера Chef Infra.

config_directory

Тип Ruby: Строка | Значение по умолчанию: `/etc/chef/` on *nix-like systems and `C:\chef\` on Windows

Директория для хранения файла client.rb.

data_collector_server_url

Тип Ruby: Строка

URL сборщика данных (обычно automate) для отправки данных о узлах, слиянии и соответствии.

Примечание

По возможности используйте Chef Infra Server для всех отчетов о сборе данных, так как это устраняет необходимость распределять токены отдельным узлам.

Новая функция в Chef Infra Client 17.8

data_collector_token

Тип Ruby: Строка

Токен сборщика данных для взаимодействия с сервером сборки данных (Automate).

Примечание

По возможности используйте Chef Infra Server для всех отчетов о сборе данных, так как это устраняет необходимость распределять токены отдельным узлам.

Новая функция в Chef Infra Client 17.8

event_loggers

Тип Ruby: Массив | Значение по умолчанию: []

exception_handlers

Тип Ruby: Массив | Значение по умолчанию: []

Массив хэшей, содержащих класс обработчика исключений и аргументы, передаваемые этому классу при инициализации. Хэш должен содержать ключи class и argument, где class — строка, а argument — массив строковых значений в кавычках. Например: [{'class' => 'MyHandler', %w('"argument1"', '"argument2"')}]

file_backup_path

Тип Ruby: Строка

Местоположение, в котором хранятся резервные файлы. Если это значение пустое, резервные файлы хранятся в каталоге целевого файла.

file_cache_path

Тип Ruby: Строка

Местоположение, в котором хранятся кулинарии (и другие временные данные) файлы при синхронизации. Это значение также можно использовать в рецептах для загрузки файлов с помощью ресурса remote_file.

file_staging_uses_destdir

Тип Ruby: Строка

Как происходит размещение файлов (через временные файлы). Когда true, временные файлы создаются в каталоге, в котором будут находиться файлы. Когда false, временные файлы создаются в ENV['TMP']

formatters

Тип Ruby: Массив | Значение по умолчанию: []

Форматтеры логирования клиента для загрузки.

ftp_proxy

Тип Ruby: Строка

Прокси-сервер для FTP-соединений.

group

Тип Ruby: Строка

Группа, которой должен принадлежать файл client.rb и каталог конфигурации, если его нужно создать.

Примечание

Каталог конфигурации не будет создан, если он уже существует, что позволяет вам дополнительно контролировать настройку этого каталога вне этого ресурса.

http_proxy

Тип Ruby: Строка

Прокси-сервер для HTTP-соединений.

https_proxy

Тип Ruby: Строка

Прокси-сервер для HTTPS-соединений.

log_level

Тип Ruby: Символ Разрешенные значения: :auto, :debug, :fatal, :info, :trace, :warn

Уровень ведения журнала, выполняемый Chef Infra Client.

log_location

Тип Ruby: Строка, Символ

Место сохранения журналов. Это может быть путь к файлу журнала на диске :syslog для записи в Syslog, :win_evt для записи в журнал событий Windows или 'STDERR'/'STDOUT' для записи в текстовые потоки *nix.

minimal_ohai

Тип Ruby: true, false

Запуск минимального набора плагинов Ohai, предоставляющих данные, необходимые для выполнения встроенных ресурсов Chef Infra Client. Установка этого значения в true пропустит многие большие и длительные наборы данных, такие как cloud или packages. Установка этого значения в true может нарушить кулинарии, которые предполагают, что все данные Ohai будут присутствовать.

named_run_list

Тип Ruby: Строка

Конкретный именованный список выполнения, определённый в применённом Policyfile узла, который должен использоваться при запуске Chef Infra Client.

no_proxy

Тип Ruby: Строка, Массив | Значение по умолчанию: []

Список URL через запятую или массив URL, для которых прокси не требуется.

node_name

Тип Ruby: Строка | Значение по умолчанию: The `node.name` value reported by Chef Infra Client.

Имя узла. Эта конфигурация устанавливает значение node.name, используемое в кулинариях, и значение client_name, используемое при аутентификации на сервере Chef Infra для определения применяемой конфигурации.

Примечание

По умолчанию эта конфигурация использует значение node.name, которое устанавливается во время начальной настройки. Задание этого значения в конфигурации client.rb без логики на сервере Chef Infra, выполняющей DNS-поиск, и может привести к сбою в случае сбоя DNS. Чтобы пропустить это значение по умолчанию и использовать вместо этого встроенную логику сервера Chef Infra, установите это свойство в nil

ohai_disabled_plugins

Тип Ruby: Массив | Значение по умолчанию: []

Плагины Ohai, которые должны быть отключены для ускорения выполнения Chef Infra Client и уменьшения размера данных узла, отправленных в Chef Infra Client.

ohai_optional_plugins

Тип Ruby: Массив | Значение по умолчанию: []

Необязательные плагины Ohai, которые должны быть включены для предоставления дополнительных данных Ohai для использования в кулинариях.

pid_file

Тип Ruby: Строка

Место, в котором сохраняется идентификатор процесса (pid). Исполняемый файл, при запуске в качестве демона, записывает pid в указанный файл.

policy_group

Тип Ruby: Строка

Имя policy group, который существует на сервере Chef Infra. policy_name также должно быть указано при установке этого свойства.

policy_name

Тип Ruby: Строка

Имя политики, как указано в настройке name в файле Policyfile.rb. policy_group при установке этого свойства.

policy_persist_run_list

Тип Ruby: true, false

Переопределить списки выполнения, определённые в Policyfile, списками выполнения, определёнными на сервере Chef Infra.

Новая функция в Chef Infra Client 17.3

report_handlers

Тип Ruby: Массив | Значение по умолчанию: []

Массив хэшей, содержащих класс обработчика отчётов и аргументы, передаваемые этому классу при инициализации. Хэш должен содержать ключи class и argument, где class — строка, а argument — массив строковых значений в кавычках. Например: [{'class' => 'MyHandler', %w('"argument1"', '"argument2"')}]

ssl_verify_mode

Тип Ruby: Символ, Строка Разрешенные значения: :verify_none, :verify_peer

Установить режим проверки для HTTPS-запросов.

• Используйте :verify_none для отключения проверки SSL-сертификатов.
• Используйте :verify_peer для проверки всех SSL-сертификатов, включая подключения к серверу Chef Infra, подключения к S3 и любые URL-адреса HTTPS remote_file, используемые в Chef Infra Client.

start_handlers

Тип Ruby: Массив | Значение по умолчанию: []

Массив хэшей, содержащих класс обработчика отчётов и аргументы, передаваемые этому классу при инициализации. Хэш должен содержать ключи class и argument, где class — строка, а argument — массив строковых значений в кавычках. Например: [{'class' => 'MyHandler', %w('"argument1"', '"argument2"')}]

user

Тип Ruby: Строка

Пользователь, которому должен принадлежать файл client.rb и каталог конфигурации, если его нужно создать.

Примечание

Каталог конфигурации не будет создан, если он уже существует, что позволяет вам дополнительно контролировать настройку этого каталога вне этого ресурса.

Общие функциональные возможности ресурсов

Ресурсы 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.

Примеры

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

Минимальная конфигурация клиента Chef Infra Client client.rb:

Абсолютно минимальная конфигурация, необходимая для связи узла с сервером Chef Infra Server, — это URL-адрес сервера Chef Infra Server. Все остальные параметры конфигурации либо имеют значения на стороне сервера (файлы политики, роли, среды и т. д.), либо имеют значения по умолчанию, определяемые при запуске клиента.

chef_client_config 'Create client.rb' do
  chef_server_url 'https://chef.example.dmz'
end

Более сложная конфигурация клиента Chef Infra Client client.rb:

chef_client_config 'Create client.rb' do
  chef_server_url 'https://chef.example.dmz'
  log_level :info
  log_location :syslog
  http_proxy 'proxy.example.dmz'
  https_proxy 'proxy.example.dmz'
  no_proxy %w(internal.example.dmz)
end

Добавление дополнительного конфигурационного содержимого в client.rb:

Этот ресурс предназначен для предоставления общих параметров конфигурации. Некоторые параметры конфигурации отсутствуют, и некоторые пользователи могут захотеть использовать произвольный код Ruby в своей конфигурации. Для этого мы предлагаем свойство additional_config, которое можно использовать для добавления любой конфигурации или кода в конец файла client.rb. Также следует помнить, что в каталоге конфигурации находится каталог client.d, где вы можете поместить дополнительные файлы конфигурации .rb. Их можно создать с помощью ресурсов file или template в ваших кулинарных книгах по мере необходимости.

chef_client_config 'Create client.rb' do
  chef_server_url 'https://chef.example.dmz'
  additional_config <<~CONFIG
    # Extra config code to safely load a gem into the client run.
    # Since the config is Ruby you can run any Ruby code you want via the client.rb.
    # It's a great way to break things, so be careful
    begin
      require 'aws-sdk'
    rescue LoadError
      Chef::Log.warn "Failed to load aws-sdk."
    end
  CONFIG
end

Настройка двух обработчиков отчетов в client.rb:

chef_client_config 'Create client.rb' do
  chef_server_url 'https://chef.example.dmz'
  report_handlers [
    {
     'class' => 'ReportHandler1Class',
     'arguments' => ["'FirstArgument'", "'SecondArgument'"],
    },
    {
     'class' => 'ReportHandler2Class',
     'arguments' => ["'FirstArgument'", "'SecondArgument'"],
    },
  ]
end

Отчет напрямую в конечную точку сбора данных Chef Automate:

chef_client_config 'Create client.rb' do
  chef_server_url 'https://chef.example.dmz'
  data_collector_server_url 'https://automate.example.dmz'
  data_collector_token 'TEST_TOKEN_TEST'
end

Ресурс chef_client_cron

Используйте ресурс chef_client_cron для настройки запуска Chef Infra Client в качестве задачи cron. Этот ресурс также создаст указанный каталог журналов, если он еще не существует.

Новое в Chef Infra Client 16.0.

Синтаксис

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

chef_client_cron 'name' do
  accept_chef_license      true, false # default value: false
  append_log_file          true, false # default value: true
  chef_binary_path         String # default value: "/opt/chef/bin/chef-client"
  comment                  String
  config_directory         String # default value: "/etc/chef"
  daemon_options           Array # default value: []
  day                      Integer, String # default value: "*"
  environment              Hash # default value: {}
  hour                     Integer, String # default value: "*"
  job_name                 String # default value: "chef-client"
  log_directory            String
  log_file_name            String # default value: "client.log"
  mailto                   String
  minute                   Integer, String # default value: "0,30"
  month                    Integer, String # default value: "*"
  nice                     Integer, String
  splay                    Integer, String # default value: 300
  user                     String # default value: "root"
  weekday                  Integer, String # default value: "*"
  action                   Symbol # defaults to :add if not specified
end

где:

• chef_client_cron — это ресурс.
• name — имя блока ресурса.
• action определяет шаги, которые Chef Infra Client предпримет для приведения узла в нужное состояние.
• accept_chef_license, append_log_file, chef_binary_path, comment, config_directory, daemon_options, day, environment, hour, job_name, log_directory, log_file_name, mailto, minute, month, nice, splay, user и weekday — доступные свойства этого ресурса.

Действия

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

:add

Добавить задачу cron для запуска Chef Infra Client. (по умолчанию)

:nothing

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

:remove

Удалить задачу cron для Chef Infra Client.

Свойства

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

accept_chef_license

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

Принять соглашение о лицензии и услугах Master Online Chef. См. https://www.chef.io/online-master-agreement

append_log_file

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

Добавить в файл журнала вместо перезаписи файла журнала при каждом запуске.

chef_binary_path

Тип в Ruby: Строка | Значение по умолчанию: /opt/chef/bin/chef-client

Путь к исполняемому файлу chef-client.

comment

Тип Ruby: Строка

Комментарий для размещения в файле cron.d.

config_directory

Тип Ruby: Строка | Значение по умолчанию: /etc/chef

Путь к каталогу конфигурации.

daemon_options

Тип Ruby: Массив | Значение по умолчанию: []

Массив опций для передачи команде chef-client.

day

Тип Ruby: Целое число, Строка | Значение по умолчанию: *

День месяца, в который должен запускаться Chef Infra Client (1–31) или шаблон cron, например, '1,7,14,21,28'.

environment

Тип Ruby: Словарь | Значение по умолчанию: {}

Словарь, содержащий дополнительные произвольные переменные среды, в которых будет выполняться задача cron в формате ({'ENV_VARIABLE' => 'VALUE'}).

hour

Тип Ruby: Целое число, Строка | Значение по умолчанию: *

Час, в который должен запускаться Chef Infra Client (0–23) или шаблон cron, например, '0,12'.

job_name

Тип Ruby: Строка | Значение по умолчанию: chef-client

Имя задачи cron для создания.

log_directory

Тип Ruby: Строка | Значение по умолчанию: /Library/Logs/Chef on macOS and /var/log/chef otherwise

Путь к каталогу для создания файла журнала.

log_file_name

Тип Ruby: Строка | Значение по умолчанию: client.log

Имя используемого файла журнала.

mailto

Тип Ruby: Строка

Адрес электронной почты для получения уведомлений о сбоях задач cron.

minute

Тип Ruby: Целое число, Строка | Значение по умолчанию: 0,30

Минута, в которую должен запускаться Chef Infra Client (0–59) или шаблон cron, например, '0,30'.

month

Тип Ruby: Целое число, Строка | Значение по умолчанию: *

Месяц в году, в который должен запускаться Chef Infra Client (1–12, январь-декабрь или *).

nice

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

Приоритет процесса для запуска процесса chef-client. Значение -20 — наивысший приоритет, 19 — наименьший.

Новое в Chef Infra Client 16.5

splay

Тип Ruby: Целое число, Строка | Значение по умолчанию: 300

Случайное количество секунд между 0 и X для добавления к интервалу, чтобы все команды chef-client не выполнялись одновременно.

user

Тип Ruby: Строка | Значение по умолчанию: root

Имя пользователя, от имени которого запускается Chef Infra Client.

weekday

Тип Ruby: Целое число, Строка | Значение по умолчанию: *

День недели, в который должен запускаться Chef Infra Client (0-7, пн-вс или *), где воскресенье — это 0 и 7.

Функциональность общего ресурса

Ресурсы 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.