Jonathan Boniface
e6f10ba8c9
Adds the normative contract every platform agent must conform to, plus a
working reference template under template/ that ticks every box out of
the box.
Spec is derived from the production agents shipped in
cjot-backstage-az/agents/ on branch sandbox/jonathan:
- agent-registry, agent-factory, decomposer, discovery-agent,
golden-path, modernization-factory, modernization-factory-v2,
policy-transformer, scaffold-agent, support-intake-agent, the-watcher
Contents:
- SPEC.md normative contract (13 sections + conformance checklist)
- CHANGELOG.md spec versioning (1.0.0)
- docs/
registration.md self-registration with the agent-gateway
observability.md OTel logs/metrics/traces wiring
manifest.md /.well-known/agent.json schema + AgentSkill
serialisation (pydantic vs protobuf)
kubernetes.md k8s deployment shape, mandatory cross-refs,
per-namespace agents, resource sizing
deployment.md .image-version, ACR build, deploy scripts, rollback
deviations.md tracked debts against the spec
- template/
.env.local.example, .gitignore, .image-version (0.1.0),
Dockerfile (python:3.12-slim, non-root UID 1001, HEALTHCHECK),
requirements.txt (harness floor + optional LLM stack),
app/agent.py (Starlette entry, lifespan + self-registration,
defensive _skill_dict for pydantic vs protobuf),
app/logging_setup.py (canonical OTel log bridge — copy verbatim),
app/metrics.py (meter + example counter/histogram),
app/skills.py (AGENT_CONFIG + AgentSkill list),
k8s/configmap.yaml + deployment.yaml (Deployment + Service,
OTel annotations + 6-var env block,
agents-sa + agents-kv-spc bindings),
scripts/deploy.sh (auto-bump + az acr build + apply + rollout),
scripts/full-deploy.sh (preflight + deploy + post-deploy smoke),
scripts/deploy-local.sh (docker/podman + .env.local)
39 lines
995 B
Bash
Executable File
39 lines
995 B
Bash
Executable File
#!/bin/bash
|
|
# deploy-local.sh — Build the image locally and run it against .env.local.
|
|
#
|
|
# Useful for iterating on prompts/skills without touching the cluster.
|
|
|
|
set -euo pipefail
|
|
|
|
SCRIPT_DIR=$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)
|
|
AGENT_DIR=$(cd "${SCRIPT_DIR}/.." && pwd)
|
|
|
|
APP_NAME="<agent-name>"
|
|
PORT=8000
|
|
ENV_FILE="${AGENT_DIR}/.env.local"
|
|
|
|
if [ ! -f "${ENV_FILE}" ]; then
|
|
echo "ERROR: ${ENV_FILE} not found. Copy .env.local.example first." >&2
|
|
exit 1
|
|
fi
|
|
|
|
# Pick docker or podman
|
|
if command -v docker >/dev/null; then
|
|
RUNTIME=docker
|
|
elif command -v podman >/dev/null; then
|
|
RUNTIME=podman
|
|
else
|
|
echo "ERROR: neither docker nor podman found on PATH" >&2
|
|
exit 1
|
|
fi
|
|
|
|
echo "Building ${APP_NAME}:local with ${RUNTIME}..."
|
|
"${RUNTIME}" build -t "${APP_NAME}:local" "${AGENT_DIR}"
|
|
|
|
echo "Running ${APP_NAME}:local on http://localhost:${PORT} ..."
|
|
exec "${RUNTIME}" run --rm -it \
|
|
--name "${APP_NAME}" \
|
|
-p "${PORT}:${PORT}" \
|
|
--env-file "${ENV_FILE}" \
|
|
"${APP_NAME}:local"
|