Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/wayofdev/ansible-role-tpl

Ansible template for wayofdev roles.
https://github.com/wayofdev/ansible-role-tpl

ansible ansible-molecule ansible-role ansible-role-skeleton automation linux macos molecule

Last synced: about 2 months ago
JSON representation

Ansible template for wayofdev roles.

Host: GitHub
URL: https://github.com/wayofdev/ansible-role-tpl
Owner: wayofdev
License: gpl-3.0
Created: 2022-05-15T19:12:58.000Z (over 2 years ago)
Default Branch: master
Last Pushed: 2022-07-08T12:51:07.000Z (over 2 years ago)
Last Synced: 2023-03-04T01:07:53.768Z (almost 2 years ago)
Topics: ansible, ansible-molecule, ansible-role, ansible-role-skeleton, automation, linux, macos, molecule
Language: Makefile
Homepage: https://wayof.dev
Size: 132 KB
Stars: 7
Watchers: 0
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

README

        





































# Ansible Role: Template

This is template, that is used to create roles for wayofdev project.

If you **like/use** this role, please consider **starring** it. Thanks!




## 🗂 Table of Contents

   * [Directory Tree for Project](#-directory-tree-for-project)

   * [IDE Support](#-ide-support)

   * [Requirements](#-requirements)

   * [Role Variables](#-role-variables)

      * [Structure](#-structure)

   * [Example Playbook](#-example-playbook)

   * [Development](#-development)

   * [Testing](#-testing)

      * [on localhost](#-on-localhost)

      * [over SSH](#-over-ssh)

   * [Dependencies](#-dependencies)

      * [for all](#-for-all)

      * [only macOS](#-only-macos)

      * [only Linux](#-only-linux)

   * [Compatibility](#-compatibility)

   * [License](#-license)

   * [Author Information](#-author-information)

   * [Credits and Resources](#-credits-and-resources)

   * [Contributors](#-contributors)




## 🌳 Directory Tree for Project

Repository uses default structure, sugested by [Ansible Documentation](https://docs.ansible.com/ansible/latest/user_guide/playbooks_reuse_roles.html)

```

├── 📄 Makefile

├── 📄 README.md

├── 🗂 assets

├── 🗂 contrib

│   └── poetry-bin

├── 🗂 defaults

│   └── 📄 main.yml

├── 🗂 files

├── 🗂 handlers

│   └── 📄 main.yml

├── 🗂 meta

│   └── 📄 main.yml

├── 🗂 molecule

│   ├── 🗂 _partials

│   │   ├── 🗂 playbooks

│   │   │   ├── 📄 converge.yml

│   │   │   ├── 🗂 defaults

│   │   │   └── 📄 verify.yml

│   │   ├── 📄 ssh_config

│   │   ├── 🗂 tasks

│   │   │   └── 📄 setup.yml

│   │   └── 🗂 vars

│   │       └── 📄 main.yml

│   ├── 🗂 default

│   │   └── 📄 molecule.yml

│   ├── 🗂 default-macos-on-localhost

│   │   └── 📄 molecule.yml

│   └── 🗂 default-macos-over-ssh

│       └── 📄 molecule.yml

├── 📄 pyproject.toml

├── 📄 requirements.yml

├── 🗂 tasks

│   └── 📄 main.yml

├── 🗂 templates

└── 🗂 vars

    └── 📄 main.yml

```




## 👨‍💻 IDE Support

Jetbrains products has great ansible language support together with [OrchidE plugin](https://plugins.jetbrains.com/plugin/12626-orchide--ansible-language-support).

> :warning: **Notice**: For ansible language support and autocompletion with [OrchidE](https://www.orchide.dev/pages/dokumentation) following additional `File Type Patterns` should be added.

Open Preferences → Languages & Frameworks → OrchidE → File Type Patterns:

| Ansible Type | Regex Pattern                 | Pattern Type |

| ------------ | ----------------------------- | ------------ |

| RoleTask     | `.*/tasks/.*\.ya?ml`          | Include      |

| RoleTask     | `.*/handlers/.*\.ya?ml`       | Include      |

| Variable     | `.*/tests/defaults/.*\.ya?ml` | Include      |

| Variable     | `.*/defaults/.*\.ya?ml`       | Include      |

| Variable     | `.*/meta/.*\.ya?ml`           | Include      |

| Variable     | `.*/vars/.*\.ya?ml`           | Include      |




## 📑 Requirements

* Up-to-date version of ansible. During maintenance/development, we stick to ansible versions and will use new features if they are available (and update `meta/main.yml` for the minimum version).

* Compatible OS. See [compatibility](#-compatibility) table.

* Role has dependencies on third-party roles on different operating systems. See `requirements.yml` and [dependencies](#-dependencies) section.




## 🔧 Role Variables

Available variables are listed below, along with example values (see `defaults/main.yml`). Additional variables are stored in `vars/main.yml`.




### → Structure

```yaml

---

tpl_key: value

```




## 📗 Example Playbook

```yaml

---

- hosts: all

  connection: local

  vars:

    tpl_key: value

  roles:

    - wayofdev.homebrew

    - wayofdev.tpl

```




## ⚙️ Development

To install dependencies and start development you can check contents of our `Makefile`

**Install** [poetry](https://github.com/python-poetry/poetry) using [poetry-bin](https://github.com/gi0baro/poetry-bin) and all dev python dependencies:

```bash

$ make install

```

**Install** only python dependencies, assuming that you already have poetry:

```bash

$ make install-deps

```

**Install** all git hooks:

```bash

$ make hooks

```

**Lint** all role files:

```bash

$ make lint

```




## 🧪 Testing

You can check `Makefile` to get full list of commands for remote and local testing. For local testing you can use these comands to test whole role or separate tasks:

### → on localhost

> :warning: **Notice**: By defaut all tests are ran against your local machine!

```bash

# run molecule tests on localhost

$ poetry run molecule test --scenario-name default-macos-on-localhost -- -vvv

# or with make command

$ make m-local

# choose which tags will be included

$ export TASK_TAGS="tpl-install,tpl-update"; make m-local

# runs molecule with docker driver

$ poetry run molecule test --scenario-name default -- -vvv

# or with make file

$ make m-linux

```




### → over SSH

```bash

# run molecule scenarios against remote machines over SSH

# this will need VM setup and configuration

$ poetry run molecule test --scenario-name default-macos-over-ssh -- -vvv

$ make m-remote

# tags also can be passed

$ export TASK_TAGS="tpl-install,tpl-update"

$ make m-remote

```




## 📦 Dependencies

Installation handled by `Makefile` and requirments are defined in `requirements.yml`

### → for all

  - [ansible.community.general](https://docs.ansible.com/ansible/latest/collections/community/general/index.html)

### → only macOS

  - [elliotweiser.osx-command-line-tools](https://galaxy.ansible.com/elliotweiser/osx-command-line-tools/)

  - [wayofdev.homebrew](https://galaxy.ansible.com/wayofdev/homebrew)

### → only Linux

  - [geerlingguy.git](https://galaxy.ansible.com/geerlingguy/git)




## 🧩 Compatibility

This role has been tested on these systems:

| system / container | tag      |

| :----------------- | -------- |

| macos              | monterey |

| macos              | big-sur  |

| ubuntu             | jammy    |

| ubuntu             | focal    |

| debian             | bullseye |

| debian             | buster   |

| fedora             | 36       |

| fedora             | 35       |

| centos             | 8        |

| centos             | 7        |




## 🤝 License

[![Licence](https://img.shields.io/github/license/wayofdev/ansible-role-tpl.svg?style=for-the-badge&color=blue)](./LICENSE)




## 🙆🏼‍♂️ Author Information

This role was created in **2022** by [lotyp / wayofdev](https://github.com/wayofdev).




## 🧱 Credits and Resources

**Inspired by:**

* Some resources goes here if needed...




## 🫡 Contributors