|
1 | 1 | [](https://github.com/torrust/torrust-tracker-deploy-bash-poc/actions/workflows/testing.yml) |
2 | 2 |
|
3 | | -# Torrust Tracker Deploy (Frozen Proof of Concept) |
| 3 | +# Torrust Tracker Deploy - Bash PoC (Historical) |
4 | 4 |
|
5 | | -> ⚠️ REPOSITORY STATUS: **This repository is now FROZEN as a historical Proof of Concept (PoC).** |
| 5 | +> ⚠️ **PROOF OF CONCEPT - HISTORICAL REFERENCE ONLY** |
6 | 6 | > |
7 | | -> - No new features or major refactors will be implemented here. |
8 | | -> - Active engineering has moved to a **greenfield redesign initiative** documented under |
9 | | -> `docs/redesign/` ([Issue #31](https://github.com/torrust/torrust-tracker-deploy-bash-poc/issues/31)). |
10 | | -> - Only documentation, requirements, and architecture specification updates are accepted in |
11 | | -> this repo. |
| 7 | +> This repository contains the first proof of concept for Torrust Tracker deployment infrastructure. |
| 8 | +> It is **no longer actively developed** and exists only as a historical reference. |
12 | 9 | > |
13 | | -> If you are evaluating how Torrust Tracker _will_ be deployed going forward, start with: `docs/redesign/README.md`. |
| 10 | +> **👉 For production use, see [Torrust Tracker Deployer](https://github.com/torrust/torrust-tracker-deployer)** |
| 11 | +> |
| 12 | +> --- |
| 13 | +
|
| 14 | +## Purpose |
| 15 | + |
| 16 | +This was the first proof of concept in a series exploring deployment automation for the Torrust Tracker: |
| 17 | + |
| 18 | +1. **[Bash/OpenTofu/cloud-init PoC](https://github.com/torrust/torrust-tracker-deploy-bash-poc)** |
| 19 | + (this repository) |
| 20 | + |
| 21 | + - **Technologies**: Bash scripts, OpenTofu, cloud-init, Docker Compose |
| 22 | + - **Focus**: Infrastructure as Code with libvirt/KVM and cloud deployment |
| 23 | + - **Status**: ✅ Historical reference - Completed its research goals |
| 24 | + |
| 25 | +2. **[Perl/Ansible PoC](https://github.com/torrust/torrust-tracker-deploy-perl-poc)** |
| 26 | + |
| 27 | + - **Technologies**: Perl, OpenTofu, Ansible, libvirt/KVM, cloud-init, Docker Compose |
| 28 | + - **Focus**: Declarative configuration management with mature automation tools |
| 29 | + - **Status**: ✅ Historical reference - Completed its research goals |
| 30 | + |
| 31 | +3. **[Torrust Tracker Deployer](https://github.com/torrust/torrust-tracker-deployer)** (production) |
| 32 | + - **Technologies**: Rust, OpenTofu, Ansible, LXD, cloud-init, Docker Compose |
| 33 | + - **Focus**: Type-safe, performance-oriented deployment tooling |
| 34 | + - **Status**: 🚀 Production-ready - Active development |
| 35 | + |
| 36 | +## What We Learned |
| 37 | + |
| 38 | +This proof of concept successfully validated: |
| 39 | + |
| 40 | +- ✅ Infrastructure as Code approach with OpenTofu/Terraform |
| 41 | +- ✅ cloud-init for VM initialization |
| 42 | +- ✅ libvirt/KVM for local testing |
| 43 | +- ✅ Docker Compose for application orchestration |
| 44 | +- ✅ Bash scripting feasibility for deployment automation |
| 45 | + |
| 46 | +These learnings informed the design of the production Torrust Tracker Deployer. |
| 47 | + |
| 48 | +## Migration Path |
| 49 | + |
| 50 | +If you're using this PoC, migrate to the production [Torrust Tracker Deployer](https://github.com/torrust/torrust-tracker-deployer): |
| 51 | + |
| 52 | +1. Review the [Torrust Tracker Deployer README](https://github.com/torrust/torrust-tracker-deployer#readme) |
| 53 | +2. Check the [migration guide](https://github.com/torrust/torrust-tracker-deployer/docs/migration-from-pocs.md) |
| 54 | + (if available) |
| 55 | +3. Open an [issue](https://github.com/torrust/torrust-tracker-deployer/issues) if you need assistance |
14 | 56 |
|
15 | | -This PoC still demonstrates a full twelve-factor style deployment (infrastructure provisioning + |
16 | | -application lifecycle) and remains a reference for baseline behaviors. Its documentation is |
17 | | -being actively curated to extract reusable requirements for the next-generation implementation. |
| 57 | +--- |
18 | 58 |
|
19 | | -Historic description (legacy context retained below for reference): |
| 59 | +## Historical Documentation (Reference) |
20 | 60 |
|
21 | 61 | This repo contains all the configuration needed to run the live Torrust Tracker Deploy. |
22 | 62 |
|
23 | | -> (Legacy notice) We were in the process of |
24 | | -> [splitting the Torrust Demo repo into two repos](https://github.com/torrust/torrust-demo/issues/79). |
25 | | -> That plan has been superseded by the broader redesign captured in Issue #31. |
| 63 | +> **Note**: The original plan to split the Torrust Demo repo into two repos was superseded |
| 64 | +> by the broader redesign captured in the production Torrust Tracker Deployer. |
26 | 65 |
|
27 | 66 | ## 🏗️ Repository Structure |
28 | 67 |
|
|
0 commit comments