deploy: add build_sha visibility for precise drift detection
Make /health report the precise git SHA the container was built from,
so 'is the live service current?' can be answered without ambiguity.
0.2.0 was too coarse to trust as a 'live is current' signal — many
commits share the same __version__.
Three layers:
1. /health endpoint (src/atocore/api/routes.py)
- Reads ATOCORE_BUILD_SHA, ATOCORE_BUILD_TIME, ATOCORE_BUILD_BRANCH
from environment, defaults to 'unknown'
- Reports them alongside existing code_version field
2. docker-compose.yml
- Forwards the three env vars from the host into the container
- Defaults to 'unknown' so direct `docker compose up` runs (without
deploy.sh) cleanly signal missing build provenance
3. deploy.sh
- Step 2 captures git SHA + UTC timestamp + branch and exports them
as env vars before `docker compose up -d --build`
- Step 6 reads /health post-deploy and compares the reported
build_sha against the freshly-built one. Mismatch exits non-zero
(exit code 6) with a remediation hint covering cached image,
env propagation, and concurrent restart cases
Tests (tests/test_api_storage.py):
- test_health_endpoint_reports_code_version_from_module
- test_health_endpoint_reports_build_metadata_from_env
- test_health_endpoint_reports_unknown_when_build_env_unset
Docs (docs/dalidou-deployment.md):
- Three-level drift detection table (code_version coarse,
build_sha precise, build_time/branch forensic)
- Canonical drift check script using LIVE_SHA vs EXPECTED_SHA
- Note that running deploy.sh is itself the simplest drift check
219/219 tests passing.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This commit is contained in:
@@ -744,13 +744,32 @@ def api_validate_backup(stamp: str) -> dict:
|
||||
def api_health() -> dict:
|
||||
"""Health check.
|
||||
|
||||
The ``version`` and ``code_version`` fields both report the value
|
||||
of ``atocore.__version__`` from the deployed code. Comparing this
|
||||
to the main branch's ``__version__`` is the fastest way to detect
|
||||
deployment drift: if they differ, the running service is behind
|
||||
the repo and needs a redeploy (see
|
||||
``docs/dalidou-deployment.md`` and ``deploy/dalidou/deploy.sh``).
|
||||
Three layers of version reporting, in increasing precision:
|
||||
|
||||
- ``version`` / ``code_version``: ``atocore.__version__`` (e.g.
|
||||
"0.2.0"). Bumped manually on commits that change the API
|
||||
surface, schema, or user-visible behavior. Coarse — any
|
||||
number of commits can land between bumps without changing
|
||||
this value.
|
||||
- ``build_sha``: full git SHA of the commit the running
|
||||
container was built from. Set by ``deploy/dalidou/deploy.sh``
|
||||
via the ``ATOCORE_BUILD_SHA`` env var on every rebuild.
|
||||
Reports ``"unknown"`` for builds that bypass deploy.sh
|
||||
(direct ``docker compose up`` etc.). This is the precise
|
||||
drift signal: if the live ``build_sha`` doesn't match the
|
||||
tip of the deployed branch on Gitea, the service is stale
|
||||
regardless of what ``code_version`` says.
|
||||
- ``build_time`` / ``build_branch``: when and from which branch
|
||||
the live container was built. Useful for forensics when
|
||||
multiple branches are in flight or when build_sha is
|
||||
ambiguous (e.g. a force-push to the same SHA).
|
||||
|
||||
The deploy.sh post-deploy verification step compares the live
|
||||
``build_sha`` to the SHA it just set, and exits non-zero on
|
||||
mismatch.
|
||||
"""
|
||||
import os
|
||||
|
||||
from atocore import __version__
|
||||
|
||||
store = get_vector_store()
|
||||
@@ -759,6 +778,9 @@ def api_health() -> dict:
|
||||
"status": "ok",
|
||||
"version": __version__,
|
||||
"code_version": __version__,
|
||||
"build_sha": os.environ.get("ATOCORE_BUILD_SHA", "unknown"),
|
||||
"build_time": os.environ.get("ATOCORE_BUILD_TIME", "unknown"),
|
||||
"build_branch": os.environ.get("ATOCORE_BUILD_BRANCH", "unknown"),
|
||||
"vectors_count": store.count,
|
||||
"env": _config.settings.env,
|
||||
"machine_paths": {
|
||||
|
||||
Reference in New Issue
Block a user