chef_group Resource — Chef 16

Эта страница сгенерирована из исходного кода Chef. Чтобы предложить изменение, отредактируйте файл chef_group.rb и отправьте запрос на вытягивание в репозиторий Chef.

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

Используйте ресурс chef_group для взаимодействия с объектами групп, которые существуют на сервере Chef.

Синтаксис

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

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

где:

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

Действия

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

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

Свойства

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

chef_server: URL сервера Chef.

clients: &mldr;

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

groups: &mldr;

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

raw_json

Группа в формате JSON. Например:

{
  :groupname => "chef"
}

remove_clients: &mldr;

remove_groups: &mldr;

remove_users: &mldr;

retries: Тип Ruby: Целое число | Значение по умолчанию: 0
Количество попыток перехватить исключения и повторить ресурс.

retry_delay: Тип Ruby: Целое число | Значение по умолчанию: 2
Задержка повтора (в секундах).

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 вызовет ошибку, если другой ресурс не существует.

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

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

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

users: &mldr;

Примеры

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

Ресурс chef_group

Синтаксис

Действия

Свойства

Примеры