habitat_config Resource — Chef 17

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

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

Используйте ресурс habitat_config для применения конфигурации к сервису Chef Habitat.

Новое в Chef Infra Client 17.3.

Синтаксис

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

habitat_config 'name' do
  config                  Mash (Hash-like)
  gateway_auth_token      String
  remote_sup              String # default value: "127.0.0.1:9632"
  remote_sup_http         String # default value: "127.0.0.1:9631"
  service_group           String # default value: 'name' unless specified
  user                    String
  action                  Symbol # defaults to :apply if not specified
end

где:

habitat_config — это ресурс.
name — это имя блока ресурса.
action определяет действия, которые Chef Infra Client предпримет для приведения узла в желаемое состояние.
config, gateway_auth_token, remote_sup, remote_sup_http, service_group, и user — это доступные свойства этого ресурса.

Действия

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

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

Свойства

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

config: Тип Ruby: Mash (похоже на Hash) | REQUIRED
Конфигурация для применения в виде ruby хэша, например, { worker_count: 2, http: { keepalive_timeout: 120 } }.

gateway_auth_token: Тип Ruby: Строка
Токен аутентификации для доступа к http-порту удалённого супервизора.

remote_sup: Тип Ruby: Строка | Значение по умолчанию: 127.0.0.1:9632
Адрес контрольного шлюза удалённого супервизора.

remote_sup_http: Тип Ruby: Строка | Значение по умолчанию: 127.0.0.1:9631
Адрес http-порта удалённого супервизора. Используется для получения существующих.

service_group: Тип Ruby: Строка | Значение по умолчанию: The resource block's name
Группа сервисов, к которой применяется конфигурация. Например, nginx.default

user: Тип Ruby: Строка
Имя ключа пользователя для использования в шифровании. Передаёт --user в hab config apply.

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

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

: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.

Примеры

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

Настройка ваших параметров nginx по умолчанию

habitat_config 'nginx.default' do
  config({
    worker_count: 2,
    http: {
      keepalive_timeout: 120
    }
    })
  end

Ресурс habitat_config