Ресурс python

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

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

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

Синтаксис

Ресурс python имеет следующий синтаксис:

python 'hello world' do
  code <<-EOH
    print "Hello world! From Chef and Python."
  EOH
end

где:

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

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

python 'name' do
  code             String
  command          String # default value: 'name' unless specified
  creates          String
  cwd              String
  default_env      true, false # default value: false
  domain           String
  elevated         true, false # default value: false
  environment      Hash
  flags            String
  group            String, Integer
  interpreter      String
  live_stream      true, false # default value: false
  password         String
  returns          Integer, Array # default value: 0
  sensitive        true, false # default value: "True if the password property is set. False otherwise."
  timeout          Integer, Float
  umask            String, Integer
  user             String, Integer
  action           Symbol # defaults to :run if not specified
end

где:

• python — это ресурс.
• name — имя блока ресурса.
• action определяет действия, которые клиент Chef Infra предпримет для приведения узла к желаемому состоянию.
• code, command, creates, cwd, default_env, domain, elevated, environment, flags, group, interpreter, live_stream, password, returns, timeout, и user — это свойства, доступные для данного ресурса.

Действия

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

:nothing

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

:run

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

Свойства

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

code

Тип в Ruby: Строка | REQUIRED

Строка кода в кавычках ("“), подлежащая выполнению.

creates

Тип в Ruby: Строка

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

cwd

Тип в Ruby: Строка

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

environment

Тип в Ruby: Хэш

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

flags

Тип в Ruby: Строка

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

group

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

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

ignore_failure

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

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

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

returns

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

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

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

timeout

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

Количество времени (в секундах), которое команда должна ждать перед истечением времени ожидания.

umask

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

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

user

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

Имя пользователя идентификатора пользователя, с которым будет запущен новый процесс. Имя пользователя может быть указано с доменом, например, domain\user или user@my.dns.domain.com в формате универсального имени принципала (UPN). Также можно указать без домена просто как user, если вместо этого домен указан с помощью свойства domain. Только в Windows, если это свойство указано, необходимо указать свойство password.

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

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

Защиты

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

Примеры

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