ansible-development-environ.../roles/buildtools/README.md

182 lines
4.6 KiB
Markdown

buildtools
=========
<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-buildtools"> <img src="https://travis-ci.org/robertdebock/ansible-role-buildtools.svg?branch=master" alt="Build status"/></a> <img src="https://img.shields.io/ansible/role/d/22111"/> <img src="https://img.shields.io/ansible/quality/22111"/>
Install buildtools 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
roles:
- robertdebock.buildtools
```
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
roles:
- robertdebock.bootstrap
```
After running this role, this playbook runs to verify that everything works, this may be a good example how you can use this role.
```yaml
---
- name: Verify
hosts: all
become: no
gather_facts: no
tasks:
- name: run gcc
command: gcc --version
- name: run make
command: make --version
- name: run shasum
command: shasum --version
- name: run bison
command: bison --version
- name: find libelf
find:
paths: /usr
patterns: libelf.so.1
register: buildtools_find_libelf
- name: assert the results
assert:
that:
- buildtools_find_libelf.matched >= 0
msg: could not find libelf.so.1 in /usr
```
```
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 buildtools
```
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:
![dependencies](https://raw.githubusercontent.com/robertdebock/drawings/artifacts/buildtools.png "Dependency")
Compatibility
-------------
This role has been tested on these [container images](https://hub.docker.com/):
|container|tags|
|---------|----|
|amazon|all|
|alpine|all|
|archlinux|all|
|debian|all|
|el|7, 8|
|fedora|all|
|opensuse|all|
|ubuntu|artful, bionic|
The minimum version of Ansible required is 2.8 but tests have been done to:
- The previous version, on version lower.
- The current version.
- The development version.
Exceptions
----------
Some variarations of the build matrix do not work. These are the variations and reasons why the build won't work:
| variation | reason |
|---------------------------|------------------------|
| EL | No package matching 'bison' found available, installed or updated |
Testing
-------
[Unit tests](https://travis-ci.org/robertdebock/ansible-role-buildtools) 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-buildtools/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
```
License
-------
Apache-2.0
Author Information
------------------
[Robert de Bock](https://robertdebock.nl/)