wiki/content/docs/ansible/core/_index.md

93 lines
2.5 KiB
Markdown
Raw Normal View History

2024-01-09 22:07:43 +00:00
+++
title = 'Ansible: Core'
linkTitle = 'Core'
date = 2024-01-09T19:48:35+01:00
next = "/docs/ansible/common"
prev = "/docs/ansible"
weight = 1
+++
{{< callout type="warning" >}}
**Note**: The documentation for this collection may currently be incomplete or even out of date. This collection is still a WIP, expect bugs and other issues arising.
{{< /callout >}}
## Introduction
This collection includes `core` automation utilities that are used in the deployment of various Lunivity Circle Services.<br>
Core utilities include any kinds of roles and playbooks that are responsible for installing dependencies for services, or other general automations.
## Getting Started
### Dependencies
Before you begin, ensure you have the following prerequisites:
- `Ansible` installed on your ansible host.
### Installation
{{< tabs items="CLI,requirements.yml" >}}
{{< tab >}}
**Using Command Line Interface (CLI):**
```bash
# install collection from source
$ ansible-galaxy collection install git+https://gitpot.dev/lunivity/ansible-core.git
# install collection from tagged release 1.0.0 (currently unavailable)
$ ansible-galaxy collection install git+https://gitpot.dev/lunivity/ansible-core.git,1.0.0
```
{{< /tab >}}
{{< tab >}}
**Using a** `requirements.yml` **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-core.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
```
{{< /tab >}}
{{< /tabs >}}
### 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.core.<role>
```
## Advanced Usage
There are multiple roles included in this collection. To view their advanced usage options, visit one of the cards below.
## Repository
You can find this project's repository [here](https://gitpot.dev/lunivity/ansible-core).
### 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.