StackPilot's stacks were already plain folders on disk, which makes GitOps less
of an architectural change than it would be elsewhere: a sync is "make these
files match that repo, then compose up". Almost all of the design effort went
into the word "these", because getting it wrong destroys data.
A stack folder is not just the compose file. Compose creates bind-mount
directories in it — ./config, ./data — and those hold the live state of whatever
is running. So the obvious implementation, clone into the stack folder and
git reset --hard, is a data-loss bug waiting for its first `git clean`. Instead
the clone lives in a cache under ${DATA_DIR}/git/<stack> where reset and clean
are safe, and the configured subtree is copied across. No .git ends up in the
stack folder, so backups and the file browser are unaffected too.
Deletion is the other half. Making a folder "match" a repo naively means
removing what the repo does not have, which is exactly the application data
above. So each sync records the paths it wrote, and the next sync may delete
only those — a file the repository never provided cannot be touched by any code
path here. Tested directly: a database file and a hand-written .env survive a
sync that replaces the compose file and removes a file the repo dropped.
What the repo does provide is overwritten, hand edits included. That is the
point of GitOps rather than a wart, but it is a surprise if you attach a repo to
a stack you have been editing, so the connect form says it before the first sync
and the first sync is never automatic.
The webhook is the only route in StackPilot with no bearer token, because a Git
forge has none to present. It authenticates with an HMAC over the body —
X-Hub-Signature-256 for GitHub/Gitea/Forgejo, X-Gitlab-Token for GitLab, both
compared in constant time — and answers 404, not 403, to anything unsigned. A
403 would confirm that a given stack exists and is connected to a repository,
which an unauthenticated caller has not earned. The authorization matrix test
caught this route being public and made me write that reasoning down in it,
which is exactly what that test is for.
Credentials never reach a command line: ps is readable by every process on the
host, and this runs in a container next to everything else. The HTTPS token goes
to git through GIT_ASKPASS and the environment, the SSH key through a 0600 file
kept outside the working tree, and everything git prints is scrubbed of both —
plus any credential-carrying URL — before it is stored in last_error or shown.
Auto-deploy takes the same per-stack lock as every other lifecycle action, so a
webhook firing mid-deploy reports "files synced, stack busy" instead of racing a
second compose run at the same project.
The image needed git and openssh-client, which is the only reason this release
touches the Dockerfile.
26 tests against real repositories created with the real git binary, none of
them touching the network — mocking git would mostly test the mock. Verified end
to end as well: connect, sync, a push that changes one file and deletes another,
a wrongly signed webhook, a correctly signed one, and the live data still there
afterwards.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
167 lines
5.3 KiB
Python
167 lines
5.3 KiB
Python
"""StackPilot backend — FastAPI application entry point."""
|
|
from __future__ import annotations
|
|
|
|
import asyncio
|
|
import logging
|
|
from contextlib import asynccontextmanager
|
|
|
|
from fastapi import FastAPI, Request
|
|
from fastapi.middleware.cors import CORSMiddleware
|
|
from fastapi.responses import JSONResponse
|
|
from sqlmodel import Session
|
|
|
|
from config import settings
|
|
from version import APP_VERSION
|
|
from database import engine, init_db
|
|
from docker_client import DockerError
|
|
from routers import (
|
|
audit,
|
|
auth,
|
|
backups,
|
|
containers,
|
|
dashboard,
|
|
destinations,
|
|
editor,
|
|
files,
|
|
git,
|
|
images,
|
|
networks,
|
|
ports,
|
|
registries,
|
|
schedules,
|
|
secrets,
|
|
settings as settings_router,
|
|
stacks,
|
|
system,
|
|
templates,
|
|
tokens,
|
|
volumes,
|
|
ws,
|
|
)
|
|
from services import (
|
|
backup_destination_service,
|
|
git_service,
|
|
image_status_store,
|
|
logo_service,
|
|
registry_service,
|
|
schedule_service,
|
|
stack_lock_service,
|
|
template_service,
|
|
update_service,
|
|
)
|
|
|
|
logging.basicConfig(level=logging.INFO)
|
|
logger = logging.getLogger("stackpilot")
|
|
|
|
|
|
@asynccontextmanager
|
|
async def lifespan(app: FastAPI):
|
|
init_db()
|
|
# Register stacks that already exist on disk.
|
|
try:
|
|
with Session(engine) as session:
|
|
stacks.sync_discovered_stacks(session)
|
|
except Exception as exc: # noqa: BLE001
|
|
logger.warning("Stack discovery failed: %s", exc)
|
|
# One-off: encrypt backup-destination credentials written before they were
|
|
# stored encrypted (see services/crypto_service.py).
|
|
try:
|
|
with Session(engine) as session:
|
|
encrypted = backup_destination_service.migrate_plaintext_configs(session)
|
|
if encrypted:
|
|
logger.info("Encrypted %d backup destination config(s) at rest", encrypted)
|
|
except Exception as exc: # noqa: BLE001
|
|
logger.warning("Destination config encryption migration failed: %s", exc)
|
|
try:
|
|
moved = template_service.migrate_legacy_db_templates()
|
|
if moved:
|
|
logger.info("Migrated %d custom template(s) from the database to folders", moved)
|
|
except Exception as exc: # noqa: BLE001
|
|
logger.warning("Legacy template migration failed: %s", exc)
|
|
# Runtime state that used to live in module dicts and was lost on restart.
|
|
try:
|
|
with Session(engine) as session:
|
|
stale = stack_lock_service.prune_expired(session)
|
|
if stale:
|
|
logger.info("Cleared %d stale stack lock(s) from a previous run", stale)
|
|
except Exception as exc: # noqa: BLE001
|
|
logger.warning("Could not prune stack locks: %s", exc)
|
|
try:
|
|
restored = image_status_store.install()
|
|
logger.info("Restored %d cached image update status(es)", restored)
|
|
except Exception as exc: # noqa: BLE001
|
|
logger.warning("Could not restore the image update cache: %s", exc)
|
|
# Private registry credentials: into the in-memory cache the update checker
|
|
# reads, and into the config.json the Docker CLI reads.
|
|
try:
|
|
with Session(engine) as session:
|
|
known = registry_service.reload(session)
|
|
if known:
|
|
logger.info("Loaded credentials for %d registr%s", known, "y" if known == 1 else "ies")
|
|
except Exception as exc: # noqa: BLE001
|
|
logger.warning("Could not load registry credentials: %s", exc)
|
|
|
|
update_task = asyncio.create_task(update_service.background_loop())
|
|
schedule_task = asyncio.create_task(schedule_service.scheduler_loop())
|
|
# App logos. Deliberately a task and not awaited: the catalog is a network
|
|
# download, and a box with no outbound internet must still start instantly
|
|
# (it just keeps the built-in glyphs).
|
|
logo_task = asyncio.create_task(logo_service.catalog_loop())
|
|
git_service.ensure_cache_root()
|
|
git_task = asyncio.create_task(git_service.poll_loop())
|
|
logger.info("StackPilot backend ready on port %s", settings.PORT)
|
|
yield
|
|
update_task.cancel()
|
|
schedule_task.cancel()
|
|
logo_task.cancel()
|
|
git_task.cancel()
|
|
|
|
|
|
app = FastAPI(title="StackPilot", version=APP_VERSION, lifespan=lifespan)
|
|
|
|
app.add_middleware(
|
|
CORSMiddleware,
|
|
allow_origins=settings.CORS_ORIGINS,
|
|
allow_credentials=True,
|
|
allow_methods=["*"],
|
|
allow_headers=["*"],
|
|
)
|
|
|
|
|
|
@app.exception_handler(DockerError)
|
|
async def docker_error_handler(_request: Request, exc: DockerError):
|
|
return JSONResponse(
|
|
status_code=502,
|
|
content={"error": exc.error, "detail": exc.detail},
|
|
)
|
|
|
|
|
|
app.include_router(auth.router)
|
|
app.include_router(stacks.router)
|
|
app.include_router(git.router)
|
|
app.include_router(git.hook_router)
|
|
app.include_router(tokens.router)
|
|
app.include_router(registries.router)
|
|
app.include_router(secrets.router)
|
|
app.include_router(containers.router)
|
|
app.include_router(dashboard.router)
|
|
app.include_router(system.router)
|
|
app.include_router(volumes.router)
|
|
app.include_router(editor.router)
|
|
app.include_router(files.router)
|
|
app.include_router(images.router)
|
|
app.include_router(ports.router)
|
|
app.include_router(templates.router)
|
|
app.include_router(audit.router)
|
|
app.include_router(settings_router.router)
|
|
app.include_router(backups.router)
|
|
app.include_router(destinations.router)
|
|
app.include_router(schedules.router)
|
|
app.include_router(networks.router)
|
|
app.include_router(ws.router)
|
|
|
|
|
|
@app.get("/api/health")
|
|
def health() -> dict:
|
|
return {"status": "ok", "version": APP_VERSION}
|