Ресурс kernel_module

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

Страница всех ресурсов Infra

Используйте ресурс kernel_module для управления модулями ядра на системах Linux. Этот ресурс может загружать, разгружать, добавлять в чёрный список, отключать, включать, устанавливать и удалять модули.

Впервые в Chef Infra Client 14.3.

Синтаксис

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

kernel_module 'name' do
  load_dir        String # default value: "/etc/modules-load.d"
  modname         String # default value: 'name' unless specified
  options         Array
  unload_dir      String # default value: "/etc/modprobe.d"
  action          Symbol # defaults to :install if not specified
end

где:

• kernel_module — это ресурс.
• name — это имя, заданное для блока ресурса.
• action определяет действия, которые Chef Infra Client предпримет для приведения узла в желаемое состояние.
• load_dir, modname, options, и unload_dir — это свойства, доступные для данного ресурса.

Действия

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

:blacklist

Добавить модуль ядра в чёрный список.

:disable

Отключить модуль ядра. Впервые в Chef Infra Client 15.2.

:enable

Включить модуль ядра. Обратное действие :disable

:install

Загрузить модуль ядра и гарантировать его загрузку при перезагрузке. (по умолчанию)

:load

Загрузить модуль ядра.

:nothing

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

:uninstall

Разгрузить модуль ядра и удалить конфигурацию модуля, чтобы он не загружался при перезагрузке.

:unload

Разгрузить модуль ядра.

Свойства

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

load_dir

Тип Ruby: Строка | Значение по умолчанию: /etc/modules-load.d

Директория для загрузки модулей.

modname

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

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

options

Тип Ruby: Массив

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

Впервые в Chef Infra Client 15.4

unload_dir

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

Директория modprobe.d.

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

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

Примеры

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

Установка и загрузка модуля ядра, и обеспечение его загрузки при перезагрузке.

kernel_module 'loop'

Установка и загрузка ядра с набором специфических параметров и обеспечение его загрузки при перезагрузке. Обратитесь к документации модулей ядра для получения информации о поддерживаемых параметрах.

kernel_module 'loop' do
  options [
    'max_loop=4',
    'max_part=8',
  ]
end

Загрузка модуля ядра.

kernel_module 'loop' do
  action :load
end

Разгрузка модуля ядра и удаление конфигурации модуля, чтобы он не загружался при перезагрузке.

kernel_module 'loop' do
  action :uninstall
end

Разгрузка модуля ядра.

kernel_module 'loop' do
  action :unload
end

Добавление модуля в чёрный список для предотвращения загрузки.

kernel_module 'loop' do
  action :blacklist
end

Отключение модуля ядра, чтобы он не мог быть установлен.

kernel_module 'loop' do
  action :disable
end

Включение модуля ядра, чтобы он мог быть установлен. Не загружает и не устанавливает.

kernel_module 'loop' do
  action :enable
end