203 lines
5.2 KiB
Markdown
203 lines
5.2 KiB
Markdown
git
|
|
=========
|
|
|
|
<img src="https://docs.ansible.com/ansible-tower/3.2.4/html_ja/installandreference/_static/images/logo_invert.png" width="10%" height="10%" alt="Ansible logo" align="right"/>
|
|
<a href="https://travis-ci.org/robertdebock/ansible-role-git"> <img src="https://travis-ci.org/robertdebock/ansible-role-git.svg?branch=master" alt="Build status"/></a> <img src="https://img.shields.io/ansible/role/d/34950"/> <img src="https://img.shields.io/ansible/quality/34950"/>
|
|
|
|
Install and configure git on your system.
|
|
|
|
Example Playbook
|
|
----------------
|
|
|
|
This example is taken from `molecule/resources/playbook.yml` and is tested on each push, pull request and release.
|
|
```yaml
|
|
---
|
|
- name: Converge
|
|
hosts: all
|
|
become: yes
|
|
gather_facts: yes
|
|
|
|
vars:
|
|
git_username: root
|
|
git_groupname: root
|
|
git_repository_destination: /root
|
|
git_repositories:
|
|
- repo: https://github.com/robertdebock/robertdebock.bootstrap
|
|
dest: bootstrap
|
|
- repo: https://github.com/robertdebock/robertdebock.bootstrap
|
|
dest: bootstrap-force
|
|
force: yes
|
|
- repo: https://github.com/robertdebock/robertdebock.bootstrap
|
|
dest: bootstrap-version
|
|
version: 2.11.1
|
|
|
|
roles:
|
|
- robertdebock.git
|
|
```
|
|
|
|
The machine you are running this on, may need to be prepared, I use this playbook to ensure everything is in place to let the role work.
|
|
```yaml
|
|
---
|
|
- name: Prepare
|
|
hosts: all
|
|
gather_facts: no
|
|
become: yes
|
|
serial: 30%
|
|
|
|
roles:
|
|
- role: robertdebock.bootstrap
|
|
```
|
|
|
|
|
|
Also see a [full explanation and example](https://robertdebock.nl/how-to-use-these-roles.html) on how to use these roles.
|
|
|
|
Role Variables
|
|
--------------
|
|
|
|
These variables are set in `defaults/main.yml`:
|
|
```yaml
|
|
---
|
|
# defaults file for git
|
|
|
|
# The system username in /home where to place the gitconfig file.
|
|
# git_username: johndoe
|
|
|
|
# The group to own directories.
|
|
# git_groupname: "{{ git_username }}"
|
|
|
|
# Settings for git configuration.
|
|
# git_user_email: johndoe@example.com
|
|
# git_user_name: John Doe
|
|
|
|
# Where to place the copies of the repositories.
|
|
git_repository_destination: /home/{{ git_username }}/Documents/github.com/{{ git_username }}
|
|
|
|
|
|
# Should git force (overwrite locally changed) clone? (Can also be controlled
|
|
# per repository, see below.
|
|
git_force: no
|
|
|
|
# The repositories to check out, bootstrap is pinned to a version, java will get HEAD/latest.
|
|
# git_repositories:
|
|
# - repo: https://github.com/robertdebock/ansible-role-bootstrap.git
|
|
# dest: bootstrap
|
|
# version: 2.2.4
|
|
# - repo: ssh://git@github.com/robertdebock/ansible-role-java.git
|
|
# dest: java
|
|
# - repo: ssh://git@github.com/robertdebock/ansible-role-tomcat.git
|
|
# dest: tomcat
|
|
# force: yes
|
|
```
|
|
|
|
Requirements
|
|
------------
|
|
|
|
- Access to a repository containing packages, likely on the internet.
|
|
- A recent version of Ansible. (Tests run on the current, previous and next release of Ansible.)
|
|
|
|
The following roles can be installed to ensure all requirements are met, using `ansible-galaxy install -r requirements.yml`:
|
|
|
|
```yaml
|
|
---
|
|
- robertdebock.bootstrap
|
|
|
|
```
|
|
|
|
Context
|
|
-------
|
|
|
|
This role is a part of many compatible roles. Have a look at [the documentation of these roles](https://robertdebock.nl/) for further information.
|
|
|
|
Here is an overview of related roles:
|
|
|
|
|
|
|
|
Compatibility
|
|
-------------
|
|
|
|
This role has been tested on these [container images](https://hub.docker.com/):
|
|
|
|
|container|tag|allow_failures|
|
|
|---------|---|--------------|
|
|
|amazonlinux|1|no|
|
|
|amazonlinux|latest|no|
|
|
|alpine|latest|no|
|
|
|alpine|edge|yes|
|
|
|debian|unstable|yes|
|
|
|debian|latest|no|
|
|
|centos|7|no|
|
|
|redhat|7|no|
|
|
|centos|latest|no|
|
|
|redhat|latest|no|
|
|
|fedora|latest|no|
|
|
|fedora|rawhide|yes|
|
|
|opensuse|latest|no|
|
|
|ubuntu|latest|no|
|
|
|
|
This role has been tested on these Ansible versions:
|
|
|
|
- ansible>=2.8, <2.9
|
|
- ansible>=2.9
|
|
- git+https://github.com/ansible/ansible.git@devel
|
|
|
|
|
|
|
|
Testing
|
|
-------
|
|
|
|
[Unit tests](https://travis-ci.org/robertdebock/ansible-role-git) are done on every commit, pull request, release and periodically.
|
|
|
|
If you find issues, please register them in [GitHub](https://github.com/robertdebock/ansible-role-git/issues)
|
|
|
|
Testing is done using [Tox](https://tox.readthedocs.io/en/latest/) and [Molecule](https://github.com/ansible/molecule):
|
|
|
|
[Tox](https://tox.readthedocs.io/en/latest/) tests multiple ansible versions.
|
|
[Molecule](https://github.com/ansible/molecule) tests multiple distributions.
|
|
|
|
To test using the defaults (any installed ansible version, namespace: `robertdebock`, image: `fedora`, tag: `latest`):
|
|
|
|
```
|
|
molecule test
|
|
|
|
# Or select a specific image:
|
|
image=ubuntu molecule test
|
|
# Or select a specific image and a specific tag:
|
|
image="debian" tag="stable" tox
|
|
```
|
|
|
|
Or you can test multiple versions of Ansible, and select images:
|
|
Tox allows multiple versions of Ansible to be tested. To run the default (namespace: `robertdebock`, image: `fedora`, tag: `latest`) tests:
|
|
|
|
```
|
|
tox
|
|
|
|
# To run CentOS (namespace: `robertdebock`, tag: `latest`)
|
|
image="centos" tox
|
|
# Or customize more:
|
|
image="debian" tag="stable" tox
|
|
```
|
|
|
|
Modules
|
|
-------
|
|
|
|
This role uses the following modules:
|
|
```yaml
|
|
---
|
|
- file
|
|
- getent
|
|
- git
|
|
- package
|
|
- template
|
|
```
|
|
|
|
License
|
|
-------
|
|
|
|
Apache-2.0
|
|
|
|
|
|
Author Information
|
|
------------------
|
|
|
|
[Robert de Bock](https://robertdebock.nl/)
|