Ресурс git

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

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

Используйте ресурс 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 # default value: {}
  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 Infra Client.

Уведомления

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

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

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