rhsm_register Ресурс

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

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

Используйте ресурс rhsm_register для регистрации узла в Red Hat Subscription Manager или локальном сервере Red Hat Satellite.

Новое в Chef Infra Client 14.0.

Синтаксис

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

rhsm_register 'name' do
  activation_key             String, Array
  auto_attach                true, false # default value: false
  environment                String
  force                      true, false # default value: false
  https_for_ca_consumer      true, false # default value: false
  install_katello_agent      true, false # default value: true
  organization               String
  password                   String
  satellite_host             String
  system_name                String
  username                   String
  action                     Symbol # defaults to :register if not specified
end

где:

• rhsm_register — это ресурс.
• name — имя блока ресурса.
• action определяет, какие действия Chef Infra Client выполнит для перевода узла в нужное состояние.
• activation_key, auto_attach, environment, force, https_for_ca_consumer, install_katello_agent, organization, password, satellite_host, и username — это доступные для этого ресурса свойства.

Действия

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

:nothing

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

:register

По умолчанию. Регистрирует узел в RHSM.

:unregister

Удаляет регистрацию узла из RHSM.

Свойства

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

activation_key

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

Строка или массив ключей активации для использования при регистрации; при использовании этого свойства также необходимо указать свойство «organization».

auto_attach

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

Если true, RHSM попытается автоматически подключить хост к соответствующим подпискам. В целом лучше использовать ключ активации с предварительно определенными подписками.

environment

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

Окружение для использования при регистрации; требуется при использовании свойств username и password.

force

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

Если true, система будет зарегистрирована, даже если она уже зарегистрирована. Обычно любые операции регистрации завершаются ошибкой, если машина уже зарегистрирована.

https_for_ca_consumer

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

Если true, Chef Infra Client загрузит katello-ca-consumer-latest.noarch.rpm с satellite_host с использованием HTTPS.

Новое в Chef Infra Client 15.9

install_katello_agent

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

Если true, будет установлен RPM «katello-agent».

organization

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

Организация для использования при регистрации; требуется при использовании свойства ‘activation_key’.

password

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

Пароль для использования при регистрации. Это свойство не применимо при использовании ключа активации. Если указано, также требуются username и environment.

satellite_host

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

FQDN хоста Satellite для регистрации. Если это свойство не указано, хост будет зарегистрирован в публичной службе RHSM Red Hat.

system_name

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

Имя системы для регистрации, по умолчанию — имя хоста.

Новое в Chef Infra Client 16.5

username

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

Имя пользователя для использования при регистрации. Это свойство не применимо при использовании ключа активации. Если указано, также требуются свойства password и environment.

Общие функции ресурсов

Ресурсы 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[String]'

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

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

Блокировки

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

• Строка выполняется как командная строка. Если команда возвращает 0, то блокировка применяется. Если команда возвращает любое другое значение, то свойство guard не применяется. Строковые блокировки в powershell_script выполняют команды Windows PowerShell и могут возвращать true в дополнение к 0.
• Блок выполняется как код Ruby, который должен возвращать либо true либо false. Если блок возвращает true, то свойство guard применяется. Если блок возвращает false, то свойство guard не применяется.

Свойство guard полезно для обеспечения идемпотентности ресурса, позволяя ему проверять желаемое состояние по мере выполнения, и если желаемое состояние присутствует, Chef Infra Client ничего не делает.

Следующие свойства могут быть использованы для определения guard, оцениваемого во время фазы выполнения Chef Infra Client:

not_if

Предотвращает выполнение ресурса, когда условие возвращает true.

only_if

Разрешает выполнение ресурса только если условие возвращает true.

Примеры

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

Регистрация узла с RHSM

rhsm_register 'myhost' do
  activation_key 'ABCD1234'
  organization 'my_org'
end