Skip to content

Commit

Permalink
docs: add project structure, improve content
Browse files Browse the repository at this point in the history
  • Loading branch information
alexandrelamberty authored Apr 25, 2024
1 parent 53681fa commit 30ff790
Showing 1 changed file with 31 additions and 10 deletions.
41 changes: 31 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,40 @@

# Xraspios Infrastructure as Code

Ansible management for my Raspberry Pis .
Ansible management for my Raspberry Pis.

## Features
## Introduction

- [ ] [Docker](https://www.docker.com/)
- [ ] [Portainer](https://www.portainer.io/)
This project automates the setup and configuration of Raspberry Pi infrastructure using Ansible. It installs Docker, Portainer, and other necessary components to manage and maintain Raspberry Pi clusters efficiently.

## Execute playbook
## Prerequisites

```bash
ansible-playbook --inventory-file hosts.ini playbook.yml -u pi --ask-pass
```
- Ansible installed on the control machine.
- Raspberry Pis accessible via SSH.
- Basic knowledge of Ansible and Raspberry Pi administration.

## Configure Portainer
## Project Structure

Navigate to <http://pi01-srv:9000/>
- `playbook.yaml`: Main Ansible playbook containing tasks for Raspberry Pi setup.
- `hosts.ini`: Inventory file listing Raspberry Pi hosts.
- `roles/`: Directory for organizing Ansible roles.
- `common/`: Role for common configurations across all Raspberry Pis.
- `tasks/`: Directory containing tasks specific to the `common` role.
- `main.yaml`: Main tasks file for the `common` role.
- `defaults/`: Directory containing default variables for the `common` role.
- `main.yaml`: Default variables file for the `common` role.
- `requirements.txt`: File listing Ansible collections or roles required by the project.

## Usage

1. Clone this repository to your local machine.

2. Modify the `hosts.ini` file to include the IP addresses of your Raspberry Pis.

3. Execute the playbook using the following command:

```bash
ansible-playbook --inventory-file hosts.ini playbook.yml -u pi --ask-pass
```

4. Access Portainer by navigating to <http://pi01-srv:9000> in your web browser.

0 comments on commit 30ff790

Please sign in to comment.