constrict0r / aptitude Goto Github PK

Ansible role to use as a wrapper for apt to manage packages.

Full documentation on Readthedocs.

Source code on:

Github.

Gitlab.

Part of:

Ingredients

• Description
• Usage

• Variables

  • packages
  • packages_purge
  • configuration

• YAML

• Attributes

  • item_expand
  • item_path

• Requirements
• Compatibility
• License
• Links

• UML

  • Deployment
  • Main

• Author

Ansible role to use as a wrapper for apt to manage packages.

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 packages_purge variable is defined, purge the packages

  listed on it.

• If the configuration variable is defined, purge the

  packages_purge listed on it.

• If the packages variable is defined, install the packages

  listed on it.

• If the configuration variable is defined, install the packages

  listed on it.

• To install and execute:

ansible-galaxy install constrict0r.aptitude
ansible localhost -m include_role -a name=constrict0r.aptitude -K

• Passing variables:

ansible localhost -m include_role -a name=constrict0r.aptitude -K \
    -e "{packages: [gedit, rolldice]}"

• To include the role on a playbook:

- hosts: servers
  roles:
      - {role: constrict0r.aptitude}

• To include the role as dependency on another role:

dependencies:
  - role: constrict0r.aptitude
    packages: [gedit, rolldice]

• To use the role from tasks:

- name: Execute role task.
  import_role:
    name: constrict0r.aptitude
  vars:
    packages: [gedit, rolldice]

To run tests:

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

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

The following variables are supported:

List of packages to install via apt.

This list can be modified by passing a packages array when including the role on a playbook or via –extra-vars from a terminal.

This variable is empty by default.

# Including from terminal.
ansible localhost -m include_role -a name=constrict0r.aptitude -K -e \
    "{packages: [gedit, rolldice]}"

# Including on a playbook.
- hosts: servers
  roles:
    - role: constrict0r.aptitude
      packages:
        - gedit
        - rolldice

# To a playbook from terminal.
ansible-playbook -i inventory my-playbook.yml -K -e \
    "{packages: [gedit, rolldice]}"

List of packages to purge using apt.

This list can be modified by passing a packages_purge array when including the role on a playbook or via –extra-vars from a terminal.

This variable is empty by default.

# Including from terminal.
ansible localhost -m include_role -a name=constrict0r.aptitude -K -e \
    "{packages_purge: [gedit, rolldice]}"

# Including on a playbook.
- hosts: servers
  roles:
    - role: constrict0r.aptitude
      packages_purge:
        - gedit
        - rolldice

# To a playbook from terminal.
ansible-playbook -i inventory my-playbook.yml -K -e \
    "{packages_purge: [gedit, rolldice]}"

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.aptitude -K -e \
    "configuration=/home/username/my-config.yml"

# Using URL.
ansible localhost -m include_role -a name=constrict0r.aptitude -K -e \
    "configuration=https://my-url/my-config.yml"

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

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:

---
packages:
  - [gedit, rolldice]

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

---
packages: /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.

On the item level you can use attributes to configure how this role handles the items data.

The attributes supported by this role are:

Boolean value indicating if treat this item as a file path or URL or just treat it as plain text.

---
packages:
  - item_expand: true
    item_path: /home/username/my-config.yml

Absolute file path or URL to a .yml file.

---
packages:
  - item_path: /home/username/my-config.yml

This attribute also works with URLs.

• Ansible >= 2.8.
• Jinja2.
• Pip.
• Python.
• PyYAML.
• Requests.

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

• Docker.
• Molecule.
• Setuptools.

• Debian Buster.
• Debian Raspbian.
• Debian Stretch.
• Ubuntu Xenial.

MIT. See the LICENSE file for more details.

• Github.
• Gitlab.
• Gitlab CI.
• Readthedocs.
• Travis CI.

The full project structure is shown below:

The project data flow is shown below:

The Travelling Vaudeville Villain.

Enjoy!!!