-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathpreflight_checklist.txt
More file actions
34 lines (28 loc) · 1.49 KB
/
Copy pathpreflight_checklist.txt
File metadata and controls
34 lines (28 loc) · 1.49 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
SEARCHAPI CUSTOMER-SITE PREFLIGHT CHECKLIST
1. Site Identity
- SITE_ID is assigned and matches customer/site naming conventions.
- API_ADDR is reachable only from the intended operator/gateway network.
- API_KEY is set for all non-health endpoints.
2. Database
- DATABASE_URL points at a PostgreSQL instance inside the customer trust boundary.
- The service account can create tables, indexes, and LISTEN/NOTIFY subscriptions.
- Backup/retention policy covers audit_events and telemetry_samples.
3. Search
- ELASTICSEARCH_URL is optional.
- If Elasticsearch is unavailable or not allowed, Postgres fallback search remains active.
- If Elasticsearch is enabled, ELASTICSEARCH_INDEX is site-specific.
4. Gateway Ingestion
- Test bench or gateway can POST NDJSON to /api/v1/ingest/stream.
- Each sample includes run_id, channel_id, timestamp, value, quality, and replay_key.
- Replay keys are deterministic per gateway/run/channel sequence.
5. Operational Readiness
- GET /healthz returns database status and site_id.
- GET /readyz succeeds from the deployment network.
- GET /metrics increments after ingestion.
- GET /api/v1/events returns replayable audit events.
- GET /api/v1/alarms shows threshold violations after seed data.
6. Onboarding Smoke Test
- POST /api/v1/onboarding/seed
- POST examples/gateway-stream.ndjson to /api/v1/ingest/stream
- Search for q=threshold or q=gateway-sea-01
- Confirm operator annotations can be created for the seeded run.