Ресурс ifconfig

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

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

Используйте ресурс ifconfig для управления интерфейсами в системах Unix и Linux.

Синтаксис

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

ifconfig 'name' do
  bcast             String
  bonding_opts      String
  bootproto         String
  bridge            String
  device            String
  ethtool_opts      String
  family            String # default value: "inet"
  gateway           String
  hwaddr            String
  inet_addr         String
  mask              String
  master            String
  metric            String
  mtu               String
  network           String
  onboot            String
  onparent          String
  slave             String
  target            String # default value: 'name' unless specified
  vlan              String
  action            Symbol # defaults to :add if not specified
end

где:

• ifconfig — это ресурс.
• name — это имя, присвоенное блоку ресурса.
• action определяет действия, которые клиент Chef Infra будет выполнять для приведения узла в желаемое состояние.
• bcast, bonding_opts, bootproto, bridge, device, ethtool_opts, family, gateway, hwaddr, inet_addr, mask, master, metric, mtu, network, onboot, onparent, slave, target, и vlan — это свойства, доступные для этого ресурса.

Действия

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

:add

По умолчанию. Запускает ifconfig для настройки сетевого интерфейса и (на некоторых платформах) записи файла конфигурации для этого сетевого интерфейса.

:delete

Запускает ifconfig для отключения сетевого интерфейса и (на некоторых платформах) удаления файла конфигурации этого сетевого интерфейса.

:disable

Запускает ifconfig для отключения сетевого интерфейса.

:enable

Запускает ifconfig для включения сетевого интерфейса.

:nothing

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

Свойства

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

bcast

Тип Ruby: String

Широковещательный адрес для сетевого интерфейса. На некоторых платформах это свойство не устанавливается с помощью ifconfig, а вместо этого добавляется в начальный файл конфигурации сетевого интерфейса.

bonding_opts

Тип Ruby: String

Параметры склейки, передаваемые через BONDING_OPTS в RHEL и CentOS. Например: mode=active-backup miimon=100.

Новое в Chef Client 13.4

bootproto

Тип Ruby: String

Протокол загрузки, используемый сетевым интерфейсом.

bridge

Тип Ruby: String

Мостовой интерфейс, членом которого является этот интерфейс в системах на базе Red Hat.

Новое в Chef Infra Client 16.7

device

Тип Ruby: String

Сетевой интерфейс, который необходимо настроить.

ethtool_opts

Тип Ruby: String

Параметры, передаваемые в ethtool(8). Например: -A eth0 autoneg off rx off tx off.

Новое в Chef Client 13.4

family

Тип Ruby: String | Значение по умолчанию: inet

Параметр семейства сетей для систем на базе Debian; например: inet или inet6.

Новое в Chef Client 14.0

gateway

Тип Ruby: String

Шлюз, который будет использоваться для интерфейса.

Новое в Chef Client 14.4

hwaddr

Тип Ruby: String

Аппаратный адрес для сетевого интерфейса.

inet_addr

Тип Ruby: String

IP-адрес узла для сетевого интерфейса.

mask

Тип Ruby: String

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

master

Тип Ruby: String

Указывает интерфейс склейки каналов, с которым связан Ethernet-интерфейс.

Новое в Chef Client 13.4

metric

Тип Ruby: String

Метрика маршрутизации для интерфейса.

mtu

Тип Ruby: String

Максимальный размер передаваемого блока (MTU) для сетевого интерфейса.

network

Тип Ruby: String

Адрес для сетевого интерфейса.

onboot

Тип Ruby: String

Включить сетевой интерфейс при загрузке.

onparent

Тип Ruby: String

Включить сетевой интерфейс при включении родительского интерфейса.

slave

Тип Ruby: String

При установке в yes, это устройство управляется интерфейсом склейки каналов, указанным через свойство master.

Новое в Chef Client 13.4

target

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

IP-адрес, который должен быть назначен сетевому интерфейсу. Если не указано, будет использоваться имя ресурса.

vlan

Тип Ruby: String

VLAN для назначения интерфейсу.

Новое в Chef Client 14.4

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

Ресурсы Chef включают общие свойства, уведомления и средства защиты ресурсов.

Общие свойства

Следующие свойства являются общими для каждого ресурса:

compile_time

Тип Ruby: true, false | Значение по умолчанию: false

Управление фазой, во время которой ресурс выполняется на узле. Установите значение true для запуска во время построения коллекции ресурсов (compile phase). Установите значение false для запуска во время настройки узла клиентом Chef Infra (converge phase).

ignore_failure

Тип Ruby: true, false, :quiet | Значение по умолчанию: false

Продолжить выполнение рецепта, если ресурс завершится неудачей по любой причине. :quiet не будет отображать полный трассировку стека, и рецепт будет продолжать выполняться, если ресурс завершится неудачей.

retries

Тип Ruby: Integer | Значение по умолчанию: 0

Количество попыток перехвата исключений и повтора ресурса.

retry_delay

Тип Ruby: Integer | Значение по умолчанию: 2

Задержка повтора (в секундах).

sensitive

Тип Ruby: true, false | Значение по умолчанию: false

Обеспечьте, чтобы конфиденциальные данные ресурса не регистрировались Chef InfraClient.

Уведомления

notifies

Тип Ruby: Symbol, 'Chef::Resource[String]'

Ресурс может уведомлять другой ресурс о необходимости действия при изменении его состояния. Укажите 'resource[name]', :action, которое должен выполнить этот ресурс, а затем :timer для этого действия. Ресурс может уведомлять более одного ресурса; используйте оператор notifies для каждого ресурса, который должен быть уведомлен.

Если указанный ресурс не существует, возникает ошибка. В отличие от этого, subscribes не завершится ошибкой, если исходный ресурс не найден.

Таймер указывает момент во время выполнения клиента Chef Infra, когда выполняется уведомление. Доступны следующие таймеры:

:before

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

:delayed

По умолчанию. Указывает, что уведомление должно быть помещено в очередь, а затем выполнено в конце выполнения клиента Chef Infra.

:immediate, :immediately

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

Синтаксис для notifies следующий:

notifies :action, 'resource[name]', :timer

subscribes

Тип Ruby: Symbol, '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, когда выполняется уведомление. Доступны следующие таймеры:

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

Примеры

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

Настройка сетевого интерфейса со статическим IP-адресом

ifconfig '33.33.33.80' do
  device 'eth1'
end

создаст следующую конфигурацию интерфейса:

iface eth1 inet static
  address 33.33.33.80

Настройка интерфейса для использования DHCP

ifconfig 'Set eth1 to DHCP' do
  device 'eth1'
  bootproto 'dhcp'
end

создаст следующую конфигурацию интерфейса:

iface eth1 inet dhcp

Обновление статического IP-адреса с протоколом загрузки

ifconfig "33.33.33.80" do
  bootproto "dhcp"
  device "eth1"
end

обновит конфигурацию интерфейса со статического на DHCP:

iface eth1 inet dhcp
  address 33.33.33.80