route Resource — Chef 16

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

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

Используйте ресурс route для управления таблицей маршрутизации системы в среде Linux.

Синтаксис

Блок ресурса route управляет таблицей маршрутизации системы в среде Linux:

route '10.0.1.10/32' do
  gateway '10.0.0.20'
  device 'eth1'
end

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

route 'name' do
  comment         String
  device          String
  gateway         String
  metric          Integer
  netmask         String
  route_type      Symbol, String # default value: :host
  target          String # default value: 'name' unless specified
  action          Symbol # defaults to :add if not specified
end

где:

route — это ресурс.
name — имя, присвоенное блоку ресурса.
action определяет действия, которые Chef Infra Client выполнит для приведения узла в желаемое состояние.
comment, device, gateway, metric, netmask, route_type, и target — доступные свойства этого ресурса.

Действия

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

:add: По умолчанию. Добавить маршрут.
:delete: Удалить маршрут.
:nothing: Этот блок ресурса не выполняет действий, пока не получит уведомление от другого ресурса. После получения уведомления этот блок ресурса либо выполняется сразу, либо помещается в очередь для выполнения в конце работы Chef Infra Client.

Свойства

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

comment

Тип Ruby: Строка

Добавить комментарий к маршруту.

Новое в Chef Client 14.0

device: Тип Ruby: Строка
Сеть интерфейса, к которой относится маршрут.

gateway: Тип Ruby: Строка
Шлюз для маршрута.

metric: Тип Ruby: Целое число
Значение метрики маршрута.

netmask: Тип Ruby: Строка
Десятичное представление маски сети. Например: 255.255.255.0.

route_type: Тип Ruby: Символ, Строка | Значение по умолчанию: :hostДопустимые значения: :host, :net

target: Тип Ruby: Строка | Значение по умолчанию: The resource block's name
IP-адрес целевого маршрута.

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

Ресурсы 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[Строка]'

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

Примеры

Этот ресурс не имеет примеров.

Ресурс маршрута