Spec-Zone.ru › Ansible 2.8

git – Развертывание программного обеспечения (или файлов) из git-чек-аутов

  • Описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения
  • Статус

Описание

  • Управление git-чек-аутами репозиториев для развертывания файлов или программного обеспечения.

Требования

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

  • git>=1.7.1 (инструмент командной строки)

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
accept_hostkey
логическое
    Варианты:
  • нет ←
  • да
если yes, убедитесь, что "-o StrictHostKeyChecking=no" присутствует в качестве опции ssh.
archive
-
добавлен в 2.4
Укажите путь к файлу архива с расширением. Если указано, создаётся архивный файл указанного формата, содержащий структуру дерева для исходного дерева. Разрешенные форматы архивов ["zip", "tar.gz", "tar", "tgz"]
Это позволит клонировать и выполнить git archive из локального каталога, так как не все git-серверы поддерживают git archive.
bare
логическое
    Варианты:
  • нет ←
  • да
если yes, репозиторий будет создан как пустой репозиторий, в противном случае это будет стандартный репозиторий с рабочей областью.
clone
логическое
    Варианты:
  • нет
  • да ←
Если no, не клонировать репозиторий, даже если он не существует локально
depth
-
Создать мелкий клон с историей, усечённой до указанного количества ревизий. Минимально возможное значение 1, в противном случае игнорируется. Требуется git>=1.9.1 для правильной работы.
dest
- / обязательно
Путь, куда должен быть развернут репозиторий. Этот параметр обязателен, если clone не установлено в no.
executable
-
Путь к исполняемому файлу git. Если не указано, используется стандартный механизм для разрешения путей к бинарным файлам.
force
логическое
    Варианты:
  • нет ←
  • да
Если yes, любые изменённые файлы в рабочем репозитории будут удалены. До версии 0.7, это всегда было «да» и отключить это было нельзя. До версии 1.9, значение по умолчанию было `да`
key_file
-
Укажите необязательный путь к файлу закрытого ключа на целевом хосте для использования при развертывании.
recursive
логическое
    Варианты:
  • нет
  • да ←
Если no, репозиторий будет клонирован без опции --recursive, пропуская подмодули.
reference
-
Репозиторий ссылки (см. «git clone --reference ...»)
refspec
-
Добавить дополнительный refspec для получения. Если версия установлена в SHA-1, недоступный ни с какой ветви или тегом, эта опция может потребоваться для указания ref, содержащего SHA-1. Используется тот же синтаксис, что и в команде «git fetch». Пример значения — "refs/meta/config".
remote
-
Значение по умолчанию:
"origin"
Имя удалённого репозитория.
repo
- / обязательно
Адрес git-репозитория по протоколу git, SSH или HTTP(S).

псевдонимы: имя
separate_git_dir
-
добавлен в 2.7
Путь для размещения клонированного репозитория. Если указано, Git-репозиторий может быть отделён от рабочей области.
ssh_opts
-
Создаёт скрипт-обёртку и экспортирует путь как GIT_SSH, который затем автоматически используется git для переопределения аргументов ssh. Пример значения — "-o StrictHostKeyChecking=no" (хотя эту опцию лучше настроить через accept_hostkey).
track_submodules
логическое
    Варианты:
  • нет ←
  • да
Если yes, подмодули будут отслеживать последнюю коммитацию на их главной ветви (или другой ветви, указанной в .gitmodules). Если no, подмодули будут сохранены в ревизии, указанной в главном проекте. Это эквивалентно указанию флага --remote для команды git submodule update.
umask
-
добавлен в 2.2
Маска umask, которая устанавливается перед выполнением развертывания или других операций с репозиторием.
update
логическое
    Варианты:
  • нет
  • да ←
Если no, не получать новые ревизии из исходного репозитория
Операции, подобные созданию архива, будут выполняться на существующем (старом) репозитории и могут не реагировать на изменения версии или удалённого репозитория.
verify_commit
логическое
добавлен в 2.0
    Варианты:
  • нет ←
  • да
если yes, при клонировании или развертывании version проверять подпись GPG-подписанной коммита. Для этого требуется git версия>=2.1.0. Коммита ОБЯЗАТЕЛЬНО должна быть подписана, а открытый ключ ОБЯЗАТЕЛЬНО должен присутствовать в GPG-хранилище.
version
-
Значение по умолчанию:
"HEAD"
Какую версию репозитория развернуть. Это может быть строка HEAD, имя ветви, имя тега. Также это может быть хэш SHA-1, в этом случае refspec необходимо указать, если данная ревизия ещё не доступна.

Примечания

Примечание

  • Если задача зависает, сначала проверьте, находится ли удалённый хост в known_hosts. SSH запросит у пользователя разрешение на первый контакт с удалённым хостом. Чтобы избежать этого запроса, одним из решений является использование опции accept_hostkey. Другим решением является добавление открытого ключа удалённого хоста в /etc/ssh/ssh_known_hosts перед вызовом модуля git с помощью следующей команды: ssh-keyscan -H remote_host.com >> /etc/ssh/ssh_known_hosts.

Примеры

# Example git checkout from Ansible Playbooks
- git:
    repo: 'https://foosball.example.org/path/to/repo.git'
    dest: /srv/checkout
    version: release-0.22

# Example read-write git checkout from github
- git:
    repo: git@github.com:mylogin/hello.git
    dest: /home/mylogin/hello

# Example just ensuring the repo checkout exists
- git:
    repo: 'https://foosball.example.org/path/to/repo.git'
    dest: /srv/checkout
    update: no

# Example just get information about the repository whether or not it has
# already been cloned locally.
- git:
    repo: 'https://foosball.example.org/path/to/repo.git'
    dest: /srv/checkout
    clone: no
    update: no

# Example checkout a github repo and use refspec to fetch all pull requests
- git:
    repo: https://github.com/ansible/ansible-examples.git
    dest: /src/ansible-examples
    refspec: '+refs/pull/*:refs/heads/*'

# Example Create git archive from repo
- git:
    repo: https://github.com/ansible/ansible-examples.git
    dest: /src/ansible-examples
    archive: /tmp/ansible-examples.zip

# Example clone a repo with separate git directory
- git:
    repo: https://github.com/ansible/ansible-examples.git
    dest: /src/ansible-examples
    separate_git_dir: /src/ansible-examples.git

Возвращаемые значения

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

Ключ Возвращаемое значение Описание
after
строка
успех
последняя ревизия коммита репозитория, полученная во время обновления

Пример:
4c020102a9cd6fe908c9a4a326a38f972f63a903
before
строка
успех
ревизия коммита до обновления репозитория, «null» для нового репозитория

Пример:
67c04ebe40a003bda0efb34eacfb93b0cafdf628
git_dir_before
строка
успех
Содержит исходный путь к каталогу .git, если он был изменён

Пример:
/path/to/old/git/dir
git_dir_now
строка
успех
Содержит новый путь к каталогу .git, если он был изменён

Пример:
/path/to/new/git/dir
remote_url_changed
булево
успех
Содержит True или False, указывая, был ли изменён URL удалённого репозитория.

Пример:
True
warnings
строка
ошибка
Список предупреждений, если запрошенные функции были недоступны из-за слишком старой версии git.

Пример:
Ваша версия git слишком старая, чтобы полностью поддерживать аргумент depth. Возвращаемся к полным проверкам.


Статус

  • Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
  • Этот модуль поддерживается командой разработчиков Ansible Core. [core]

Поддержка Red Hat

Дополнительную информацию о поддержке этого модуля компанией Red Hat можно найти в этой статье базы знаний Red Hat.

Авторы

  • Команда разработчиков Ansible Core
  • Michael DeHaan

Подсказка

Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/git_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API