Ресурс ссылки

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

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

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

Символическая ссылка (иногда называемая мягкой ссылкой) — это запись каталога, которая связывает имя файла со строкой, содержащей абсолютный или относительный путь к файлу в любой файловой системе. Другими словами, «файл, содержащий путь, указывающий на другой файл». Символическая ссылка создаёт новый файл с новым inode, который указывает на расположение inode исходного файла.

Жёсткая ссылка — это запись каталога, которая связывает файл с другим файлом в той же файловой системе. Другими словами, «несколько записей каталога на один и тот же файл». Жёсткая ссылка создаёт новый файл, который указывает на тот же inode, что и исходный файл. В Windows этот ресурс можно использовать для создания точек сопряжения/переинтерпретации каталогов.

Синтаксис

Блок ресурса link создаёт символические или жёсткие ссылки. Например, чтобы создать жёсткую ссылку из /tmp/file в /etc/file:

link '/tmp/file' do
  to '/etc/file'
  link_type :hard
end

Поскольку значение по умолчанию для link_type — это символическая ссылка, и поскольку свойства, не указанные в блоке ресурса, будут присвоены значения по умолчанию, следующий пример создаёт символическую ссылку:

link '/tmp/file' do
  to '/etc/file'
end

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

link 'name' do
  group            String, Integer
  link_type        String, Symbol # default value: :symbolic
  mode             Integer, String
  owner            String, Integer
  target_file      String # default value: 'name' unless specified
  to               String
  action           Symbol # defaults to :create if not specified
end

где:

• link — это ресурс.
• name — имя, присвоенное блоку ресурса.
• action определяет действия, которые Chef Infra Client предпримет для приведения узла в желаемое состояние.
• group, link_type, mode, owner, target_file и to — свойства этого ресурса, со своим типом Ruby. См. раздел «Свойства» ниже для получения дополнительной информации обо всех свойствах, которые можно использовать с этим ресурсом.

Действия

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

:create

По умолчанию. Создать ссылку. Если ссылка уже существует (но не совпадает), обновить эту ссылку, чтобы она соответствовала.

:delete

Удалить ссылку.

:nothing

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

Свойства

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

group

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

Имя группы или идентификационный номер, определяющий группу, связанную с символической ссылкой.

link_type

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

Тип ссылки: :symbolic или :hard. В Windows :symbolic создаёт точку сопряжения, если целевой объект — каталог.

mode

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

Если mode не указано, и если файл уже существует, используется существующий режим файла. Если mode не указано, файл не существует, и действие :create указано, Chef Infra Client предполагает значение маски '0777', а затем применяет значение umask для системы, на которой должен быть создан файл, к значению mask. Например, если umask в системе — '022', Chef Infra Client использует значение по умолчанию '0755'.

Поведение отличается в зависимости от платформы.

Системы на основе UNIX и Linux: строка из 3–5 символов, определяющая восьмеричный режим, передаваемый в chmod. Например: '755', '0755' или 00755. Если значение указано как строка в кавычках, оно работает точно так же, как если бы была передана команда chmod. Если значение указано как целое число, добавьте ноль (0) к значению, чтобы убедиться, что оно интерпретируется как восьмеричное число. Например, чтобы назначить права чтения, записи и выполнения для всех пользователей, используйте '0777' или '777'; для тех же прав плюс бит «липкость» используйте 01777 или '1777'.

Microsoft Windows: строка из 3–5 символов в кавычках, определяющая восьмеричный режим, который преобразуется в права для безопасности Microsoft Windows. Например: '755', '0755' или 00755. Допускаются значения до '0777' (без битов «липкость»), которые означают то же самое в Microsoft Windows, что и в UNIX, где 4 равно GENERIC_READ, 2 равно GENERIC_WRITE и 1 равно GENERIC_EXECUTE. Это свойство нельзя использовать для установки :full_control. Это свойство не имеет эффекта, если не указано, но когда оно и rights оба указаны, эффекты суммируются.

owner

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

Владелец, связанный с символической ссылкой.

target_file

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

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

to

Тип Ruby: Строка

Фактический файл, для которого должна быть создана ссылка.

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

Ресурсы 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.

Примеры

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

Создание символических ссылок

Следующий пример создаст символическую ссылку от /tmp/file к /etc/file:

link '/tmp/file' do
  to '/etc/file'
end

Создание жёстких ссылок

Следующий пример создаст жёсткую ссылку от /tmp/file к /etc/file:

link '/tmp/file' do
  to '/etc/file'
  link_type :hard
end

Удаление ссылок

Следующий пример удалит символическую ссылку /tmp/file и использует защитное условие only_if, чтобы выполнить команду test -L, которая проверяет, что /tmp/file является символической ссылкой, и затем удаляет /tmp/file только в случае успешной проверки:

link '/tmp/file' do
  action :delete
  only_if 'test -L /tmp/file'
end

Создание нескольких символических ссылок

Следующий пример создает символические ссылки из двух файлов в каталоге /vol/webserver/cert/ к файлам, расположенным в каталоге /etc/ssl/certs/:

link '/vol/webserver/cert/server.crt' do
  to '/etc/ssl/certs/ssl-cert-name.pem'
end

link '/vol/webserver/cert/server.key' do
  to '/etc/ssl/certs/ssl-cert-name.key'
end

Создание символических ссылок, специфичных для платформы

Следующий пример демонстрирует установку модуля фильтра на Apache. Название пакета отличается для разных платформ, и для семейства Red Hat Enterprise Linux требуется символическая ссылка:

include_recipe 'apache2::default'

case node['platform_family']
when 'debian'
  ...
when 'suse'
  ...
when 'rhel', 'fedora'
  ...

  link '/usr/lib64/httpd/modules/mod_apreq.so' do
    to      '/usr/lib64/httpd/modules/mod_apreq2.so'
    only_if 'test -f /usr/lib64/httpd/modules/mod_apreq2.so'
  end

  link '/usr/lib/httpd/modules/mod_apreq.so' do
    to      '/usr/lib/httpd/modules/mod_apreq2.so'
    only_if 'test -f /usr/lib/httpd/modules/mod_apreq2.so'
  end
end

...

Полный рецепт см. в https://github.com/onehealth-cookbooks/apache2/blob/68bdfba4680e70b3e90f77e40223dd535bf22c17/recipes/mod_apreq2.rb.

Создание узловых точек/точек перенаправления в Windows

Этот пример демонстрирует, как создать узловую точку/точку перенаправления каталога. В этом примере C:\destination будет узловой точкой/точкой перенаправления к каталогу C:\source.

directory 'C:/source'

link 'C:/destination' do
    link_type :symbolic
    to 'C:/source'
end