constrict0r.upgrade

upgrade


.. image:: https://gitlab.com/constrict0r/upgrade/badges/master/pipeline.svg :alt: pipeline

.. image:: https://travis-ci.com/constrict0r/upgrade.svg :alt: travis

.. image:: https://readthedocs.org/projects/upgrade/badge :alt: readthedocs

Ansible role to apply a system upgrade.

.. image:: https://gitlab.com/constrict0r/img/raw/master/upgrade/avatar.png :alt: avatar

Full documentation on Readthedocs <https://upgrade.readthedocs.io>_.

Source code on:

Github <https://github.com/constrict0r/upgrade>_.

Gitlab <https://gitlab.com/constrict0r/upgrade>_.

Part of: <https://gitlab.com/explore/projects?tag=doombot>_

.. image:: https://gitlab.com/constrict0r/img/raw/master/upgrade/doombot.png :alt: doombot

Ingredients

.. image:: https://gitlab.com/constrict0r/img/raw/master/upgrade/ingredient.png :alt: ingredient

Contents


  • Description <#Description>_
  • Usage <#Usage>_
  • Variables <#Variables>_
    • upgrade <#upgrade>_
    • configuration <#configuration>_
  • YAML <#YAML>_
  • Requirements <#Requirements>_
  • Compatibility <#Compatibility>_
  • License <#License>_
  • Links <#Links>_
  • UML <#UML>_
    • Deployment <#deployment>_
    • Main <#main>_
  • Author <#Author>_

Description


Ansible role to apply a system upgrade.

This role performs the following actions:

  • Ensure the requirements are installed.

  • Ensure the current user can obtain administrative (root) permissions.

  • Update the apt cache.

  • If the upgrade variable is set to true or if the configuration file contains a variable upgrade setted to true, perform a full system upgrade.

Usage


  • To install and execute:

..

::

  ansible-galaxy install constrict0r.upgrade
  ansible localhost -m include_role -a name=constrict0r.upgrade -K
  • Passing variables:

..

::

  ansible localhost -m include_role -a name=constrict0r.upgrade -K \
      -e "upgrade: false"
  • To include the role on a playbook:

..

::

  - hosts: servers
    roles:
        - {role: constrict0r.upgrade}
  • To include the role as dependency on another role:

..

::

  dependencies:
    - role: constrict0r.upgrade
      upgrade: true
  • To use the role from tasks:

..

::

  - name: Execute role task.
    import_role:
      name: constrict0r.upgrade
    vars:
      upgrade: true

To run tests:

::

cd upgrade chmod +x testme.sh ./testme.sh

On some tests you may need to use sudo to succeed.

Variables


The following variables are supported:

upgrade

Boolean variable that defines if a system full upgrade is performed or not.

If set to true a full system upgrade is executed.

This variable is set to true by default.

::

Including from terminal.

ansible localhost -m include_role -a name=constrict0r.upgrade -K -e
"upgrade=false"

Including on a playbook.

  • hosts: servers roles:
    • role: constrict0r.upgrade upgrade: false

To a playbook from terminal.

ansible-playbook -i inventory my-playbook.yml -K -e
"upgrade=false"

configuration

Absolute file path or URL to a .yml file that contains all or some of the variables supported by this role.

It is recommended to use a .yml or .yaml extension for the configuration file.

This variable is empty by default.

::

Using file path.

ansible localhost -m include_role -a name=constrict0r.upgrade -K -e
"configuration=/home/username/my-config.yml"

Using URL.

ansible localhost -m include_role -a name=constrict0r.upgrade -K -e
"configuration=https://my-url/my-config.yml"

To see how to write a configuration file see the YAML file format section.

YAML


When passing configuration files to this role as parameters, it’s recommended to add a .yml or .yaml extension to the each file.

It is also recommended to add three dashes at the top of each file:

::


You can include in the file the variables required for your tasks:

::


upgrade: - true

If you want this role to load list of items from files and URLs you can set the expand variable to true:

::


upgrade: /home/username/my-config.yml

expand: true

If the expand variable is false, any file path or URL found will be treated like plain text.

Requirements


  • Ansible <https://www.ansible.com>_ >= 2.8.

  • Jinja2 <https://palletsprojects.com/p/jinja/>_.

  • Pip <https://pypi.org/project/pip/>_.

  • Python <https://www.python.org/>_.

  • PyYAML <https://pyyaml.org/>_.

  • Requests <https://2.python-requests.org/en/master/>_.

If you want to run the tests, you will also need:

  • Docker <https://www.docker.com/>_.

  • Molecule <https://molecule.readthedocs.io/>_.

  • Setuptools <https://pypi.org/project/setuptools/>_.

Compatibility


  • Debian Buster <https://wiki.debian.org/DebianBuster>_.

  • Debian Raspbian <https://raspbian.org/>_.

  • Debian Stretch <https://wiki.debian.org/DebianStretch>_.

  • Ubuntu Xenial <http://releases.ubuntu.com/16.04/>_.

License


MIT. See the LICENSE file for more details.

Links


  • Github <https://github.com/constrict0r/upgrade>_.

  • Gitlab <https://gitlab.com/constrict0r/upgrade>_.

  • Gitlab CI <https://gitlab.com/constrict0r/upgrade/pipelines>_.

  • Readthedocs <https://upgrade.readthedocs.io>_.

  • Travis CI <https://travis-ci.com/constrict0r/upgrade>_.

UML


Deployment

The full project structure is shown below:

.. image:: https://gitlab.com/constrict0r/img/raw/master/upgrade/deploy.png :alt: deploy

Main

The project data flow is shown below:

.. image:: https://gitlab.com/constrict0r/img/raw/master/upgrade/main.png :alt: main

Author


.. image:: https://gitlab.com/constrict0r/img/raw/master/upgrade/author.png :alt: author

The Travelling Vaudeville Villain.

Enjoy!!!

.. image:: https://gitlab.com/constrict0r/img/raw/master/upgrade/enjoy.png :alt: enjoy

Install
ansible-galaxy install constrict0r.upgrade
GitHub repository
License
mit
Downloads
2k
Owner
The Traveling Vaudeville Villain Gitlab: gitlab.com/constrict0r - Blog: geekl0g.wordpress.com - Twitter: twitter.com/constrict0r - Functional Café: is.gd/YDqy