resource-control/SCOPE.md
tegwick 9c57b0d96b chore: keep generated orientation brief local
Assistant: codex
Assistant-Model: gpt-6-astra
Assistant-Session: 01a15374-f59f-7a31-86d2-d23b5d2ed181
2026-10-19 13:50:33 +02:00

85 lines
3.8 KiB
Markdown

# SCOPE
> This file was generated by `statehub register`. Refine it as the repository
> boundaries become clearer.
## One-liner
Provider-neutral infrastructure resource inventory, procurement, cost, utilization, and optimization control plane.
## Core Idea
resource-control exists to provide the capability described in INTENT.md.
## In Scope
- Inventory purchased and proposed compute, storage, network, and managed
resources across Host Europe, Scaleway, Hetzner, and future providers.
- Normalize price, commitment, utilization, capacity, ownership, workload,
location, failure domain, renewal, and exit data.
- Associate every expense, estimate, usage observation, and expense
evaluation with exactly one financial entity (Binky, Frontier, Railiance,
Netkingdom, Helixforge, Coulomb) per `docs/TermsOfResourceProcurement.md`.
- Compute Railiance delivered cost and internal transfer prices (cost plus
published markup); emit monthly settlement and credit-state evidence.
- Research and compare procurement options against provider-neutral
requirements.
- Publish resource allocation, forecast, realized-cost, and optimization
evidence to fin-hub.
- Track procurement decisions, renewal/cancellation windows, rightsizing,
consolidation, and provider-switch opportunities.
- Verify that acquired resources satisfy their operational requirement.
## Out of Scope
- Execute payments or approve financial commitments.
- Store provider, billing, or workload credentials.
- Own workload manifests, application retention policy, or backup procedures.
- Replace fin-hub's budget, burn-rate, runway, and viability authority.
- Make irreversible procurement or cancellation decisions without human
approval.
## Current State
- Status: stable. WP-0001 through WP-0007 are finished. Live inventory is
schema 0.3 with five facets. Backup object storage is live on
`reef-storage`. No open workplans.
## Getting Oriented
- Start with: INTENT.md
- Internal procurement terms: docs/TermsOfResourceProcurement.md
- Operational refs: docs/operational-reference-convention.md
- Agent instructions: AGENTS.md
- Workplans: workplans/
## Provided Capabilities
```capability
type: operations
title: Infrastructure portfolio and optimization evidence
description: Normalize resource inventory, capacity, utilization, ownership and cost evidence; make portfolio-report renders the portfolio and make optimization CASE=... evaluates a supplied optimization case. Workload owners retain deployment authority and fin-hub retains booked financial authority; observations do not grant procurement or scheduling admission.
keywords: [resource, inventory, capacity, allocation, forecast, cost, optimization]
```
## Generated work-record index
This repository opts into staged-source WORK-RECORDS.md generation through
`.generated-work-records.json` and the isolated `.generated-work-records.mk`
recipe. `make generated-work-records` reuses the State Hub renderer through
the Custodian adapter; `make generated-work-records-check` verifies byte-exact
agreement with staged Markdown. The pre-commit hook uses the isolated recipe,
preserves unstaged index edits by refusing them, and retains the generated-only
commit guard and existing security checks. It does not contact the hub, alter
workplan statuses or grant deployment authority. This consumes shared tooling;
it does not make this repository the provider of the generator capability.
## Local orientation brief policy — 2026-10-19
`.custodian-brief.md` is a local, ignored State Hub orientation snapshot. Its
existing bytes remain available for offline session startup; refreshing it does
not require a Git commit. Authored workplans and the generated WORK-RECORDS index
retain their existing source and staged-generation contracts. No runtime or
credential change follows from this repository hygiene policy.