Files

T

Sergey Antropoff 48df10b17e Prepare 0.1.0 for lab release: durable handlers, HTTP Compose, CI, and pulumi-tests.

- Harden DB-backed handlers and seed profiles; align client wire shapes for
  cluster resources, QEMU config, and node SSL fields
- Serve plain HTTP on Compose :8006; keep TLS optional (--profile tls) and
  terminate HTTPS at Kubernetes Ingress
- Add pulumi-tests (full contract surface majors 6–9 + BPG lifecycle) and
  make pulumi-tests
- Ship bilingual docs, CHANGELOG, SECURITY, CONTRIBUTING, and GitHub Actions
  (make ci + Compose/Helm validation)

2026-07-18 04:18:05 +03:00

2.1 KiB

Raw Blame History

Language / Язык: English | Русский

Contributing

Thanks for helping improve the Proxmox VE API laboratory simulator.

Prerequisites

Docker + Docker Compose
make
No local Python toolchain required for day-to-day work (tools run in Compose)

Local loop

cp -n .env.example .env
make install
make up
make seed PROFILE=small
curl -sS http://localhost:8006/health/ready

Primary HTTP endpoint (same port as real PVE): http://localhost:8006/

Optional HTTPS for proxmoxer: docker compose --profile tls → https://localhost:8443/ (self-signed — use curl -sk or accept the browser warning).

Quality gates (must pass before a PR)

make ci            # ruff format/check + mypy + offline pytest + surface probe
make ci-all        # also remaining integration + proxmoxer compatibility
make helm-lint     # chart lint (+ ingress example values)
make pulumi-tests  # Pulumi surface (majors 6–9) + pulumi-proxmoxve lifecycle

GitHub Actions runs make ci plus Compose/Helm validation on every push and PR to main. Run make ci-all, make helm-lint, and make pulumi-tests locally before larger API or client-facing changes.

Project rules worth remembering

Mutations must persist to PostgreSQL (tables and/or jsonb metadata).
Do not add user-facing “not supported in the simulator” style errors — see .cursor/rules/durable-simulator.mdc.
Prefer matching Proxmox request/response shapes from the contract snapshot.
Keep EN and RU docs in sync when you change operator-facing behaviour.

Docs

Index: docs/README.md · docs/ru/README.md
Security / lab threat model: SECURITY.md

Releases

Maintainers publish the runtime image with:

docker login
make release          # pushes inecs/proxmox-api-simulator:<version> (+ :latest)

After a public release, paste the overview from docs/docker-hub-overview.md into the Docker Hub repository description if it drifted.

2.1 KiB Raw Blame History Unescape Escape