Skip to content

3A2DEV/ans2dev.general

Repository files navigation

3A2DEV General Collection for Ansible

collection automation galaxy module roles

collection-release Ansible Collection Version Ansible Collection Downloads

CI extra-docs Codecov

Website

This repository contains the ans2dev.general Ansible Collection and includes some modules and plugins supported by 3A2DEV which are not part of more specialized collections.

All documentation is avaible on Ansible Galaxy( latest ) and Ansible Documentation( devel )

Code of Conduct

Although this collection is not part of the Ansible community, we adhere to their Code of Conduct for a better experience for everyone.

We follow the Ansible Code of Conduct in all our interactions within this project.

If you encounter abusive behavior, please refer to the policy violations section of the Code for information on how to raise a complaint.

Contributing to this collection

Don't know how to start? Refer to the Ansible community guide!

Want to submit code changes? Take a look at the Quick-start development guide.

We also use the following guidelines:

Collection maintenance

The current maintainers are listed in the MAINTAINERS file. If you have questions or need help, feel free to mention them in the proposals.

Governance

The process of decision making in this collection is based on discussing and finding consensus among participants.

Every voice is important. If you have something on your mind, create an issue or dedicated discussion and let's discuss it!

Tested with Ansible

Tested with the current ansible-core 2.17 and ansible-core 2.18 releases and the current development version of ansible-core. Ansible-core versions before 2.16.0 are not supported. This includes all ansible-base 2.10 and Ansible 2.9 releases.

Ansible Integration tests olso run on Official Docker Image and ansible-core 2.18:

  • alpine320 + Python 3.12
  • fedora40 + Python 3.12
  • ubuntu2204 + Python 3.10
  • ubuntu2404 + Python 3.12

External requirements

Some modules and plugins require external libraries. Please check the requirements for each plugin or module you use in the documentation to find out which requirements are needed.

Included content

Please check the included content on the Ansible Galaxy page for this collection

Using this collection

Installing the Collection from Ansible Galaxy

Before using this collection, you need to install it with the Ansible Galaxy command-line tool:

ansible-galaxy collection install ans2dev.general

You can also include it in a requirements.yml file and install it with ansible-galaxy collection install -r requirements.yml, using the format:

---
collections:
  - name: ans2dev.general

Note that if you install the collection from Ansible Galaxy, it will not be upgraded automatically when you upgrade the ansible package. To upgrade the collection to the latest available version, run the following command:

ansible-galaxy collection install ans2dev.general --upgrade

You can also install a specific version of the collection, for example, if you need to downgrade when something is broken in the latest version (please report an issue in this repository). Use the following syntax to install version 0.1.0:

ansible-galaxy collection install ans2dev.general:==0.1.0

See using Ansible collections for more details.

You can olso install all python dependencies via role:

  - name: Install Dependencies on CN
    hosts: all
    gather_facts: no
    roles:
      - role: ans2dev.general.install_dep
  # install in pre_tasks with become: false
  - name: Install Dependencies on CN
    hosts: all
    gather_facts: no

    pre_tasks:

      - name: install dependencies
        block:
          - include_role:
              name: ans2dev.general.install_dep
        become: false

Release notes

See the changelog.

Roadmap

Licensing

GNU General Public License v3.0 or later.

See LICENSE to see the full text.