sharang
5dd6e0448f
Bootstraps §1.2 scaffolding (README, CONTRIBUTING, CODEOWNERS, CHANGELOG, PR + issue templates, LICENSE, CI workflow, release workflow, commitlint, cliff, .editorconfig, .gitignore, .env.example) and ships a proprietary all-rights-reserved LICENSE naming both founders. Refs: M0.1
2.4 KiB
orca-platform
IaC for VMs, Orca manifests, DNS, TLS, backups.
Part of the Breakpilot Platform. For the big picture see
platform/docs: Architecture · Infrastructure · Product Integration Spec · Implementation Plan
What this is
IaC for VMs, Orca manifests, DNS, TLS, backups. Scaffolded under milestone M1.1. See platform/docs for the full architecture context.
Plane: Infra Owner: @sharang Status: pre-alpha Linked milestone: M1.1
Run locally
# prerequisites: see CONTRIBUTING.md for tooling once code lands
make dev # starts dependencies + this service on http://localhost:3000
make test # unit + integration
make e2e # only if this repo ships user-facing flows
Local secrets come from .env.local (gitignored). Template at .env.example.
Endpoints / surface
{{For services: list the top-level routes or commands. For libraries: list the public API entry points. For IaC: list the make targets.}}
Deployment
| Env | URL | How |
|---|---|---|
| dev | http://localhost:3000 |
make dev |
| stage | https://orca-platform.stage.yourplatform.com |
auto on merge to main |
| prod | https://orca-platform.yourplatform.com |
manual: tag vX.Y.Z + sign-off |
Rollback: orca rollout undo orca-platform --env={{env}}.
Observability
- Traces, logs, metrics: SigNoz — service name
orca-platform - Audit events: Tenant Registry
/audit(Retraced-shape schema) - On-call:
oncall@yourplatform.com· runbook atplatform/docs/runbooks/orca-platform.md
Contributing
See CONTRIBUTING.md. TL;DR: branch from main, open a PR, 1 review + green CI, squash-merge.
License
Proprietary — all rights reserved. Copyright (c) 2026 Sharang Parnerkar and Benjamin Boenisch. See LICENSE.