Getting Started

Installation

Requirements

• Ansible installed on your computer (A control node, see the Ansible docs for help)
• SSH access to your homelab server that has Docker installed. Currently, the following operating systems have been tested (older versions and other OSs may work, but most testing occurs on Ubuntu):
  • Ubuntu 24.04 LTS+
  • Debian 13+
  • Fedora 42+

Tip

A second computer is optional, you can orchestrate containers on your local machine if you wish.

Installation

1. Clone the repository to your local machine:

   git clone https://github.com/Dylancyclone/ansible-homelab-orchestration.git && cd ansible-homelab-orchestration

2. Install the Ansible Dependencies:

   ansible-galaxy install -r requirements.yml

3. Make a copy of the example inventory file:

   cp -r inventories/example inventories/homelab

4. Edit inventories/homelab/inventory to add your homelab server’s IP address

5. Edit inventories/homelab/group_vars/homelab.yml and update the default variables to suit your setup

6. Run the playbook:

   ansible-playbook -i inventories/homelab/inventory playbook.yml