Модуль ядра kernel_module

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

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

Используйте ресурс 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 Client 15.2.

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

Защитные механизмы

Свойство защитного механизма может использоваться для оценки состояния узла во время фазы выполнения 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