Ресурс subversion

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

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

Используйте ресурс subversion для управления ресурсами контроля версий, существующими в репозитории Subversion.

Синтаксис

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

subversion 'name' do
  destination        String # default value: 'name' unless specified
  environment        Hash
  group              String, Integer
  repository         String
  revision           String # default value: "HEAD"
  svn_arguments      String, false # default value: "--no-auth-cache"
  svn_binary         String
  svn_info_args      String, false # default value: "--no-auth-cache"
  svn_password       String
  svn_username       String
  timeout            Integer
  user               String, Integer
  action             Symbol # defaults to :sync if not specified
end

где:

• subversion — это ресурс.
• name — это имя, заданное для блока ресурса.
• action определяет, какие шаги клиент Chef Infra предпримет, чтобы привести узел в желаемое состояние.
• destination, environment, group, repository, revision, svn_arguments, svn_binary, svn_info_args, svn_password, svn_username, timeout, и user — это доступные свойства для данного ресурса.

Действия

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

:checkout

Клонирование или получение исходного кода. Когда доступна функция получения, этот поставщик ничего не делает.

:export

Экспорт исходного кода, исключая или удаляя любые артефакты управления версиями.

:force_export

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

:nothing

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

:sync

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

Свойства

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

destination

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

Путь к расположению, куда будет клонирован, получен или экспортирован исходный код. Значение по умолчанию: имя блока ресурса.

environment

Тип Ruby: Hash

Хеш-таблица переменных среды в формате ({‘ENV_VARIABLE’ => ‘VALUE’}).

group

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

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

repository

Тип Ruby: Строка

URI репозитория кода.

revision

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

Ветка, тег или коммит для синхронизации с git. Это может быть символическое обозначение, например HEAD, или идентификатор ревизии, специфичный для системы управления версиями.

svn_arguments

Тип Ruby: Строка, false | Значение по умолчанию: --no-auth-cache

Дополнительные аргументы, передаваемые команде Subversion.

svn_binary

Тип Ruby: Строка

Расположение двоичного файла svn.

svn_info_args

Тип Ruby: Строка, false | Значение по умолчанию: --no-auth-cache

Используется, когда команда svn info используется клиентом Chef Infra, и необходимо передать аргументы. Команда svn_arguments не работает, когда используется команда svn info.

svn_password

Тип Ruby: Строка

Пароль пользователя, имеющего доступ к репозиторию Subversion.

svn_username

Тип Ruby: Строка

Имя пользователя, имеющего доступ к репозиторию Subversion.

timeout

Тип Ruby: Целое число

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

user

Тип Ruby: Строка, Целое число | Значение по умолчанию: `HOME` environment variable of the user running chef-client

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

Общие возможности ресурсов

Ресурсы 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[String]'

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

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

Примеры

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

Получение последней версии приложения

subversion 'CouchDB Edge' do
  repository 'http://svn.apache.org/repos/asf/couchdb/trunk'
  revision 'HEAD'
  destination '/opt/my_sources/couch'
  action :sync
end