Ресурс archive_file

Изменить эту страницу в репозитории Chef

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

Используйте ресурс archive_file для извлечения архивов на диск. Этот ресурс использует библиотеку libarchive для извлечения нескольких форматов архивов, включая tar, gzip, bzip и zip.

Новое в Chef Infra Client 15.0.

Синтаксис

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

archive_file 'name' do
  destination      String
  group            String
  mode             String, Integer # default value: "755"
  options          Array, Symbol
  overwrite        true, false, auto # default value: false
  owner            String
  path             String # default value: 'name' unless specified
  action           Symbol # defaults to :extract if not specified
end

где:

• archive_file — это ресурс.
• name — имя блока ресурса.
• action определяет шаги, которые Chef Infra Client предпримет для приведения узла в нужное состояние.
• destination, group, mode, options, overwrite, owner, и path — доступные свойства этого ресурса.

Действия

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

:extract

Извлечение и архивирование файла.

:nothing

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

Свойства

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

destination

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

Путь к файлу, в который должен быть извлечён архив.

group

Тип Ruby: Строка

Группа извлечённых файлов.

mode

Тип Ruby: Строка, Целое число | Значение по умолчанию: "755"

Режим извлечённых файлов. Целочисленные значения устарели, так как восьмеричные значения (например, 0755) не будут интерпретироваться корректно.

options

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

Массив символов, представляющих флаги извлечения. Пример: :no_overwrite для предотвращения перезаписи файлов на диске. По умолчанию это правильно устанавливает :time для сохранения временных меток модификации файлов в архиве при их записи на диск.

overwrite

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

Нужно ли ресурсу перезаписывать содержимое целевого файла, если оно уже существует? Если установлено :auto, то будет сравниваться дата создания файлов внутри архива с файлами на диске, и содержимое диска будет перезаписано, если они отличаются. Это может привести к непредвиденным последствиям, если временные метки на диске изменятся между выполнениями, что приведёт к перезаписи файлов во время каждого выполнения клиента. Не забудьте должным образом протестировать любые изменения в этом свойстве.

owner

Тип Ruby: Строка

Владелец извлечённых файлов.

path

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

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

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

Ресурсы 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, которые выведут ошибку, если другой ресурс не существует.

Таймер указывает момент во время выполнения 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.

Примеры

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

Извлечение файла zip в указанную директорию:

archive_file 'Precompiled.zip' do
  path '/tmp/Precompiled.zip'
  destination '/srv/files'
end

Установка определённых разрешений на извлечённые файлы:

archive_file 'Precompiled.zip' do
  owner 'tsmith'
  group 'staff'
  mode '700'
  path '/tmp/Precompiled.zip'
  destination '/srv/files'
end