ansible-common/README.md

Ansible Collection - Common

Table of Contents

• Table of Contents
• Introduction
• Getting Started
  • Dependencies
  • Installation
    • Using Command Line Interface (CLI)
    • Using a Requirements File
  • Usage
• Additional Documentation
• About
• Contributions
• License

Introduction

This collection includes common automation utilities that are used in the deployment of various Lunivity Circle Services.
Common utilities include any kinds of roles and playbooks that are responsible for the initial setup of a host.

Getting Started

Dependencies

Before you begin, ensure you have the following prerequisites:

• Ansible installed on your ansible host.

Installation

Using Command Line Interface (CLI)

• To install this Ansible collection using the CLI, follow these steps:

# install collection from source
$ ansible-galaxy collection install git+https://gitpot.org/lunivity/ansible-common.git

# install collection from tagged release 1.0.0 (currently unavailable)
$ ansible-galaxy collection install git+https://gitpot.org/lunivity/ansible-common.git,1.0.0

Using a Requirements File

1. Create a file named requirements.yml in your workspace.
2. Add the following content to your requirements.yml file:

 collections:
  - name: https://gitpot.org/lunivity/ansible-common.git
    type: git
    version: latest

• Install the collection by running the following command in your workspace:

ansible-galaxy collection install -r /path/to/requirements.yml

Usage

• To use the collection in your Ansible playbooks, include it like this:

---
- name: Example Playbook
  hosts: localhost
  tasks:
    - name: Include role from Lunivity
      import_role:
        name: lunivity.common.<role>

Additional Documentation

For more detailed documentation, including advanced usage and customization options, please refer to the docs.

About

Author: Sangelo

Creation date: January 06, 2024

Contributions

You're welcome to contribute to this Ansible Collection if you have a Lunivity account (see Gitpot's homepage for details if registrations aren't open yet).

License

This project is licensed under the GNU General Public License v3.0 (GPL-3.0). Refer to the LICENSE file for more details.