RPi-cluster-2025

Description of the process of building Raspberry Pi cluster <!-- Improved compatibility of back to a top link: See: https://github.com/othneildrew/Best-README-Template/pull/73 --> <!-- *** Thanks for checking out the Best-README-Template. If you have a suggestion *** that would make this better, please fork the repo and create a pull request *** or open an issue with the tag "enhancement". *** Remember to give the project a star! *** Thanks again! Now go create something AMAZING! :D -->

Rasperry Pi cluster

The project shows creating the Raspberry Pi cluster from scratch
Explore the docs »

View Demo · Report Bug · Request Feature

About The Project

:zap: For some time now, I've been tempted to build a cluster using Raspberry Pi minicomputers. :muscle: To experiment with network configuration, containerization, web applications, CI/CD, distributed computing, and a few other interesting topics. :wink: I hope the information in the following documentation will be useful to some people.

(back to top)

Built With

(back to top)

Getting Started

:informationsource: All things needed to start are mentioned at the beginning of the documentation. :informationsource: The operating system used in this project is Linux. :information_source: All used software is free software, under a different type of licenses.

Prerequisites

:informationsource: I've used four Raspberry Pi 5 microcomputers to build a cluster. :informationsource: You can use a small local networ of PCs (or laptops) with Unix-based systems to do some experiments, etc. :information_source: Of course, you don't have to do it, but you can use this project to build your version of cluster or to get some tips and tricks from my experience.

Installation

1. Read the documentation.
2. Clone the repo. sh git clone https://github.com/zacniewski/RPi-cluster-2025.git

3. Manage IP addresses of your machines in the local network.

4. Install necessary software (described in the documentation).

   • Docker,
   • uv.

5. Install Python packages.

   • create virtual environment with uv or pip,
   • activate it,
   • install packages.

(back to top)

Roadmap

• [x] Putting everything together (RPi, power supplies, drives, cables, etc.)
• [x] Installing the operating system on a micro SD card
• [x] Installing the operating system on NVMe drives
  • [x] Configuring IP addresses in the local network
• [x] Installing Docker on Raspberry Pi
• [ ] Django web application for cluster monitoring
  • [ ] Using uv for managing packages
• [ ] Installation of distributed computing software
  • [ ] .........
• [ ] Connecting cameras and external sensors
  • [ ] .........
• [ ] VPN installation and configuration
  • [ ] .........

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Top contributors:

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Artur Zacniewski - @zacniewski - a.zacniewski@we.umg.edu.pl

Project Link: https://github.com/zacniewski/RPi-cluster-2025

(back to top)

Acknowledgments

Below are some links, that I've found useful during the process of creating this project: * Best README template * Custom badges with Shield.io * Simple Icons * Raspberry Pi logo/wallpaper * Raspberry Pi icon * Chess icons from FontAwesome

(back to top)