Ресурс ksh

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

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

Используйте ресурс ksh для выполнения скриптов с интерпретатором оболочки Korn shell (ksh). Этот ресурс также может использовать любые действия и свойства, доступные для ресурса execute. Команды, выполняемые с помощью этого ресурса, по своей природе не идемпотентны, поскольку они обычно уникальны для среды, в которой они выполняются. Используйте not_if и only_if для защиты этого ресурса от идемпотентности.

Синтаксис

Блок ресурса ksh выполняет скрипты с помощью ksh:

ksh 'hello world' do
  code <<-EOH
    echo "Hello world!"
    echo "Current directory: " $cwd
  EOH
end

где:

• code указывает команду для выполнения

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

ksh 'name' do
  code                       String
  creates                    String
  cwd                        String
  environment                Hash
  flags                      String
  group                      String, Integer
  path                       Array
  returns                    Integer, Array
  timeout                    Integer, Float
  user                       String, Integer
  umask                      String, Integer
  action                     Symbol # defaults to :run if not specified
end

где:

• ksh — это ресурс.
• name — имя, присвоенное блоку ресурса.
• action определяет действия, которые клиент Chef Infra выполнит, чтобы привести узел в желаемое состояние.
• code, creates, cwd, environment, flags, group, path, returns, timeout, user, и umask — свойства этого ресурса с указанным типом Ruby. См. раздел «Свойства» ниже для получения дополнительной информации обо всех свойствах, которые можно использовать с этим ресурсом.

Действия

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

:nothing

Запретить выполнение команды. Это действие используется для указания, что команда выполняется только тогда, когда другой ресурс её уведомляет.

:run

По умолчанию. Выполнить скрипт.

Свойства

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

code

Тип Ruby: Строка

Цитированная (« “») строка кода, подлежащая выполнению.

creates

Тип Ruby: Строка

Запретить команде создание файла, если такой файл уже существует.

cwd

Тип Ruby: Строка

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

environment

Тип Ruby: Словарь

Словарь переменных среды в формате ({'ENV_VARIABLE' => 'VALUE'}). Примечание: Эти переменные должны существовать для успешного выполнения команды.

flags

Тип Ruby: Строка

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

group

Тип Ruby: Строка, Целое число

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

returns

Тип Ruby: Целое число, Массив | Значение по умолчанию: 0

Возвращаемое значение команды. Может быть массивом допустимых значений. При несоответствии возвращаемого значения(й) генерируется исключение.

timeout

Тип Ruby: Целое число, Строка, Число с плавающей точкой | Значение по умолчанию: 3600

Время ожидания (в секундах) команды до истечения времени.

user

Тип Ruby: Строка, Целое число

Имя или идентификатор пользователя, который необходимо изменить перед выполнением команды.

umask

Тип Ruby: Строка, Целое число

Маска создания режима файла или umask.

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

Ресурсы 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: Целое число | Значение по умолчанию: 0

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

retry_delay

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

Задержка в секундах между попытками повтора.

sensitive

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

Убедиться, что конфиденциальные данные ресурсов не регистрируются клиентом Chef Infra.

Уведомления

notifies

Тип Ruby: Символ, 'Chef::Resource[Строка]'

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

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

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

:before

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

:delayed

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

:immediate, :immediately

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

Синтаксис для notifies:

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

subscribes

Тип Ruby: Символ, 'Chef::Resource[Строка]'

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

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

:before

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

:delayed

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

:immediate, :immediately

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

Синтаксис для subscribes:

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

Блокировки

Свойство блокировки может использоваться для оценки состояния узла во время фазы выполнения клиента Chef Infra. Основываясь на результатах этой оценки, свойство блокировки затем сообщает клиенту Chef Infra, следует ли продолжать выполнение ресурса. Свойство блокировки принимает значение либо строку, либо блок Ruby:

• Строка выполняется как команда оболочки. Если команда возвращает 0, блокировка применяется. Если команда возвращает любое другое значение, то свойство блокировки не применяется. Строковые блокировки в powershell_script выполняют команды Windows PowerShell и могут возвращать true в дополнение к 0.
• Блок выполняется как код Ruby, который должен вернуть либо true или false. Если блок возвращает true, свойство блокировки применяется. Если блок возвращает false, свойство блокировки не применяется.

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

Следующие свойства могут использоваться для определения блокировки, которая оценивается во время фазы выполнения клиента Chef Infra:

not_if

Запретить выполнение ресурса, когда условие возвращает true.

only_if

Разрешить выполнение ресурса только в том случае, если условие возвращает true.

Примеры

У этого ресурса нет примеров.