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

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

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

Действия

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

: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 Client.

Примеры

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

gem_package 'syntax' do
  action :install
  ignore_failure true
end

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

Ограничения

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

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

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

Свойства

Следующие свойства могут быть использованы для определения ограничения, которое оценивается во время фазы выполнения 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 может быть установлено в любое из следующих значений:

:bash

Оценивает строковую команду с помощью ресурса bash.

:batch

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

:csh

Оценивает строковую команду с помощью ресурса csh.

:default

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

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

Например, утверждение guard 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 к утверждению guard 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 Client:

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

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

Уведомления

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

Подписки

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

Синтаксис для 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'

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

unified_mode true

action :run do
  build_essential 'Install compilers'

  chef_gem 'aws-sdk'

  require 'aws-sdk'
end

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

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

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

Для загрузки и парсинга 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

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

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

rights permission, principal, option_type => value

где

permission

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

Эти разрешения суммируются. Если указано :write, то это включает :read. Если указано :full_control, то это включает как :write, так и :read.

(Для тех, кто знаком с API Microsoft Windows: :read соответствует GENERIC_READ; :write соответствует GENERIC_WRITE; :read_execute соответствует GENERIC_READ и GENERIC_EXECUTE; :modify соответствует GENERIC_WRITE, GENERIC_READ, GENERIC_EXECUTE и DELETE; :full_control соответствует GENERIC_ALL, что позволяет пользователю изменять владельца и другие метаданные файла.)

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 не нужно знать, пользователь это или группа.

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 не очищает права на файл или каталог, если права не указаны.
• Изменение унаследованных прав может быть затратным. 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 применять (или не применять) унаследованные права от родительского каталога.

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

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 установит его по умолчанию как true, что гарантирует, что настройки безопасности существующих файлов останутся неизменными.

Ресурсы

Следующие ресурсы встроены в Клиент Chef:

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

:refresh

:remove

:set

Свойства

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

link

Тип в Ruby: String | Значение по умолчанию: /usr/bin/LINK_NAME

Путь к ссылке alternatives.

link_name

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

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

path

Тип в Ruby: String

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

priority

Тип в Ruby: String, Integer

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

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

Ресурсы 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: Integer | Значение по умолчанию: 0

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

retry_delay

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

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

sensitive

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

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

Уведомления

notifies

Тип в Ruby: Symbol, '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: Symbol, '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.

Примеры

Следующие примеры демонстрируют различные подходы к использованию ресурса 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_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
  timeout                      String, Integer
  version                      String, Array
  action                       Symbol # defaults to :install if not specified
end

где:

• apt_package — это ресурс.
• name — это имя, присвоенное блоку ресурса.
• action определяет шаги, которые Chef Infra Client предпримет для приведения узла в нужное состояние.
• 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 InfraClient.

Уведомления

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 %(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 InfraClient.

Уведомления

notifies

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

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

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

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

:before

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

:delayed

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

:immediate, :immediately

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

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

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

subscribes

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

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

Обратите внимание, что subscribes не применяет указанное действие к ресурсу, который он прослушивает — например:

file '/etc/nginx/ssl/example.crt' do
  mode '0600'
  owner 'root'
end

service 'nginx' do
  subscribes :reload, 'file[/etc/nginx/ssl/example.crt]', :immediately
end

В этом случае свойство subscribes перезагружает службу nginx всякий раз, когда файл сертификата, расположенный по адресу /etc/nginx/ssl/example.crt, обновляется. subscribes не вносит никаких изменений в сам файл сертификата, а только отслеживает изменения в файле и выполняет действие :reload для своего ресурса (в данном примере nginx) при обнаружении изменений.

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

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

:before

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

:delayed

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

:immediate, :immediately

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

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

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

Блокировки

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

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

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

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

not_if

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

only_if

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

Примеры

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

Уведомления

notifies

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

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

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

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

:before

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

:delayed

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

:immediate, :immediately

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

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

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

subscribes

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

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

Обратите внимание, что subscribes не применяет указанное действие к ресурсу, за которым он прослеживает, например:

file '/etc/nginx/ssl/example.crt' do
  mode '0600'
  owner 'root'
end

service 'nginx' do
  subscribes :reload, 'file[/etc/nginx/ssl/example.crt]', :immediately
end

В этом случае свойство subscribes перезагружает службу nginx всякий раз, когда файл сертификата, расположенный в /etc/nginx/ssl/example.crt, обновляется. subscribes не вносит никаких изменений в сам файл сертификата, а только отслеживает изменения в файле и выполняет действие :reload для своего ресурса (в данном примере nginx) при обнаружении изменений.

Если другой ресурс не существует, подписка не вызовет ошибку. Это в отличие от более строгих семантик notifies, которые приведут к ошибке, если другой ресурс не существует.

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

:before

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

:delayed

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

:immediate, :immediately

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

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

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

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

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

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

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

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

not_if

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

only_if

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

Примеры

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

Уведомления

notifies

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

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

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

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

:before

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

:delayed

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

:immediate, :immediately

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

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

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

subscribes

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

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

Обратите внимание, что subscribes не применяет указанное действие к ресурсу, за которым он следит — например:

file '/etc/nginx/ssl/example.crt' do
  mode '0600'
  owner 'root'
end

service 'nginx' do
  subscribes :reload, 'file[/etc/nginx/ssl/example.crt]', :immediately
end

В этом случае свойство subscribes перезагружает службу nginx всякий раз, когда файл сертификата, расположенный по адресу /etc/nginx/ssl/example.crt, обновляется. subscribes не вносит никаких изменений в сам файл сертификата, а просто прослушивает изменения файла и выполняет действие :reload для своего ресурса (в этом примере nginx) при обнаружении изменений.

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

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

:before

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

:delayed

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

:immediate, :immediately

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

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

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

Блокировки

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

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

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

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

not_if

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

only_if

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

Примеры

Следующие примеры демонстрируют различные подходы к использованию ресурса 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
  action           Symbol # defaults to :extract if not specified
end

где:

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

Действия

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

:extract

Извлечение и архивирование файла.

:nothing

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

Свойства

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

destination

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

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

group

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

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

mode

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

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

options

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

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

overwrite

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

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

owner

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

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

path

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

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

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

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

Примеры

В следующих примерах демонстрируются различные подходы к использованию ресурса 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 предпримет для перевода узла в желаемое состояние.
• code, creates, cwd, environment, flags, group, path, returns, timeout, user и umask — свойства этого ресурса, со своим типом в Ruby. См. раздел «Свойства» ниже, чтобы узнать больше о всех свойствах, которые можно использовать с этим ресурсом.

Действия

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

:nothing

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

: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 (converge phase).

ignore_failure

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

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

retries

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

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

retry_delay

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

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

sensitive

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

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

Уведомления

notifies

Тип Ruby: Символ, 'Chef::Resource[Строка]'

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

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

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

:before

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

:delayed

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

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

: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.

Примеры

В следующих примерах демонстрируются различные подходы к использованию ресурса 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 с помощью bash. Этот модуль добавляет функциональность в стиле оболочки в конфигурационный файл 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/ в том же кулинарном наборе, что и рецепт, который вызывает файл атрибутов. В этом примере файл атрибутов определяет определённые настройки для 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 будет использована 64-битная версия оболочки cmd.exe для оценки строковых значений свойств not_if и only_if. Установите это значение в :default, чтобы использовать 32-битную версию оболочки cmd.exe.

interpreter

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

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

returns

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

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

timeout

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

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

user

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

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

password

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

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

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 InfraClient.

Уведомления

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

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

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

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

Свойство guard полезно для обеспечения идемпотентности ресурса, позволяя ресурсу проверить желаемое состояние во время выполнения, и, если желаемое состояние присутствует, 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 InfraClient.

Уведомления

notifies

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

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

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

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

:before

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

:delayed

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

:immediate, :immediately

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

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

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

subscribes

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

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

Обратите внимание, что subscribes не применяет указанное действие к ресурсу, за которым следит — например:

file '/etc/nginx/ssl/example.crt' do
  mode '0600'
  owner 'root'
end

service 'nginx' do
  subscribes :reload, 'file[/etc/nginx/ssl/example.crt]', :immediately
end

В этом случае свойство subscribes перезагружает службу nginx всякий раз, когда файл сертификата, расположенный в папке /etc/nginx/ssl/example.crt, обновляется. subscribes не вносит никаких изменений в сам файл сертификата, а только отслеживает изменения в файле и выполняет действие :reload для своего ресурса (в данном примере nginx) при обнаружении изменений.

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

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

:before

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

:delayed

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

:immediate, :immediately

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

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

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

Защиты

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

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

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

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

not_if

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

only_if

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

Примеры

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

: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 Client для проверки функциональности, доступной только при подключении Chef Infra Client к серверу Chef Infra, например, функции поиска или доступа к данным, хранящимся в пакетах данных.

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

chef-shell -z

Управление

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

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

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 с помощью 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-shell позволяет манипулировать текущей позицией в списке выполнения во время работы Chef Infra Client. Добавляйте точки останова в рецепты для использования этой функциональности.

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

Чтобы изучить использование точки останова для ручного пошагового выполнения работы 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.

"Привет, мир"

Этот пример демонстрирует запуск 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 > set[: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')

Примеры

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

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

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 на узлах 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 InfraClient.

Уведомления

notifies

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

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

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

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

:before

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

:delayed

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

:immediate, :immediately

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

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

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

subscribes

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

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

Обратите внимание, что subscribes не применяет указанное действие к ресурсу, за которым он следит — например:

file '/etc/nginx/ssl/example.crt' do
  mode '0600'
  owner 'root'
end

service 'nginx' do
  subscribes :reload, 'file[/etc/nginx/ssl/example.crt]', :immediately
end

В этом случае свойство subscribes перезагружает службу nginx всякий раз, когда обновляется файл сертификата, расположенный по адресу /etc/nginx/ssl/example.crt. subscribes не вносит никаких изменений в сам файл сертификата, а лишь следит за изменениями в файле и выполняет действие :reload для своего ресурса (в данном примере nginx) при обнаружении изменений.

Если другой ресурс не существует, подписка не вызовет ошибку. Противопоставьте это строгим семантикам notifies, которые вызовут ошибку, если другой ресурс не существует.

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

:before

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

:delayed

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

:immediate, :immediately

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

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

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

Условие

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

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

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

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

not_if

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

only_if

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

Примеры

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

: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 InfraClient.

Уведомления

notifies

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

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

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

retries

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

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

retry_delay

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

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

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 Server.

complete

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

ignore_failure

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

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

name

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

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"
}

retries

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

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

retry_delay

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

Задержка повтора (в секундах).

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\[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

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
  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
  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, 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, report_handlers, ssl_verify_mode, start_handlers и user - доступные для этого ресурса свойства.

Действия

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

:create

:nothing

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

:remove

Свойства

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

additional_config

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

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

chef_license

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

Принять Chef EULA

chef_server_url

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

URL сервера Chef Infra Server.

config_directory

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

Каталог для хранения client.rb.

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.

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-адресов, для которых не требуется прокси.

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 при установке этого свойства.

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 InfraClient.

Уведомления

notifies

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

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

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

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

:before

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

:delayed

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

:immediate, :immediately

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

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

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

subscribes

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

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

Обратите внимание, что subscribes не применяет указанное действие к ресурсу, который он слушает — например:

file '/etc/nginx/ssl/example.crt' do
  mode '0600'
  owner 'root'
end

service 'nginx' do
  subscribes :reload, 'file[/etc/nginx/ssl/example.crt]', :immediately
end

В этом случае свойство subscribes перезагружает службу nginx всякий раз, когда обновляется ее сертификационный файл, расположенный по адресу /etc/nginx/ssl/example.crt. subscribes не вносит никаких изменений в сам сертификационный файл, а лишь следит за изменением файла и выполняет действие :reload для своего ресурса (в данном примере nginx) при обнаружении изменения.

Если другой ресурс не существует, подписка не сгенерирует ошибку. Противопоставьте это более строгой семантике notifies, которая сгенерирует ошибку, если другой ресурс не существует.

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

:before

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

:delayed

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

:immediate, :immediately

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

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

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

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

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

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

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

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

not_if

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

only_if

Позволяет выполнить ресурс только если условие возвращает true.

Примеры

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

Минимальная конфигурация клиента Chef Infra Client client.rb:

Абсолютный минимум конфигурации, необходимый для узла для связи с Infra Server, — это URL-адрес Infra Server. Все остальные параметры конфигурации либо имеют значения на стороне сервера (Policyfiles, Roles, Environments и т. д.), либо имеют значения по умолчанию, определяемые при запуске клиента.

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_client_cron

Используйте ресурс chef_client_cron для настройки запуска клиента Chef Infra в качестве задания 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
  day                      Integer, String # default value: "*"
  environment              Hash
  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 для приведения узла в желаемое состояние.
• 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

:nothing

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

:remove

Удалить задание cron для клиента Chef Infra

Свойства

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

accept_chef_license

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

Принять Лицензионное соглашение и соглашение об услугах Chef Online Master. См. https://www.chef.io/online-master-agreement/

append_log_file

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

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

chef_binary_path

Тип Ruby: String | Значение по умолчанию: /opt/chef/bin/chef-client

Путь к бинарному файлу chef-client.

comment

Тип Ruby: String

Комментарий для размещения в файле cron.d.

config_directory

Тип Ruby: String | Значение по умолчанию: /etc/chef

Путь каталога конфигурации.

daemon_options

Тип Ruby: Array

Массив параметров для передачи в команду chef-client.

day

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

День месяца, в который должен запускаться клиент Chef Infra (1 - 31) или шаблон cron, например, «1,7,14,21,28».

environment

Тип Ruby: Hash

Хэш, содержащий дополнительные произвольные переменные среды, под которыми задание cron будет выполняться в виде ({'ENV_VARIABLE' => 'VALUE'}).

hour

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

Час, в который должен запускаться клиент Chef Infra (0 - 23) или шаблон cron, например, «0,12».

job_name

Тип Ruby: String | Значение по умолчанию: chef-client

Имя создаваемого задания cron.

log_directory

Тип Ruby: String | Значение по умолчанию: /Library/Logs/Chef on macOS and /var/log/chef otherwise

Путь каталога для создания файла журнала.

log_file_name

Тип Ruby: String | Значение по умолчанию: client.log

Имя используемого файла журнала.

mailto

Тип Ruby: String

Адрес электронной почты для отправки уведомлений о сбоях задания cron.

minute

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

Минута, в которую должен запускаться клиент Chef Infra (0 - 59) или шаблон cron, например, «0,30».

month

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

Месяц года, в который должен запускаться клиент Chef Infra (1 - 12, янв-дек или *).

nice

Тип Ruby: Integer, String

Приоритет процесса для запуска процесса chef-client. Значение -20 — наивысший приоритет, а 19 — наименьший приоритет.

Новое в Chef Infra Client 16.5

splay

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

Случайное количество секунд от 0 до X для добавления к интервалу, чтобы все команды chef-client не выполнялись одновременно.

user

Тип Ruby: String | Значение по умолчанию: root

Имя пользователя, от имени которого запускается клиент Chef Infra.

weekday

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

День недели, в который должен запускаться клиент Chef Infra (0-7, пн-вс или *), где воскресенье — это и 0, и 7.

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

Ресурсы 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: Integer | Значение по умолчанию: 0

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

retry_delay

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

Задержка повтора (в секундах).

sensitive

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

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

Уведомления

notifies

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

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

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

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

:before

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

:delayed

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

:immediate, :immediately

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