Initial Ansible Docs
This commit is contained in:
parent
bcfe588de5
commit
55fb5560fd
9 changed files with 221 additions and 10 deletions
|
@ -1,4 +1,14 @@
|
||||||
+++
|
+++
|
||||||
title = 'Ansible'
|
title = 'Ansible'
|
||||||
date = 2024-01-09T19:48:22+01:00
|
date = 2024-01-09T19:48:22+01:00
|
||||||
|
|
||||||
|
next = "/docs/ansible/core"
|
||||||
+++
|
+++
|
||||||
|
|
||||||
|
The documentation for our Ansible Roles and Playbooks.
|
||||||
|
|
||||||
|
{{< cards >}}
|
||||||
|
{{< card link="/docs/ansible/core" title="Ansible: Core" subtitle="Core automation utilities that are used in the deployment of various Lunivity Circle Services." icon="cog" >}}
|
||||||
|
{{< card link="/docs/ansible/common" title="Ansible: Common" subtitle="Core automation utilities that are used in the deployment of various Lunivity Circle Services." icon="user-group" >}}
|
||||||
|
{{< card link="/docs/ansible/services" title="Ansible: Services" subtitle="Collection of roles and playbooks directly used to deploy a Lunivity Circle Service." icon="server" >}}
|
||||||
|
{{< /cards >}}
|
||||||
|
|
|
@ -1,5 +0,0 @@
|
||||||
+++
|
|
||||||
title = 'Ansible: Common'
|
|
||||||
linkTitle = 'Common'
|
|
||||||
date = 2024-01-09T19:49:13+01:00
|
|
||||||
+++
|
|
92
content/docs/ansible/common/_index.md
Normal file
92
content/docs/ansible/common/_index.md
Normal file
|
@ -0,0 +1,92 @@
|
||||||
|
+++
|
||||||
|
title = 'Ansible: Common'
|
||||||
|
linkTitle = 'Common'
|
||||||
|
date = 2024-01-09T19:49:13+01:00
|
||||||
|
next = "/docs/ansible/services"
|
||||||
|
prev = "/docs/ansible/core"
|
||||||
|
weight = 2
|
||||||
|
+++
|
||||||
|
|
||||||
|
{{< 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 `common` automation utilities that are used in the deployment of various Lunivity Circle Services.<br>
|
||||||
|
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
|
||||||
|
|
||||||
|
{{< 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-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
|
||||||
|
```
|
||||||
|
|
||||||
|
{{< /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-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
|
||||||
|
```
|
||||||
|
|
||||||
|
{{< /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.common.<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.
|
|
@ -1,5 +0,0 @@
|
||||||
+++
|
|
||||||
title = 'Ansible: Core'
|
|
||||||
linkTitle = 'Core'
|
|
||||||
date = 2024-01-09T19:48:35+01:00
|
|
||||||
+++
|
|
92
content/docs/ansible/core/_index.md
Normal file
92
content/docs/ansible/core/_index.md
Normal file
|
@ -0,0 +1,92 @@
|
||||||
|
+++
|
||||||
|
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.
|
11
content/docs/ansible/services.md
Normal file
11
content/docs/ansible/services.md
Normal file
|
@ -0,0 +1,11 @@
|
||||||
|
+++
|
||||||
|
title = 'Ansible: Services'
|
||||||
|
linkTitle = 'Services'
|
||||||
|
date = 2024-01-09T22:39:54+01:00
|
||||||
|
prev = "/docs/ansible/common"
|
||||||
|
weight = 3
|
||||||
|
+++
|
||||||
|
|
||||||
|
{{< 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 >}}
|
4
content/guides/ssh/_index.md
Normal file
4
content/guides/ssh/_index.md
Normal file
|
@ -0,0 +1,4 @@
|
||||||
|
+++
|
||||||
|
title = 'SSH'
|
||||||
|
date = 2024-01-09T22:08:21+01:00
|
||||||
|
+++
|
|
@ -1,4 +1,12 @@
|
||||||
+++
|
+++
|
||||||
title = 'Services'
|
title = 'Services'
|
||||||
|
linkTitle = 'Services'
|
||||||
date = 2024-01-09T19:51:47+01:00
|
date = 2024-01-09T19:51:47+01:00
|
||||||
+++
|
+++
|
||||||
|
|
||||||
|
Documentation for our deployed Services
|
||||||
|
|
||||||
|
{{< cards >}}
|
||||||
|
{{< card link="/services/authentik" title="Authentik" subtitle="Your one stop shop all things Login!" icon="user" >}}
|
||||||
|
<!-- {{< card link="/" title="No Icon" >}} -->
|
||||||
|
{{< /cards >}}
|
||||||
|
|
4
content/services/authentik/_index.md
Normal file
4
content/services/authentik/_index.md
Normal file
|
@ -0,0 +1,4 @@
|
||||||
|
+++
|
||||||
|
title = 'Authentik'
|
||||||
|
date = 2024-01-09T22:07:42+01:00
|
||||||
|
+++
|
Loading…
Reference in a new issue