Ресурс chef_user

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

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

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

Синтаксис

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

chef_user 'value' # see properties section below
  ...
  action :action # see actions section below
end

где:

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

Действия

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

:create

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

:delete

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

:nothing

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

Свойства

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

admin

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

chef_server

URL сервера Chef Infra.

complete

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

email

Электронный адрес пользователя.

external_authentication_uid

…

ignore_failure

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

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

name

Имя пользователя.

notifies

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

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

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

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

:before

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

:delayed

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

:immediate, :immediately

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

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

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

output_key_format

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

output_key_path

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

raw_json

Пользователь в формате JSON. Например:

{
  "name": "Robert Forster"
}

recovery_authentication_enabled

…

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\[Строка\]

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

Примеры

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