chef_user Resource — Chef 17

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

Все страницы ресурсов Infra

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

Синтаксис

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

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

где:

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

Действия

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

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

Свойства

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

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

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

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

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

external_authentication_uid: &mldr;

ignore_failure: Тип Ruby: true, false | Значение по умолчанию: false
Продолжать выполнение рецепта, если ресурс завершится ошибкой по любой причине.

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

notifies

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

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

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

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

:before: Указывает, что действие над уведомленным ресурсом должно быть выполнено до обработки блока ресурса, в котором находится уведомление.
:delayed: По умолчанию. Указывает, что уведомление должно быть помещено в очередь и выполнено в конце выполнения клиента Chef Infra.
: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: &mldr;

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

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

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

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

Примеры

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

Ресурс chef_user

Синтаксис

Действия

Свойства

Примеры