ansible/roles/pote/README.md
ilia 69a39e5e5b Add POTE app project support and improve IP conflict detection (#3)
## Summary

This PR adds comprehensive support for deploying the **POTE** application project via Ansible, along with improvements to IP conflict detection and a new app stack provisioning system for Proxmox-managed LXC containers.

## Key Features

### 🆕 New Roles
- **`roles/pote`**: Python/venv deployment role for POTE (PostgreSQL, cron jobs, Alembic migrations)
- **`roles/app_setup`**: Generic app deployment role (Node.js/systemd)
- **`roles/base_os`**: Base OS hardening role

### 🛡️ Safety Improvements
- IP uniqueness validation within projects
- Proxmox-side IP conflict detection
- Enhanced error messages for IP conflicts

### 📦 New Playbooks
- `playbooks/app/site.yml`: End-to-end app stack deployment
- `playbooks/app/provision_vms.yml`: Proxmox guest provisioning
- `playbooks/app/configure_app.yml`: OS + application configuration

## Security
-  All secrets stored in encrypted vault.yml
-  Deploy keys excluded via .gitignore
-  No plaintext secrets committed

## Testing
-  POTE successfully deployed to dev/qa/prod environments
-  All components validated (Git, PostgreSQL, cron, migrations)

Co-authored-by: ilia <ilia@levkin.ca>
Reviewed-on: #3
2026-01-01 11:19:54 -05:00

935 B

pote

Deploys the POTE project as a Python/venv application (no HTTP services required) and schedules cron jobs.

What it does

  • Installs required system packages (git, python3.11/venv, build deps, postgresql server/client)
  • Ensures a dedicated OS user exists (default: poteapp)
  • Creates PostgreSQL database and user
  • Clones/updates the repo from an SSH remote using a vault-backed private key
  • Creates a Python virtualenv and installs from pyproject.toml (editable mode)
  • Renders an environment file (default: {{ pote_app_dir }}/.env)
  • Runs Alembic database migrations
  • Installs cron jobs (daily/weekly/health-check)

Key variables

See defaults/main.yml. Common inputs:

  • pote_git_repo, pote_git_branch
  • pote_git_ssh_key (set vault_pote_git_ssh_key in your vault)
  • pote_user, pote_app_dir, pote_venv_dir
  • pote_db_*, pote_smtp_*
  • pote_enable_cron, pote_*_time, pote_*_job