Ресурс git

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

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

Используйте ресурс git для управления ресурсами системы контроля версий, существующими в репозитории git. Для использования всех функций ресурса git требуется версия git 1.6.5 (или выше).

Синтаксис

Блок ресурса git управляет ресурсами системы контроля версий, существующими в репозитории git:

git "#{Chef::Config[:file_cache_path]}/app_name" do
  repository node[:app_name][:git_repository]
  revision node[:app_name][:git_revision]
  action :sync
end

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

git 'name' do
  additional_remotes      Hash
  checkout_branch         String
  depth                   Integer
  destination             String # default value: 'name' unless specified
  enable_checkout         true, false # default value: true
  enable_submodules       true, false # default value: false
  environment             Hash
  group                   String, Integer
  remote                  String # default value: "origin"
  repository              String
  revision                String # default value: "HEAD"
  ssh_wrapper             String
  timeout                 Integer
  user                    String, Integer
  action                  Symbol # defaults to :sync if not specified
end

где:

• git — это ресурс.
• name — это имя, присвоенное блоку ресурса.
• action определяет действия, которые Chef Infra Client предпримет для приведения узла к желаемому состоянию.
• additional_remotes, checkout_branch, depth, destination, enable_checkout, enable_submodules, environment, group, remote, repository, revision, ssh_wrapper, timeout, и user — это свойства, доступные для данного ресурса.

Действия

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

:checkout

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

:export

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

:nothing

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

:sync

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

Свойства

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

additional_remotes

Тип в Ruby: Hash

Хэш дополнительных удаленных репозиториев, которые добавляются в конфигурацию репозитория git.

checkout_branch

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

Однократная проверка состояния из git или использование, когда ветка в исходном репозитории имеет имя deploy. Чтобы предотвратить попытку ресурса git проверить состояние master из master, установите enable_checkout в значение false при использовании свойства checkout_branch. См. revision.

depth

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

Количество прошлых версий, которые необходимо включить в поверхностный клон git. Если не указано, поведение по умолчанию выполнит полное клонирование.

destination

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

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

enable_checkout

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

Проверка состояния репозитория из master. Установите в значение false при использовании атрибута checkout_branch для предотвращения попытки ресурса git проверить состояние master из master.

enable_submodules

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

Выполнение инициализации и обновления подмодулей.

environment

Тип в Ruby: Хэш

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

Примечание

Провайдер git автоматически устанавливает переменные среды ENV['HOME'] и ENV['GIT_SSH']. Чтобы переопределить это поведение и задать разные значения, добавьте ENV['HOME'] и/или ENV['GIT_SSH'] в хэш environment.

group

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

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

remote

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

Удаленный репозиторий для использования при синхронизации существующего клона.

repository

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

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

revision

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

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

Значение атрибута revision может со временем меняться. От одной ветки к другой, к метке, к конкретному SHA коммита, и затем обратно к ветке. Атрибут revision может даже изменяться так, что история переписывается.

Вместо отслеживания конкретной ветки или выполнения безголового экспорта, Chef Infra Client поддерживает собственную ветку (через ресурс git), которая не существует в исходном репозитории. Затем Chef Infra Client свободен принудительно проверить состояние этой ветки на любом коммите без уничтожения локальной истории существующей ветки.

Например, чтобы явно отслеживать ветку master исходного репозитория:

revision 'master'

Используйте команды git rev-parse и git ls-remote для проверки правильности синхронизации коммитов Chef Infra Client. (Chef Infra Client всегда выполняет git ls-remote в исходном репозитории для проверки того, что коммит внесен в правильный репозиторий.)

ssh_wrapper

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

Путь к скрипту-обёртке, используемому при запуске SSH с git. Эта переменная среды GIT_SSH устанавливается в это значение.

timeout

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

Количество времени (в секундах) ожидания выполнения команды перед истечением таймаута. Когда это свойство задается с помощью ресурса deploy, значение свойства timeout передаётся из ресурса deploy в ресурс git.

user

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

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

Общие функции ресурсов

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

Примеры

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

Использование зеркала git

git '/opt/my_sources/couch' do
  repository 'git://git.apache.org/couchdb.git'
  revision 'master'
  action :sync
end

Использование различных ветвей

Для использования разных ветвей в зависимости от среды узла:

branch_name = if node.chef_environment == 'QA'
                'staging'
              else
                'master'
              end

git '/home/user/deployment' do
   repository 'git@github.com:git_site/deployment.git'
   revision branch_name
   action :sync
   user 'user'
   group 'test'
end

Где переменная branch_name устанавливается в staging или master в зависимости от среды узла. После определения этого переменная branch_name используется для установки ревизии репозитория. Если после выполнения примера выше используется команда git status, она вернет имя ветви как deploy, так как это значение по умолчанию. Для проверки того, что проверяются правильные ветви, запустите Chef Infra Client в отладочном режиме:

sudo chef-client -l debug

Установка приложения из git с использованием bash

Следующий пример демонстрирует, как Bash может использоваться для установки плагина для rbenv под названием ruby-build, который находится в системе управления версиями git. Сначала приложение синхронизируется, затем Bash меняет свою рабочую директорию на расположение ruby-build и выполняет команду.

git "/Users/tsmith/.chef/cache/ruby-build" do
  repository 'git://github.com/rbenv/ruby-build.git'
  revision 'master'
  action :sync
end

bash 'install_ruby_build' do
  cwd "/Users/tsmith/.chef/cache/ruby-build"
  user 'rbenv'
  group 'rbenv'
  code <<-EOH
    ./install.sh
    EOH
  environment 'PREFIX' => '/usr/local'
end

Уведомление о ресурсе после проверки out

git "/Users/tsmith/.chef/cache/my_app" do
  repository node['my_app']['git_repository']
  revision node['my_app']['git_revision']
  action :sync
  notifies :run, 'bash[compile_my_app]', :immediately
end

Передача переменных среды

git '/opt/my_sources/couch' do
  repository 'git://git.apache.org/couchdb.git'
  revision 'master'
  environment 'VAR' => 'whatever'
  action :sync
end