1
0
Fork 0
mirror of https://github.com/roles-ansible/ansible_role_base.git synced 2024-08-16 14:29:50 +02:00

Improve README and disable versionscheck by default

This commit is contained in:
L3D 2020-10-26 17:28:13 +01:00 committed by Lilian Roller
parent 77f0aec2d4
commit 79ce26f2ee
No known key found for this signature in database
GPG key ID: 5215C3441797AB2B
3 changed files with 284 additions and 21 deletions

217
.github/license.svg vendored Normal file
View file

@ -0,0 +1,217 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<svg
xmlns:dc="http://purl.org/dc/elements/1.1/"
xmlns:cc="http://creativecommons.org/ns#"
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
xmlns:svg="http://www.w3.org/2000/svg"
xmlns="http://www.w3.org/2000/svg"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
width="83.946869"
height="20.137625"
version="1.1"
id="svg28"
sodipodi:docname="license.svg"
inkscape:version="0.92.4 5da689c313, 2019-01-14">
<metadata
id="metadata34">
<rdf:RDF>
<cc:Work
rdf:about="">
<dc:format>image/svg+xml</dc:format>
<dc:type
rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
<dc:title></dc:title>
<cc:license
rdf:resource="MIT (c) L3D &lt;l3d@c3woc.de&gt;" />
<dc:creator>
<cc:Agent>
<dc:title>3D &lt;l3d@c3woc.de&gt;</dc:title>
</cc:Agent>
</dc:creator>
<dc:rights>
<cc:Agent>
<dc:title>MIT License</dc:title>
</cc:Agent>
</dc:rights>
</cc:Work>
</rdf:RDF>
</metadata>
<defs
id="defs32">
<linearGradient
inkscape:collect="always"
xlink:href="#b"
id="linearGradient4625"
gradientUnits="userSpaceOnUse"
gradientTransform="matrix(4.9067096,0,0,0.44280744,1.0963297e-6,-1e-6)"
x1="0"
y1="-0.28392482"
x2="0"
y2="45.166359" />
<linearGradient
inkscape:collect="always"
xlink:href="#b"
id="linearGradient837"
gradientUnits="userSpaceOnUse"
gradientTransform="matrix(4.9067096,0,0,0.44280744,1.0963297e-6,-1e-6)"
x1="0"
y1="-0.28392482"
x2="0"
y2="45.166359" />
<linearGradient
inkscape:collect="always"
xlink:href="#b"
id="linearGradient839"
gradientUnits="userSpaceOnUse"
gradientTransform="matrix(4.9067096,0,0,0.44280744,1.0963297e-6,-1e-6)"
x1="0"
y1="-0.28392482"
x2="0"
y2="45.166359" />
</defs>
<sodipodi:namedview
pagecolor="#ffffff"
bordercolor="#666666"
borderopacity="1"
objecttolerance="10"
gridtolerance="10"
guidetolerance="10"
inkscape:pageopacity="0"
inkscape:pageshadow="2"
inkscape:window-width="1916"
inkscape:window-height="1152"
id="namedview30"
showgrid="false"
showguides="true"
inkscape:guide-bbox="true"
inkscape:zoom="7.5888761"
inkscape:cx="39.713668"
inkscape:cy="14.182162"
inkscape:window-x="2560"
inkscape:window-y="22"
inkscape:window-maximized="0"
inkscape:current-layer="svg28"
fit-margin-top="0"
fit-margin-left="0"
fit-margin-right="0"
fit-margin-bottom="0">
<sodipodi:guide
position="47.649406,5.8374226"
orientation="0,1"
id="guide4567"
inkscape:locked="false" />
</sodipodi:namedview>
<linearGradient
id="b"
x2="0"
y2="45.166359"
gradientTransform="scale(2.258318,0.44280744)"
x1="0"
y1="-0.28392482"
gradientUnits="userSpaceOnUse">
<stop
offset="0"
stop-color="#bbb"
stop-opacity=".1"
id="stop2" />
<stop
offset="1"
stop-opacity=".1"
id="stop4" />
</linearGradient>
<clipPath
id="a">
<rect
width="102"
height="20"
rx="3"
id="rect7"
x="0"
y="0"
style="fill:#ffffff" />
</clipPath>
<path
sodipodi:nodetypes="sccssss"
inkscape:connector-curvature="0"
id="path4637"
d="M 80.55806,0 H 48 v 20 h 32.55806 c 1.87153,0 3.378212,-1.506683 3.378212,-3.378212 V 3.3782117 C 83.936272,1.5066824 82.42959,0 80.55806,0 Z"
style="opacity:1;vector-effect:none;fill:#0055d4;fill-opacity:1;stroke:none;stroke-width:1.4740175;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1;paint-order:stroke fill markers" />
<path
style="opacity:1;vector-effect:none;fill:#4d4d4d;fill-opacity:1;stroke:none;stroke-width:1.4740175;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1;paint-order:stroke fill markers"
d="M 3.3782117,0 H 49.936272 V 20 H 3.3782117 C 1.5066824,20 0,18.493317 0,16.621788 V 3.3782117 C 0,1.5066824 1.5066824,0 3.3782117,0 Z"
id="rect4634"
inkscape:connector-curvature="0"
sodipodi:nodetypes="sccssss" />
<rect
ry="3.3782117"
y="0"
x="4.6019753e-15"
height="20.137625"
width="83.946869"
id="rect4641"
style="opacity:1;vector-effect:none;fill:url(#linearGradient837);fill-opacity:1;stroke:none;stroke-width:1.4740175;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1;paint-order:stroke fill markers" />
<rect
style="opacity:1;vector-effect:none;fill:url(#linearGradient839);fill-opacity:1;stroke:none;stroke-width:1.4740175;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1;paint-order:stroke fill markers"
id="rect833"
width="83.946869"
height="20.137625"
x="4.6019753e-15"
y="0"
ry="3.3782117" />
<rect
ry="3.3782117"
y="0"
x="4.6019753e-15"
height="20.137625"
width="83.946869"
id="rect835"
style="opacity:1;vector-effect:none;fill:url(#linearGradient4625);fill-opacity:1;stroke:none;stroke-width:1.4740175;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1;paint-order:stroke fill markers" />
<g
id="g4591"
transform="translate(6.0000004,0.1778004)">
<text
id="text4551"
y="15.101547"
x="49.939278"
style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:11px;line-height:normal;font-family:'DejaVu Sans', Verdana, Geneva, sans-serif;-inkscape-font-specification:'DejaVu Sans, Verdana, Geneva, sans-serif, Normal';font-variant-ligatures:normal;font-variant-position:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-alternates:normal;font-feature-settings:normal;text-indent:0;text-align:start;text-decoration:none;text-decoration-line:none;text-decoration-style:solid;text-decoration-color:#000000;letter-spacing:normal;word-spacing:normal;text-transform:none;writing-mode:lr-tb;direction:ltr;text-orientation:mixed;dominant-baseline:auto;baseline-shift:baseline;text-anchor:start;white-space:normal;shape-padding:0;opacity:1;vector-effect:none;fill:#000000;fill-opacity:0.3;stroke:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1"
xml:space="preserve"><tspan
style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:11px;line-height:normal;font-family:'DejaVu Sans', Verdana, Geneva, sans-serif;-inkscape-font-specification:'DejaVu Sans, Verdana, Geneva, sans-serif, Normal';font-variant-ligatures:normal;font-variant-position:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-alternates:normal;font-feature-settings:normal;text-indent:0;text-align:start;text-decoration:none;text-decoration-line:none;text-decoration-style:solid;text-decoration-color:#000000;letter-spacing:normal;word-spacing:normal;text-transform:none;writing-mode:lr-tb;direction:ltr;text-orientation:mixed;dominant-baseline:auto;baseline-shift:baseline;text-anchor:start;white-space:normal;shape-padding:0;vector-effect:none;fill:#000000;fill-opacity:0.3;stroke:none;stroke-width:0.1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1"
y="15.101547"
x="49.939278"
id="tspan4549"
sodipodi:role="line">MIT</tspan></text>
<text
xml:space="preserve"
style="font-style:normal;font-weight:normal;font-size:40px;line-height:1.25;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#ffffff;fill-opacity:1;stroke:none"
x="59.774261"
y="14.119328"
id="text4547"><tspan
sodipodi:role="line"
id="tspan4545"
x="59.774261"
y="14.119328"
style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:11px;font-family:'DejaVu Sans', Verdana, Geneva, sans-serif;-inkscape-font-specification:'DejaVu Sans, Verdana, Geneva, sans-serif, Normal';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-feature-settings:normal;text-align:center;writing-mode:lr-tb;text-anchor:middle;fill:#ffffff">MIT</tspan></text>
</g>
<g
id="g4595"
transform="translate(3.9474745e-7,0.1778004)">
<text
x="245"
y="150"
transform="scale(0.1)"
textLength="370"
id="text18"
lengthAdjust="spacing"
style="font-size:110px;font-family:'DejaVu Sans', Verdana, Geneva, sans-serif;text-anchor:middle;fill:#010101;fill-opacity:0.3">license</text>
<text
x="245"
y="140"
transform="scale(0.1)"
textLength="370"
id="text20"
lengthAdjust="spacing"
style="font-size:110px;font-family:'DejaVu Sans', Verdana, Geneva, sans-serif;text-anchor:middle;fill:#ffffff">license</text>
</g>
</svg>

After

Width:  |  Height:  |  Size: 9.5 KiB

View file

@ -1,31 +1,77 @@
[![MIT License](https://raw.githubusercontent.com/roles-ansible/role-base/master/.github/license.svg?sanitize=true)](https://github.com/roles-ansible/role-base/blob/master/LICENSE)
Ansible Role to install packages
---------------------
This is an ansible role to install some basic packages, you could need.
It should work on the most linux operating systems. Maybe it need some minor adjustments.
A base ansible role that should run on common Linux systems.
If this is so, please create a pull request or at least creat an issue with what is broken!
This role adds more package sources to Debian. And installs some useful tools. This role adds more package sources to Debian. And installs some useful tools. The complete list of tools to install can be found in the [vars/main.yml](https://github.com/roles-ansible/role-base/blob/master/vars/main.yml).
### Testing:
This role was initial written for ``Debian 9`` and ``Fedora 29``.
In Spring 2019 it was only used on ``Debian 9``, ``Ubuntu 18.04 LTS`` and ``Ubuntu 19.4``. No ``RHEL`` based Systems anymore.
In Spring 2019 it was used on ``Debian 9``, ``Ubuntu 18.04 LTS``, ``Ubuntu 19.4`` and ``centos 7``.
In 2020 it expanded to more linux Systems such as ``Debian buster`` and ``Ubuntu 20.4 LTS``.
Optionally you can also set vim as the default editor and update all packages to ``latest''.
variables
-----------
There are some variables defined to configure the packages which should be installed.
### variables:
Please have a look into ``defaults/main.yml`` for more details.
For a complete overview of all variables have a deeper look into the ``vars`` nd the ``defaults`` Folder!.
You can configure your own packages via host- or group-vars to change what packages should be installed.
```yml
---
# install these additional packages
base__extra_packages: []
# - foo
# - bar
have fun! And don't be evil!
# should we add additional package source?
base__add_ethz: true
### Protip:
Packages are defined as variable in the ``vars`` Folder.
# add nonfree/firmware packages?
base__pkg_non_free_firmware: false
base__pkg_contrib: false
Open tasks
------------
- Some CI-Testing would be nice. Eg with docker and some common linux distributions.
# optionaly print some OS vars
base__print_os_vars: false
# choose latest or present for package state
# set this to latest for updating all packages!
base__package_state: 'present'
# should we update all packages?
base__upgrade_packages_to_latest_version: false
# perform a simple versions check (true is recomended)
submodules_versioncheck: false
```
### testing
This role is tested with [these github-action](https://github.com/search?q=topic%3Acheck-ansible+topic%3Agithub-actions+org%3Aroles-ansible&type=Repositories) tests for different versions of differen linux systems. Linting is tested via travis-ci and the [ansible-lint action](https://github.com/marketplace/actions/ansible-lint).
If you want to find out more about our tests, please have a look at the github marketplace.
| test status | Github Marketplace |
| :--------- | :---------------- |
| [![Travis Build Status](https://travis-ci.org/roles-ansible/role_base.svg?branch=master)](https://travis-ci.org/roles-ansible/role_base) | [.travis.yml](https://github.com/roles-ansible/role_base/blob/master/.travis.yml) |
|||
| [![Ansible Lint check](https://github.com/roles-ansible/role_base/workflows/Ansible%20Lint%20check/badge.svg)](https://github.com/roles-ansible/role_base/actions?query=workflow%3A%22Ansible+Lint+check%22) | [ansible-lint action](https://github.com/marketplace/actions/ansible-lint)
| [![Ansible check debian:stable](https://github.com/roles-ansible/role_base/workflows/Ansible%20check%20debian:stable/badge.svg)](https://github.com/roles-ansible/role_base/actions?query=workflow%3A%22Ansible+check+debian%3Astable%22) | [ansible test with debian stable](https://github.com/marketplace/actions/check-ansible-debian-stable) |
| [![Ansible check debian:latest](https://github.com/roles-ansible/role_base/workflows/Ansible%20check%20debian:latest/badge.svg)](https://github.com/roles-ansible/role_base/actions?query=workflow%3A%22Ansible+check+debian%3Alatest%22) | [ansible test with debian latest](https://github.com/marketplace/actions/check-ansible-debian-latest) |
| [![Ansible check debian:sid](https://github.com/roles-ansible/role_base/workflows/Ansible%20check%20debian:sid/badge.svg)](https://github.com/roles-ansible/role_base/actions?query=workflow%3A%22Ansible+check+debian%3Asid%22) | [ansible test with debian sid](https://github.com/marketplace/actions/check-ansible-debian-sid) |
| [![Ansible check debian:buster](https://github.com/roles-ansible/role_base/workflows/Ansible%20check%20debian:buster/badge.svg)](https://github.com/roles-ansible/role_base/actions?query=workflow%3A%22Ansible+check+debian%3Abuster%22) | [ansible test with debian buster](https://github.com/marketplace/actions/check-ansible-debian-buster) |
| [![Ansible check debian:stretch](https://github.com/roles-ansible/role_base/workflows/Ansible%20check%20debian:stretch/badge.svg)](https://github.com/roles-ansible/role_base/actions?query=workflow%3A%22Ansible+check+debian%3Astretch%22) | [ansible test with debian stretch](https://github.com/marketplace/actions/check-ansible-debian-stretch) |
| | |
| [![Ansible check archlinux:latest](https://github.com/roles-ansible/role_base/workflows/Ansible%20check%20archlinux:latest/badge.svg)](https://github.com/roles-ansible/role_base/actions?query=workflow%3A%22Ansible+check+archlinux%3Alatest%22) | [ansible test with archlinux latest](https://github.com/marketplace/actions/check-ansible-archlinux-latest) |
| | |
| [![Ansible check ubuntu:latest](https://github.com/roles-ansible/role_base/workflows/Ansible%20check%20ubuntu:latest/badge.svg)](https://github.com/roles-ansible/role_base/actions?query=workflow%3A%22Ansible+check+ubuntu%3Alatest%22) | [ansible test with ubuntu latest](https://github.com/marketplace/actions/check-ansible-ubuntu-latest) |
| [![Ansible check ubuntu:bionic](https://github.com/roles-ansible/role_base/workflows/Ansible%20check%20ubuntu:bionic/badge.svg)](https://github.com/roles-ansible/role_base/actions?query=workflow%3A%22Ansible+check+ubuntu%3Abionic%22) | [ansible test with ubuntu bionic](https://github.com/marketplace/actions/check-ansible-ubuntu-bionic) |
| [![Ansible check ubuntu:eoan](https://github.com/roles-ansible/role_base/workflows/Ansible%20check%20ubuntu:eoan/badge.svg)](https://github.com/roles-ansible/role_base/actions?query=workflow%3A%22Ansible+check+ubuntu%3Aeoan%22) | [ansible test with ubuntu eoan](https://github.com/marketplace/actions/check-ansible-ubuntu-eoan) |
| [![Ansible check ubuntu:trusty](https://github.com/roles-ansible/role_base/workflows/Ansible%20check%20ubuntu:trusty/badge.svg)](https://github.com/roles-ansible/role_base/actions?query=workflow%3A%22Ansible+check+ubuntu%3Atrusty%22) | [ansible test with ubuntu trusty](https://github.com/marketplace/actions/check-ansible-ubuntu-trusty) |
| [![Ansible check ubuntu:xenial](https://github.com/roles-ansible/role_base/workflows/Ansible%20check%20ubuntu:xenial/badge.svg)](https://github.com/roles-ansible/role_base/actions?query=workflow%3A%22Ansible+check+ubuntu%3Axenial%22) | [ansible test with ubuntu xenial](https://github.com/marketplace/actions/check-ansible-ubuntu-xenial) |
| | |
| [![Ansible check fedora:latest](https://github.com/roles-ansible/role_base/workflows/Ansible%20check%20fedora:latest/badge.svg)](https://github.com/roles-ansible/role_base/actions?query=workflow%3A%22Ansible+check+fedora%3Alatest%22) | [ansible test with fedora latest](https://github.com/marketplace/actions/check-ansible-fedora-latest) |
| [![Ansible check fedora:33](https://github.com/roles-ansible/role_base/workflows/Ansible%20check%20fedora:33/badge.svg)](https://github.com/roles-ansible/role_base/actions?query=workflow%3A%22Ansible+check+fedora%3A33%22) | [ansible test with fedora 33](https://github.com/marketplace/actions/check-ansible-fedora-33) |
| [![Ansible check fedora:32](https://github.com/roles-ansible/role_base/workflows/Ansible%20check%20fedora:32/badge.svg)](https://github.com/roles-ansible/role_base/actions?query=workflow%3A%22Ansible+check+fedora%3A32%22) | [ansible test with fedora 32](https://github.com/marketplace/actions/check-ansible-fedora-32) |
| [![Ansible check fedora:31](https://github.com/roles-ansible/role_base/workflows/Ansible%20check%20fedora:31/badge.svg)](https://github.com/roles-ansible/role_base/actions?query=workflow%3A%22Ansible+check+fedora%3A31%22) | [ansible test with fedora 31](https://github.com/marketplace/actions/check-ansible-fedora-31) |
| | |
| [![Ansible check centos:latest](https://github.com/roles-ansible/role_base/workflows/Ansible%20check%20centos:latest/badge.svg)](https://github.com/roles-ansible/role_base/actions?query=workflow%3A%22Ansible+check+centos%3Alatest%22) | [ansible test with centos latest](https://github.com/marketplace/actions/check-ansible-centos-latest) |
| [![Ansible check centos:centos8](https://github.com/roles-ansible/role_base/workflows/Ansible%20check%20centos:centos8/badge.svg)](https://github.com/roles-ansible/role_base/actions?query=workflow%3A%22Ansible+check+centos%3Acentos8%22) | [ansible test with centos centos8](https://github.com/marketplace/actions/check-ansible-centos-centos8) |
| [![Ansible check centos:centos7](https://github.com/roles-ansible/role_base/workflows/Ansible%20check%20centos:centos7/badge.svg)](https://github.com/roles-ansible/role_base/actions?query=workflow%3A%22Ansible+check+centos%3Acentos7%22) | [ansible test with centos centos7](https://github.com/marketplace/actions/check-ansible-centos-centos7) |
| | |
| [![Ansible check alpine:latest](https://github.com/roles-ansible/role_base/workflows/Ansible%20check%20alpine:latest/badge.svg)](https://github.com/roles-ansible/role_base/actions?query=workflow%3A%22Ansible+check+alpine%3Alatest%22) | [ansible test with alpine latest](https://github.com/marketplace/actions/check-ansible-alpine-latest) |

View file

@ -43,4 +43,4 @@ base_pkg_non_free_firmware: false
base_pkg_contrib: false
# version management
submodules_versioncheck: true
submodules_versioncheck: false