What is Proxmox Deploy ?

Promox Deploy is a Python-based software that allows you to manage your Proxmox homelab by using YAML files.

This project started as I discovered another incredible project, "Proxmox VE Helper Scripts" by tteck. It allowed me to easily create and deploy apps using the LXC feature of Proxmox, allowing for isolation at a near-zero cost in perfomance.

Soon after that, I started having to maintain a multitude of ssh hosts and keys to access all my LXC easily, furthermore it made managing my LXCs using VSCode and the VSCode agent (with the remote SSH extension) really complicated and not easily maintainable.

So I created ProxmoxDeploy, I took a lot of inspiration from the scripts of tteck, again thank you for your project.

ProxmoxDeploy might be referenced as PD below

How does it work?

It is very simple, you create a Git repository on the platform of your choice with the following structure :

.
├── config.json
├── lxc
│   ├── <id>
│   │   ├── config.yml
│   │   ├── <your files>
│   │   └── <your folders>
│   └── <id>
│       ├── ...
│── qemu
│   ├── <id>
│   │   ├── config.yml
│   │   ├── <your files>
│   │   └── <your folders>
│   └── <id>
│       ├── ...
│── scripts
│   ├── <your global scripts>
│   └── ...

Now ideally you would have some sort of Git actions (GitHub Actions/Drone/Gitea Actions) that automatically runs the latest binary of PD (ProxmoxDeploy) with your repo specified, so that for every new commits, the update is automatically deployed to your homelab. See the automatic deployement page for more info

How to add an LXC?

Look here