Table of Contents

• Overview
• Architecture
• Core Concepts
• Trade-offs
• Design
• Lifecycle
• Requirements
• Getting Started
• Create Container

Overview

Proxmox-GitOps implements a self-sufficient, extensible CI/CD environment for provisioning, configuring, and orchestrating Linux Containers (LXC) within Proxmox VE. Leveraging an Infrastructure-as-Code (IaC) approach, it manages the entire container lifecycle—bootstrapping, deployment, configuration, and validation—through version-controlled automation.

Architecture

The architecture is based on a multi-stage pipeline capable of recursively deploying and configuring itself.

Initial bootstrapping is performed via a local Docker environment, with subsequent deployments targeting Proxmox VE.

Core Concepts

This system implements stateless infrastructure management on Proxmox VE, ensuring deterministic reproducibility and environmental parity through recursive self-containment.

Concept	Approach	Reasoning
Ephemeral State	Git repository represents current desired state; state purity across deployments.	Deployment consistency and stateless infrastructure over version history.
Recursive Self-Containment	Embedded control plane recursively provisions itself within target containers, ensuring deterministic bootstrap.	Prevents configuration drift; enables consistent and reproducible behavior.
Dynamic Orchestration	Imperative logic (e.g. config/recipes/repo.rb) used for dynamic, cross-layer state management	Declarative approach intractable for adjusting to dynamic cross-layer changes (e.g. submodule remote rewriting or network context).
Mono-Repository	Centralizes infrastructure as a single code artifact; submodules modularize development at runtime	Consistency and modularity: infrastructure self-contained; dynamically resolved in recursive context.

---

Trade-offs

• Complexity vs. Autonomy: Recursive self-replication increases complexity drastically to achieve integrated deterministic bootstrap and reproducing behavior.

• Git Convention vs. Infrastructure State: Uses Git as a state engine rather than versioning in volatile, stateless contexts. Mono-repository representation, however, encapsulates the entire infrastructure as a self-contained asset suited for version control.

---

Design

• "Head-full" Headless: loosely coupled; Ansible for maintained provisioning library, Cinc (or Chef respectively) for separation, modularization and complexity.

Lifecycle

• Self-containing Mono-Repository Artifact for Version-Controlled Mirroring

  • clone aliased git clone --recurse-submodules (store network /share in persistent context)

• Backup: See previous

• Update: See previous, and redeploy merged

• Rollback: See previous, or set snapshot to release at runtime

Requirements

• Docker
• Proxmox VE 8.4
• Proxmox API token
• See Wiki for recommendations

Getting Started

• Configure credentials and Proxmox API token in local/.config.json as config.json
• Run local/run.sh for local Docker environment
• Accept the Pull Request to deploy on Proxmox VE

Create Container

Reusable container definitions are stored in the libs folder. Copy an example container (like libs/broker or libs/proxy) as a template, or create a new container lib from scratch and follow these steps:

• Add config.env to your container's root directory, e.g.:

IP=192.168.178.42
ID=42
HOSTNAME=apache
CORES=2
MEMORY=2048
SWAP=512
DISK=local-lvm:8
BOOT=yes

• Paste generic pipeline in .gitea/workflows:

on:
  workflow_dispatch:
  push:
    branches: [ release, main, develop ]

jobs:
  include:
    runs-on: shell
    steps:
      - id: init
        uses: srv/config/.gitea/workflows@main
        with:
          repo: ${{ gitea.repository }}
          ref: ${{ gitea.ref_name }}
          cache_bust: ${{ gitea.run_number }}

• Add your cookbook to the container definition root:

# libs/apache/recipes/default.rb
package 'apache2'

file '/var/www/html/index.html' do
  content "<h1>Hello from #{Env.get(node, 'login')}</h1>"
  mode '0644'
  owner 'app' # see base/roles/base/tasks/main.yml
  group 'app' # each container is configured identically 
end

Common.application 'apache2' # reusables included by convention

• Optionally, use Env.get() and Env.set() to access Gitea environment variables.

• a) Deploy: Push to the release branch of a new repository

• b) Add to Meta-/Mono-Repository: Add path to repositories and redeploy

The container can be tested locally running ./local/run.sh [container] (wip)