From be8e73dc5d008a1373d931078c5ab9c200f42113 Mon Sep 17 00:00:00 2001 From: Sangelo Date: Sat, 6 Jan 2024 18:44:25 +0100 Subject: [PATCH] New Readme --- README.md | 98 ++++++++++++++++++++++++++++++++++++++++++++++- docs/img/logo.svg | 22 +++++++++++ 2 files changed, 118 insertions(+), 2 deletions(-) create mode 100644 docs/img/logo.svg diff --git a/README.md b/README.md index 80daadd..80f7583 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,97 @@ -# Ansible Collection - lunivity.common +
-Documentation for the collection. +# Ansible Collection - Common + +[![License - GPLv3](https://img.shields.io/badge/License-GPLv3-2ea44f)](./LICENSE.md) + +## Table of Contents + +- [Table of Contents](#table-of-contents) +- [Introduction](#introduction) +- [Getting Started](#getting-started) + - [Dependencies](#dependencies) + - [Installation](#installation) + - [Using Command Line Interface (CLI)](#using-command-line-interface-cli) + - [Using a Requirements File](#using-a-requirements-file) + - [Usage](#usage) +- [Additional Documentation](#additional-documentation) +- [About](#about) +- [Contributions](#contributions) +- [License](#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: + +```bash +# install collection from source +$ ansible-galaxy collection install git+https://gitpot.dev/lunivity/ansible-common.git + +# install collection from tagged release 1.0.0 (currently unavailable) +$ ansible-galaxy collection install git+https://gitpot.dev/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: + +```yaml + collections: + - name: https://gitpot.dev/lunivity/ansible-common.git + type: git + version: latest +``` + +- Install the collection by running the following command in your workspace: + +```bash +ansible-galaxy collection install -r /path/to/requirements.yml +``` + +### Usage + +- To use the collection in your Ansible playbooks, include it like this: + +```yaml +--- +- name: Example Playbook + hosts: localhost + tasks: + - name: Include role from Lunivity + import_role: + name: lunivity.common. +``` + +## Additional Documentation + +For more detailed documentation, including advanced usage and customization options, please refer to the [docs](https://wiki.lunivity.com/docs/ansible/common/). + +## About + +**Author:** [Sangelo](https://sangelo.space) + +**Creation date:** January 06, 2024 + +## Contributions + +You're welcome to contribute to this website if you have a Lunivity account (see Gitpot's [homepage](https://gitpot.dev) for details if registrations aren't open yet). + +## License + +This project is licensed under the [GNU General Public License v3.0 (GPL-3.0)](./LICENSE.md). Refer to the [LICENSE](./LICENSE.md) file for more details. diff --git a/docs/img/logo.svg b/docs/img/logo.svg new file mode 100644 index 0000000..148abab --- /dev/null +++ b/docs/img/logo.svg @@ -0,0 +1,22 @@ + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file