Ресурс hostname

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

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

Используйте ресурс hostname для установки имени хоста системы, настройки файла конфигурации имени хоста и файла hosts, а также повторного запуска плагина Ohai hostname, чтобы имя хоста было доступно в последующих кулинариях.

Новинка в Chef Infra Client 14.0.

Синтаксис

Полный синтаксис всех доступных свойств ресурса hostname:

hostname 'name' do
  aliases             Array
  compile_time        true, false # default value: true
  hostname            String # default value: 'name' unless specified
  ipaddress           String # default value: The node's IP address as determined by Ohai.
  windows_reboot      true, false # default value: true
  action              Symbol # defaults to :set if not specified
end

где:

• hostname — это ресурс.
• name — это имя, присвоенное блоку ресурса.
• action определяет шаги, которые Chef Infra Client предпримет, чтобы привести узел к желаемому состоянию.
• aliases, compile_time, hostname, ipaddress, и windows_reboot — это доступные свойства этого ресурса.

Действия

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

:nothing

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

:set

Действие по умолчанию. Устанавливает имя хоста узла.

Свойства

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

aliases

Тип Ruby: Массив

Массив псевдонимов имени хоста для использования при настройке файла hosts.

compile_time

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

Определяет, будет ли ресурс выполняться во время компиляции.

hostname

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

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

ipaddress

Тип Ruby: Строка | Значение по умолчанию: The node's IP address as determined by Ohai.

IP-адрес, который следует использовать при настройке файла hosts.

windows_reboot

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

Определяет, нужно ли перезагрузить Windows после изменения имени хоста, так как это необходимо для вступления изменения в силу.

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

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

Примеры

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

Установите имя хоста, используя IP-адрес, обнаруженный Ohai:

hostname 'example'

Вручную укажите имя хоста и IP-адрес:

hostname 'statically_configured_host' do
  hostname 'example'
  ipaddress '198.51.100.2'
end