Ресурс link

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

Страница всех ресурсов Infra

Используйте ресурс 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 Допустимые значения: :hard, :symbolic

Тип ссылки: :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 Infra Client.

Уведомления

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