https://github.com/origox/ansible_role_xyz

An Ansible role template
https://github.com/origox/ansible_role_xyz

Last synced: about 1 month ago
JSON representation

An Ansible role template

• Host: GitHub
• URL: https://github.com/origox/ansible_role_xyz
• Owner: origox
• Created: 2022-07-25T14:11:46.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-07-26T08:38:21.000Z (over 2 years ago)
• Last Synced: 2023-04-04T08:07:33.424Z (over 1 year ago)
• Size: 12.7 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Ansible role: ansible_role_XYZ

[![CI](https://github.com/origox/ansible_role_XYZ/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/origox/ansible_role_XYZ/actions/workflows/ci.yml)

An Ansible role that install and configure XYZ

## Intial Setup after using template repo

1. Perform initial setup after using this template repo

Run from cmdline `grep -irl XYZ --exclude-dir=venv . | xargs sed -i 's/XYZ/git/gI'`

Note, replace NAME_OF_ROLE with your new name of Ansible role

2. Update tasks for actual configuration of new role.

3. Add needed directories

   - templates # i.e. jinja templates

   - meta, vars, ... 

4. Adapt readme file to new role 

5. Remove this chapter since it belongs only to creation phase of a new role. 

## Development and local test of new role

```bash

# Setup virtual environment

$ python3 -m pip install venv

$ source venv/bin/activate

$ python3 -m pip install -r requirements.txt

# YAML Lint

$ yamllint .

# Ansible lint

$ ansible-lint

# Molecule

$ molecule test

```

## Requirements

None.

## Role Default Variables

Available variables are listed below, along with default values (see `defaults/main.yml`):

    XYZ_config:

      :

        : 

## Dependencies

None.

## Example Playbook

    - hosts: all

      roles:

        - role: 

            src: https://github.com/origox/ansible_role_XYZ