Ресурс ssh_known_hosts_entry

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

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

Используйте ресурс ssh_known_hosts_entry, чтобы добавить запись для указанного хоста в /etc/ssh/ssh_known_hosts или в файле известных хостов пользователя, если он указан.

Новое в Chef Infra Client 14.3.

Синтаксис

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

ssh_known_hosts_entry 'name' do
  file_location      String # default value: "/etc/ssh/ssh_known_hosts"
  group              String, Integer # default value: The root user's group depending on platform.
  hash_entries       true, false # default value: false
  host               String # default value: 'name' unless specified
  key                String
  key_type           String # default value: "rsa"
  mode               String # default value: "0644"
  owner              String, Integer # default value: "root"
  port               Integer # default value: 22
  timeout            Integer # default value: 30
  action             Symbol # defaults to :create if not specified
end

где:

• ssh_known_hosts_entry — это ресурс.
• name — это имя, присвоенное блоку ресурса.
• action определяет, какие действия Chef Infra Client предпримет для приведения узла в нужное состояние.
• file_location, group, hash_entries, host, key, key_type, mode, owner, port, и timeout — это доступные для данного ресурса свойства.

Действия

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

:create

Создать запись в файле ssh_known_hosts. (по умолчанию)

:flush

Немедленно записать записи в конфигурационный файл. Без этого фактическая запись файла откладывается в выполнении Chef Infra Client, чтобы все записи можно было накопить перед записью файла.

:nothing

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

Свойства

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

file_location

Тип Ruby: Строка | Значение по умолчанию: /etc/ssh/ssh_known_hosts

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

group

Тип Ruby: Строка, Целое число | Значение по умолчанию: The root user's group depending on platform.

Группа файла для ssh_known_hosts.

hash_entries

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

Хэшировать имя хоста и адреса в файле ssh_known_hosts для повышения конфиденциальности.

host

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

Хост, который нужно добавить в файл известных хостов.

key

Тип Ruby: Строка

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

key_type

Тип Ruby: Строка | Значение по умолчанию: rsa

Тип ключа для хранения.

mode

Тип Ruby: Строка | Значение по умолчанию: 0644

Режим файла для ssh_known_hosts.

owner

Тип Ruby: Строка, Целое число | Значение по умолчанию: root

Владелец файла ssh_known_hosts.

port

Тип Ruby: Целое число | Значение по умолчанию: 22

Порт сервера, который будет использовать команда ssh-keyscan для получения открытого ключа.

timeout

Тип Ruby: Целое число | Значение по умолчанию: 30

Таймаут в секундах для ssh-keyscan.

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

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

Уведомления

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.

Примеры

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

Добавить одну запись для github.com с автоматически определенным ключом

ssh_known_hosts_entry 'github.com'

Добавить одну запись с предоставленным вами ключом

ssh_known_hosts_entry 'github.com' do
  key 'node.example.com ssh-rsa ...'
end