Группа Ресурс

Редактировать эту страницу в репозитории Chef

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

Используйте ресурс group для управления локальной группой.

Синтаксис

Ресурс group имеет следующий синтаксис:

group 'name' do
  append                true, false # default value: false
  comment               String
  excluded_members      String, Array
  gid                   String, Integer
  group_name            String # default value: 'name' unless specified
  members               String, Array
  non_unique            true, false # default value: false
  system                true, false # default value: false
  action                Symbol # defaults to :create if not specified
end

где:

• group является ресурсом.
• name — имя, заданное для блока ресурса.
• action определяет действия, которые Chef Infra Client предпримет для приведения узла в желаемое состояние.
• append, comment, excluded_members, gid, group_name, members, non_unique, и system — доступные свойства для этого ресурса.

Действия

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

:create

По умолчанию. Создать группу. Если группа уже существует (но не соответствует), обновить эту группу для соответствия.

:manage

Управлять существующей группой. Это действие ничего не делает, если группа не существует.

:modify

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

:nothing

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

:remove

Удалить группу.

Свойства

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

append

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

Как члены должны добавляться и/или удаляться из группы. При true, members добавляются, а excluded_members удаляются. При false, члены группы сбрасываются до значения свойства members.

comment

Тип Ruby: Строка

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

Новое в Chef Client 14.9

excluded_members

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

Удалить пользователей из группы. Может быть использовано только при append установлено в true.

gid

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

Идентификатор группы.

group_name

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

Имя группы. Значение по умолчанию: имя name блока ресурса. См. раздел «Синтаксис» выше для получения дополнительной информации.

members

Тип Ruby: Массив

Пользователи, которые должны быть установлены или добавлены в группу. Если определено несколько членов группы, список членов должен быть массивом: members ['user1', 'user2'].

non_unique

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

Разрешить дублирование gid. Может быть использовано только с провайдером Groupadd.

system

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

Установить, если группа принадлежит системной группе. Установить в true если группа принадлежит системной группе.

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

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

Примеры

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

Добавление пользователей в группы

group 'www-data' do
  action :modify
  members 'maintenance'
  append true
end

Добавление пользователя в группу на платформе Windows

group 'Administrators' do
  members ['domain\foo']
  append true
  action :modify
end