habitat_install Resource — Chef 17

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

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

Используйте ресурс habitat_install для установки Chef Habitat.

Новое в Chef Infra Client 17.3.

Синтаксис

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

habitat_install 'name' do
  bldr_url         String
  create_user      true, false # default value: true
  hab_version      String
  install_url      String
  license          String
  tmp_dir          String
  action           Symbol # defaults to :install if not specified
end

где:

habitat_install — это ресурс.
name — имя, заданное для блока ресурса.
action определяет действия, которые Chef Infra Client предпримет для перевода узла в желаемое состояние.
bldr_url, create_user, hab_version, install_url, license, и tmp_dir — доступные свойства этого ресурса.

Действия

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

:install: Устанавливает Habitat. Ничего не делает, если бинарник hab найден в стандартном местоположении для системы (/bin/hab на Linux, /usr/local/bin/hab на macOS, C:/habitat/hab.exe на Windows) (по умолчанию)
:nothing: Этот блок ресурса не действует, пока не получит уведомление от другого ресурса для выполнения действия. После уведомления этот блок ресурса либо выполняется немедленно, либо добавляется в очередь для выполнения в конце выполнения Chef Infra Client.

Свойства

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

bldr_url: Тип в Ruby: Строка
Необязательный URL альтернативного Habitat Builder.

create_user: Тип в Ruby: true, false | Значение по умолчанию: true
Создает системного пользователя hab.

hab_version: Тип в Ruby: Строка
Укажите версию Habitat, которую вы хотите установить.

install_url: Тип в Ruby: Строка | Значение по умолчанию: https://raw.githubusercontent.com/habitat-sh/habitat/main/components/hab/install.sh
URL скрипта установки, по умолчанию из репозитория habitat.

license: Тип в Ruby: Строка Допустимые значения: "accept"
Указывает на принятие лицензии habitat, когда установлено значение accept.

tmp_dir: Тип в Ruby: Строка
Устанавливает переменную среды TMPDIR для местоположения временных файлов.

Примечание

Это требуется, если /tmp и /var/tmp смонтированы noexec.

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

Ресурсы 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[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]', действие, которое нужно выполнить, и :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_install в рецептах:

Установка без имени ресурса

habitat_install

Установка с указанием URL Habitat builder

habitat_install 'install habitat' do
  bldr_url 'http://localhost'
end

Установка с указанием версии и URL Habitat builder

habitat_install 'install habitat' do
  bldr_url 'http://localhost'
  hab_version '1.5.50'
end

Ресурс habitat_install