Seed INTENT, SCOPE, README for the observability layer
Fills the gap identified in the 2026-08-11 Railiance architecture assessment: five layers declare they intend to be self-evidencing or auditable, and nothing owned the place that evidence goes. The live cluster has no monitoring namespace at all. Positions telemetry as the evidence plane - it owns the signal, not the meaning of the signal, so conformance rules stay with the repos that own them. Flags stack-dimension placement as an open question for railiance-master rather than asserting a level, so this repo does not repeat railiance-forge's unplaced state. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This commit is contained in:
parent
a4296e632d
commit
4ecf211524
4 changed files with 442 additions and 1 deletions
159
INTENT.md
Normal file
159
INTENT.md
Normal file
|
|
@ -0,0 +1,159 @@
|
|||
# INTENT
|
||||
|
||||
> This file captures **why this repository exists**,
|
||||
> the **direction it is moving toward**, and
|
||||
> the **kind of system it is meant to become**.
|
||||
> It is intentionally **aspirational and stable**, not a description of current implementation.
|
||||
|
||||
---
|
||||
|
||||
## One-liner
|
||||
|
||||
**The observability layer — turning the running system's behaviour into evidence, so every other layer's promise to be self-evidencing has somewhere to be proven.**
|
||||
|
||||
---
|
||||
|
||||
## Why This Exists
|
||||
|
||||
Railiance has an unusually consistent aspiration, declared independently across
|
||||
five layers:
|
||||
|
||||
* `railiance-infra` — "self-evidencing, **auditable** provisioning"
|
||||
* `railiance-cluster` — "self-evidencing, **auditable** runtime state"
|
||||
* `railiance-platform` — "**self-healing and observable** platform services"
|
||||
* `railiance-apps` — "self-evidencing, reviewable **application readiness**"
|
||||
* `railiance-forge` — "self-evidencing forge **health and readiness** checks"
|
||||
|
||||
Five layers all want the system to **prove its own state rather than be
|
||||
asserted correct**. None of them owned the place that evidence goes, and the
|
||||
live cluster showed the consequence: no monitoring namespace, no metrics store,
|
||||
no alerting path.
|
||||
|
||||
Without this layer:
|
||||
|
||||
* "self-evidencing" stays an adjective in five INTENT files,
|
||||
* failures are discovered by a human noticing, not by the system reporting,
|
||||
* the control loops that are supposed to keep the fleet consistent have no
|
||||
signal to close on,
|
||||
* and drift is found by audit months later rather than by an alert in minutes.
|
||||
|
||||
This layer exists so that a claim about system state can be **checked against
|
||||
observed reality** instead of trusted.
|
||||
|
||||
---
|
||||
|
||||
## The Mission
|
||||
|
||||
> *Where we are going.*
|
||||
|
||||
To become the **evidence plane of Railiance** — collecting, storing,
|
||||
and surfacing metrics, logs, traces, and health signals from every layer, and
|
||||
raising an alert when observed reality diverges from declared intent.
|
||||
|
||||
This means:
|
||||
|
||||
* Evidence is **collected by default**, not instrumented per incident
|
||||
* Signals are **retained long enough to prove a trend**, not just a moment
|
||||
* Alerts describe **a violated expectation**, not a raw threshold
|
||||
* Every layer has a **standard way to emit** its readiness and health
|
||||
* The control loop has a **signal to close on**, so consistency is maintained
|
||||
continuously rather than restored by periodic cleanup
|
||||
|
||||
---
|
||||
|
||||
## Core Principles
|
||||
|
||||
### 1. Evidence over Assertion
|
||||
|
||||
A claim about the system's state is worth what its evidence is worth. This
|
||||
layer's job is to make evidence cheap enough that assertion stops being
|
||||
tempting.
|
||||
|
||||
### 2. Observed, Not Reported
|
||||
|
||||
Signals are gathered from the running system, not from what a deployment
|
||||
process believed it did.
|
||||
|
||||
### 3. One Emission Contract
|
||||
|
||||
Every layer emits health and readiness the same way. A per-layer bespoke
|
||||
integration is a failure of this layer, not of that one.
|
||||
|
||||
### 4. Alerts Carry Meaning
|
||||
|
||||
An alert states which expectation was violated and what depends on it.
|
||||
Thresholds without an owning expectation become noise, and noise trains people
|
||||
to ignore alerts.
|
||||
|
||||
### 5. Retention Serves Proof
|
||||
|
||||
Signals are kept long enough to demonstrate that a restore worked, a rollout
|
||||
held, or a drift began — not merely long enough to draw a dashboard.
|
||||
|
||||
### 6. Non-Custodial
|
||||
|
||||
Telemetry observes; it does not hold secrets, and it never becomes a side
|
||||
channel for credential material or personal data.
|
||||
|
||||
---
|
||||
|
||||
## What This Is (Conceptually)
|
||||
|
||||
The **evidence plane** that sits beside the stack rather than inside one layer
|
||||
of it:
|
||||
|
||||
* the metrics, logs, and trace substrate
|
||||
* the alerting and notification path
|
||||
* the dashboards and health surfaces operators and agents read
|
||||
* the standard emission contract other layers implement
|
||||
* the signal source that automated control loops close on
|
||||
|
||||
---
|
||||
|
||||
## What This Is Not
|
||||
|
||||
* **Not the checks themselves.** Conformance rules, declaration validation, and
|
||||
fleet-consistency checks belong to the layers and repos that own those
|
||||
concerns. This layer carries their signal; it does not define their meaning.
|
||||
* **Not the packaged workload.** The monitoring stack as a deployable is
|
||||
managed-workload-package territory (`rapp-*`), not this repo.
|
||||
* **Not an incident-management or on-call product.**
|
||||
* **Not a data warehouse.** Business and cost analytics belong to their own
|
||||
homes; this layer covers operational evidence.
|
||||
* **Not a secret store or an audit-custody system.** Immutable audit custody is
|
||||
a separate concern with separate guarantees.
|
||||
|
||||
---
|
||||
|
||||
## Open Placement Question
|
||||
|
||||
Railiance's stack dimension defines five levels (S1–S5). Observability is
|
||||
cross-cutting: it draws signal from every level and is consumed by all of them.
|
||||
|
||||
Whether this repo is best modelled as an S3 platform capability (it runs
|
||||
stateful services and is consumed by others), or as a concern on the Quality
|
||||
dimension rather than the Stack dimension, is **not settled here**. It is a
|
||||
decision for `railiance-master`, which owns the taxonomy.
|
||||
|
||||
This is stated explicitly because leaving placement undeclared is exactly how
|
||||
`railiance-forge` ended up outside the stack model without anyone deciding it
|
||||
should be.
|
||||
|
||||
---
|
||||
|
||||
## Direction of Evolution
|
||||
|
||||
This layer is expected to evolve toward:
|
||||
|
||||
* A **standard emission contract** every layer implements
|
||||
* **Expectation-based alerting** tied to declared intent rather than bare thresholds
|
||||
* Retention that can **prove restore drills and rollout holds** after the fact
|
||||
* Signal that automated **control loops close on** without human relay
|
||||
* Evidence surfaces that **agents can query**, not only humans read
|
||||
* Self-evidencing telemetry — the observability layer proves its own health too
|
||||
|
||||
---
|
||||
|
||||
## Guiding Question
|
||||
|
||||
> *Would we find out from the system, or from a person noticing?*
|
||||
151
LICENSE
Normal file
151
LICENSE
Normal file
|
|
@ -0,0 +1,151 @@
|
|||
# Target Revenue Source License
|
||||
|
||||
**Version 1.0, Candidate 1 (V1C1)**
|
||||
|
||||
---
|
||||
|
||||
> **PRELIMINARY CANDIDATE — SUBJECT TO CHANGE — NOT FINAL**
|
||||
>
|
||||
> This repository is governed by the Target Revenue Source License
|
||||
> (TRSL), Version 1, Candidate 1. This is the framework's first working
|
||||
> candidate, adopted as the org's preliminary operating license across
|
||||
> all repos (maintainer decision, 2026-07-29) during the build/alpha
|
||||
> stage — see `SCOPE.md` §1 and Appendix A of the canonical text (link
|
||||
> below) for the alpha/beta risk-acceptance decision this reflects and
|
||||
> what it does and does not mean. Full specialist legal review is
|
||||
> explicitly deferred until the framework moves out of beta.
|
||||
>
|
||||
> **Canonical source, full candidate-status banner, and Appendix A
|
||||
> (non-normative candidate notes tracking every open item):** the
|
||||
> `coulomb` org's `target-revenue` repository,
|
||||
> `specs/TargetRevenueSourceLicense-V1C1.md` — this file is the operative
|
||||
> legal text (Preamble through Section 11) only; the canonical document
|
||||
> is authoritative if this copy and that document ever diverge.
|
||||
|
||||
---
|
||||
|
||||
## Preamble
|
||||
|
||||
This Target Revenue Source License ("**License**") governs the Software identified in the applicable Phase Manifest. It implements the Target Revenue Framework: a defined development Phase accumulates Development Credit and Remission Credit against an immutable Initial Target until the Milestone Release automatically and irrevocably converts to a declared permissive Future License.
|
||||
|
||||
Commercial beneficiaries fund the creation and early availability of a software improvement; once the declared target is satisfied, the governed release becomes permissively open source.
|
||||
|
||||
## 1. Definitions
|
||||
|
||||
Capitalized terms used in this License have the meanings given below. Where a term is also defined in the Phase Manifest or Target Ledger for a specific Phase, the Phase Manifest and Target Ledger govern the *values* (amounts, dates, identifiers) and this License governs the *legal effect* of those values — the two must not be read as conflicting definitions of the same concept.
|
||||
|
||||
**"Commercial Entitlement"** means a right, purchased or otherwise granted under a Commercial Use Agreement, to make Commercial Use of the Software during a Phase.
|
||||
|
||||
**"Commercial Use"** means billing, invoicing, or otherwise charging any customer a fee, subscription, license fee, or other consideration for or in connection with use of the Software, at any time before the Conversion Event for the applicable Phase, regardless of whether the person or organization billed would otherwise qualify for Noncommercial Use. Commercial Use occurs by virtue of such billing alone, whether or not the resulting payment is registered with the Trust Service; in particular, billing a customer for pre-conversion use of the Software without recording the corresponding payment in the applicable Phase's Target Ledger is Commercial Use without a valid Commercial Entitlement — a violation of Section 3, addressed under Section 7 and, where applicable, the Enforcement Network described in the canonical repository's `specs/EnforcementNetworkConcept.md`.
|
||||
|
||||
**"Commercial Use Agreement"** means the separate agreement, referenced by the applicable Phase Manifest, under which a Commercial Entitlement is purchased or granted. This License does not itself set pricing, metering, or payment terms — those are governed by the Commercial Use Agreement.
|
||||
|
||||
**"Conversion Event"** means the moment the Outstanding Target for a Phase reaches zero, as computed from the Phase Manifest and Target Ledger per the Target Ledger Specification. The Conversion Event occurs automatically and is not conditioned on any declaration, attestation, or other act by the Licensor or any Trust Service.
|
||||
|
||||
**"Development Credit"** means the portion of a collected and settled payment explicitly allocated toward satisfying the Initial Target of a specific Phase, as recorded in that Phase's Target Ledger.
|
||||
|
||||
**"Future License"** means the permissive license identified in the applicable Phase Manifest, being either the MIT License or the Apache License, Version 2.0, which applies to the Milestone Release upon the Conversion Event.
|
||||
|
||||
**"Initial Target"** means the immutable monetary target declared for a Phase in its Phase Manifest.
|
||||
|
||||
**"Licensor"** means **Binky Hedgehog GmbH**, the party that publishes the Phase Manifest and holds the rights necessary to grant this License and the Future License for the Milestone Release.
|
||||
|
||||
**"Milestone Release"** means the precisely identified software release designated in the applicable Phase Manifest, identified by an immutable source revision, release artifact, or cryptographic digest.
|
||||
|
||||
**"Noncommercial Use"** means use of the Software for personal purposes, private study, hobby or amateur projects; use by any charitable organization, educational institution, public research organization, or government institution acting in a non-revenue-generating capacity; or other use of a materially similar character.
|
||||
|
||||
**"Outstanding Target"** means, at any time, `max(0, Initial Target − cumulative Development Credit − cumulative Remission Credit)` for a Phase, as computed from that Phase's Target Ledger.
|
||||
|
||||
**"Phase"** means a bounded development undertaking governed by one Initial Target, one Milestone Release, one degeneration policy, and one Future License declaration, as declared in a Phase Manifest.
|
||||
|
||||
**"Phase Manifest"** means the published, immutable declaration identifying a Phase, its Milestone Release, Initial Target, Future License, degeneration policy, and Target Ledger location, as specified in the Phase Manifest Specification.
|
||||
|
||||
**"Remission Credit"** means a transparent, non-revenue reduction of a Phase's Outstanding Target, generated under that Phase's published degeneration policy and recorded in the Target Ledger.
|
||||
|
||||
**"Settled Payment"** means a payment that has cleared through its payment processor and is no longer subject to reversal in the ordinary course (chargeback, dispute, or equivalent), as further specified by the applicable Commercial Use Agreement or monetization extension.
|
||||
|
||||
**"Software"** means the source code, object code, and associated documentation of the Milestone Release identified in the applicable Phase Manifest.
|
||||
|
||||
**"Target Ledger"** means the append-only record of Development Credit, Remission Credit, and correction entries for a Phase, as specified in the Target Ledger Specification.
|
||||
|
||||
**"You"** or **"Licensee"** means the individual or entity exercising rights under this License.
|
||||
|
||||
## 2. Grant of Rights for Noncommercial Use
|
||||
|
||||
Subject to the terms of this License, the Licensor grants You a worldwide, royalty-free, non-exclusive license, during the applicable Phase, to:
|
||||
|
||||
(a) use, reproduce, and study the Software for any Noncommercial Use;
|
||||
|
||||
(b) modify the Software and create derivative works of it for any Noncommercial Use; and
|
||||
|
||||
(c) redistribute the Software and Your modifications, in source or object form, for any Noncommercial Use, provided that You include this License, unmodified, with any such redistribution, and that You do not remove or alter any copyright, patent, trademark, or attribution notices contained in the Software.
|
||||
|
||||
This grant does not extend to Commercial Use. Commercial Use requires a Commercial Entitlement under Section 3.
|
||||
|
||||
## 3. Commercial Use
|
||||
|
||||
You may not make Commercial Use of the Software during the applicable Phase unless You hold a valid, current Commercial Entitlement under a Commercial Use Agreement with the Licensor covering the applicable Phase. A Commercial Entitlement granted under one Phase's Commercial Use Agreement does not extend to a later Phase's Milestone Release unless the Commercial Use Agreement expressly says so.
|
||||
|
||||
This Section 3 states the existence and boundary of the commercial-use restriction. It does not itself set pricing, invoicing, metering, audit rights, or payment terms — those are governed exclusively by the applicable Commercial Use Agreement.
|
||||
|
||||
## 4. Patent License
|
||||
|
||||
Subject to the terms of this License, each contributor to the Software grants You, during the applicable Phase and solely to the extent of rights granted under Sections 2 and 3, a perpetual (subject to the termination below), worldwide, non-exclusive, no-charge, royalty-free patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Software, limited to those patent claims licensable by that contributor that are necessarily infringed by their contribution(s) alone or by combination of their contribution(s) with the Software.
|
||||
|
||||
If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Software or a contribution incorporated within it constitutes direct or contributory patent infringement, then any patent licenses granted to You under this Section 4 for the Software shall terminate as of the date such litigation is filed.
|
||||
|
||||
## 5. Automatic Conversion to the Future License
|
||||
|
||||
**5.1 Automatic effect.** Upon the Conversion Event for a Phase, the rights and restrictions in Sections 3 (Commercial Use) of this License, as they apply to that Phase's Milestone Release, terminate automatically. In their place, the Milestone Release is licensed under the Future License identified in that Phase's Phase Manifest, effective as of the Conversion Event, without any further act, declaration, or attestation required by the Licensor, any Trust Service, or any other party.
|
||||
|
||||
**5.2 Irrevocability.** Once a valid Conversion Event has occurred for a Phase, no subsequent refund, chargeback, accounting correction, dispute, or termination of this License for an unrelated breach shall revoke, suspend, or otherwise impair the Future License grant for that Phase's Milestone Release. Any shortfall or dispute arising after a Conversion Event is a commercial or accounting matter between the relevant parties and does not reinstate a commercial-use restriction over already-converted Software.
|
||||
|
||||
**5.3 Prior freedom preserved.** A later Phase covering subsequent improvements to the Software does not restrict, withdraw, or otherwise affect the rights granted under the Future License for an earlier Phase's already-converted Milestone Release.
|
||||
|
||||
**5.4 Evidence, not cause.** A Trust Service may publish a Conversion Attestation documenting a Conversion Event. Such an attestation is evidence that the Conversion Event occurred; it is not a condition of, and its absence or delay does not postpone, the automatic effect described in Section 5.1. Any person may independently verify whether a Conversion Event has occurred directly from the Phase Manifest and Target Ledger.
|
||||
|
||||
## 6. Successive Phases
|
||||
|
||||
The Licensor may declare a new Phase covering subsequent improvements to the Software following a Milestone Release's Conversion Event. Each Phase is independently governed by its own Phase Manifest, Initial Target, degeneration policy, and Target Ledger. Nothing in a later Phase's Phase Manifest may be construed to reduce or withdraw rights already granted under Section 5 for an earlier Phase's Milestone Release.
|
||||
|
||||
## 7. Term and Termination
|
||||
|
||||
**7.1 Term.** This License applies to the Software for the duration of the applicable Phase, and, for the Milestone Release, indefinitely following that Phase's Conversion Event under the Future License.
|
||||
|
||||
**7.2 Termination for breach.** If You breach Section 3 (Commercial Use) or Section 2(c) (redistribution notice requirement), the Licensor may terminate this License as to You. Before such termination becomes effective, the Licensor shall provide You written notice of the breach; if You cure the breach within thirty (30) days of that notice, this License continues in effect. A second breach of the same provision within twelve (12) months may be terminated immediately without a further cure opportunity.
|
||||
|
||||
**7.3 Effect of termination.** Termination under this Section 7 affects only Your rights under Sections 2 and 3 for the Phase in which the breach occurred. It does not affect any rights already vested under Section 5 (Automatic Conversion) for a Milestone Release whose Conversion Event has already occurred, per Section 5.2.
|
||||
|
||||
**7.4 Public record of breach and resolution.** The Licensor shall cause the Trust Service to publish, as part of the public record for the affected Phase, notice of: (a) any breach notice issued under Section 7.2, stating the general nature of the breach and the date of notice; (b) whether the breach was cured within the applicable cure period, and the date of cure; and (c) any termination determination made under this Section 7, including its effective date and scope. This public record exists to give the ecosystem a transparent, verifiable conformity signal for the Phase, distinct from and in addition to the Development Credit and Remission Credit facts already published under Section 5.4 and the Target Ledger Specification.
|
||||
|
||||
A breach that You dispute, and that has not been finally determined, shall be recorded as **alleged**; it shall be recorded as **determined** only once the cure period has run without cure, or the dispute has been resolved against You under the applicable Commercial Use Agreement's dispute process, if any. The Trust Service shall update the record promptly upon resolution in either direction. Recording an alleged or determined breach under this Section 7.4 is a ministerial act of publishing the Licensor's determination (or a dispute process's outcome); it does not give the Trust Service discretionary authority to decide whether a breach occurred, consistent with Section 5.4's evidence-not-cause principle.
|
||||
|
||||
Whether, and under what conditions, the public record identifies a Commercial Entitlement holder by name is governed exclusively by the applicable Commercial Use Agreement, which the Licensor and that Commercial Entitlement holder negotiate and agree to directly. This License does not itself set a naming default. Where no Commercial Use Agreement addresses the question, or where the affected party has no Commercial Use Agreement at all (for example, a Section 2(c) breach by a Noncommercial Use licensee), the public record states the Phase and breach category only, without naming the party.
|
||||
|
||||
## 8. Disclaimer of Warranty
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NONINFRINGEMENT. THE LICENSOR DOES NOT WARRANT THAT THE SOFTWARE WILL BE ERROR-FREE OR THAT ANY PHASE WILL REACH ITS CONVERSION EVENT.
|
||||
|
||||
## 9. Limitation of Liability
|
||||
|
||||
IN NO EVENT SHALL THE LICENSOR OR ANY CONTRIBUTOR BE LIABLE FOR ANY CLAIM, DAMAGES, OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT, OR OTHERWISE, ARISING FROM, OUT OF, OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE, EXCEPT TO THE EXTENT SUCH LIMITATION IS PROHIBITED BY APPLICABLE LAW.
|
||||
|
||||
## 10. Trademarks
|
||||
|
||||
This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary attribution.
|
||||
|
||||
## 11. General Provisions
|
||||
|
||||
**11.1 Governing law and venue.** Adopted for alpha/beta 2026-07-29: disputes arising under this License shall be resolved by binding arbitration, seated at a neutral, arbitration-mature venue (Singapore or London are the two candidates concretely supported by current research), rather than by litigation in a national court. The specific arbitral institution and substantive governing law remain a per-deployment blank pending final selection; they are not fixed by this candidate. See the canonical repository's `history/260729-TRSL-Jurisdiction-Synthesis.md` §2.
|
||||
|
||||
**11.2 Severability.** If any provision of this License is held unenforceable, the remaining provisions remain in full force, and the unenforceable provision shall be reformed to the minimum extent necessary to make it enforceable.
|
||||
|
||||
**11.3 No waiver.** Failure to enforce any provision of this License is not a waiver of future enforcement of that or any other provision.
|
||||
|
||||
**11.4 Entire agreement (as to licensing).** This License, together with the applicable Phase Manifest and, where applicable, the Commercial Use Agreement, constitutes the entire agreement between You and the Licensor regarding the Software's licensing terms. Operations, service, and consulting arrangements are governed by separate agreements, if any, and are not part of this License.
|
||||
|
||||
**11.5 Definitions control.** Marketing materials, documentation, or other non-normative communications about the Software must not describe pre-Conversion-Event Software as "Open Source," "free software," or "open core." Pre-conversion Noncommercial Use is **source-available**; pre-conversion Commercial Use requires a **Commercial Entitlement**; only post-conversion Software may be described as Open Source, under the Future License.
|
||||
|
||||
---
|
||||
|
||||
**No Phase is currently declared for this repository under this License.** Until a Phase Manifest is published and registered with the Trust Service for a Milestone Release in this repository, Sections 2–7 above have no operative subject matter here — this License establishes the governing framework in advance of that declaration, consistent with the org-wide rollout decision recorded in `target-revenue`'s `workplans/TREV-WP-0008-governance-and-pilot-rollout.md`.
|
||||
30
README.md
30
README.md
|
|
@ -1,3 +1,31 @@
|
|||
# railiance-telemetry
|
||||
|
||||
Observability for railiance providing monitoring, metrics, alerting etc to enable the selforganizing control loop.
|
||||
Observability for Railiance providing monitoring, metrics, alerting etc to
|
||||
enable the self-organizing control loop.
|
||||
|
||||
**Status: seeded.** `INTENT.md` is written; there is no implementation yet. The
|
||||
live cluster currently has no monitoring namespace — this is greenfield.
|
||||
|
||||
## Why this repo exists
|
||||
|
||||
Five Railiance layers independently declare that they intend to be
|
||||
"self-evidencing" or "auditable" — infra, cluster, platform, apps, and forge.
|
||||
None of them owned the place that evidence goes. This repo is that place.
|
||||
|
||||
It owns **the signal**, not **the meaning of the signal**: conformance rules and
|
||||
consistency checks stay with the repos that own those concerns, and telemetry
|
||||
carries and surfaces their output.
|
||||
|
||||
## Start here
|
||||
|
||||
1. [`INTENT.md`](INTENT.md) — why this exists and what it is becoming
|
||||
2. [`SCOPE.md`](SCOPE.md) — in scope, out of scope, how it fits
|
||||
3. [`AGENTS.md`](AGENTS.md) — session protocol
|
||||
4. `workplans/`
|
||||
|
||||
## Open question
|
||||
|
||||
Stack-dimension placement (S3 platform capability, or a Quality-dimension
|
||||
concern outside the stack) is **undecided** and belongs to `railiance-master`.
|
||||
See `INTENT.md` → "Open Placement Question". It is called out explicitly so this
|
||||
repo does not drift into the unplaced state `railiance-forge` ended up in.
|
||||
|
|
|
|||
103
SCOPE.md
Normal file
103
SCOPE.md
Normal file
|
|
@ -0,0 +1,103 @@
|
|||
# SCOPE
|
||||
|
||||
> This file helps you quickly understand what this repository is about,
|
||||
> when it is relevant, and when it is not.
|
||||
> It is intentionally lightweight and may be incomplete.
|
||||
|
||||
---
|
||||
|
||||
## One-liner
|
||||
|
||||
Observability for Railiance — monitoring, metrics, logs, traces, and alerting that turn running behaviour into evidence and give the self-organizing control loop a signal to close on.
|
||||
|
||||
---
|
||||
|
||||
## Core Idea
|
||||
|
||||
Five Railiance layers independently declare that they intend to be
|
||||
"self-evidencing" or "auditable". None of them owned the place that evidence
|
||||
goes, and the live cluster has no monitoring namespace at all. This repo fills
|
||||
that gap: it is the evidence plane the rest of the stack emits into.
|
||||
|
||||
The distinction that keeps this repo honest: it owns **the signal**, not
|
||||
**the meaning of the signal**. Conformance rules and consistency checks belong
|
||||
to the repos that own those concerns; telemetry carries and surfaces their
|
||||
output.
|
||||
|
||||
---
|
||||
|
||||
## In Scope
|
||||
|
||||
- Metrics collection, storage, and query
|
||||
- Log aggregation and retention
|
||||
- Tracing substrate
|
||||
- Alerting rules, routing, and notification paths
|
||||
- Dashboards and operator/agent-facing health surfaces
|
||||
- The standard emission contract other Railiance layers implement
|
||||
- Retention policy sufficient to prove restore drills and rollout holds
|
||||
- Signal exposure that automated control loops consume
|
||||
|
||||
---
|
||||
|
||||
## Out of Scope
|
||||
|
||||
- Conformance and declaration-validation *rules* — owned by the repos whose
|
||||
declarations they check (`railiance-master`, family declaration validator)
|
||||
- The monitoring stack as a deployable package → `rapp-*` territory
|
||||
- Immutable audit custody — a separate concern with separate guarantees
|
||||
- Business, cost, and revenue analytics → `resource-control`, `fin-hub`
|
||||
- Incident management, on-call rotation, paging policy
|
||||
- Secret material of any kind (this layer is explicitly non-custodial)
|
||||
|
||||
---
|
||||
|
||||
## Relevant When
|
||||
|
||||
- A layer needs somewhere to emit health, readiness, or drift signal
|
||||
- An expectation should raise an alert when violated
|
||||
- A control loop needs a signal to close on
|
||||
- Proving after the fact that a restore, rollout, or migration actually held
|
||||
|
||||
## Not Relevant When
|
||||
|
||||
- Defining what "correct" means for a declaration (that is the owning repo's job)
|
||||
- Packaging the monitoring workload for deployment (that is `rapp-*`)
|
||||
- Storing anything sensitive
|
||||
|
||||
---
|
||||
|
||||
## Current State
|
||||
|
||||
- Status: **seeded** — `INTENT.md` written 2026-08-11, no implementation yet
|
||||
- The live cluster has no monitoring namespace; this is greenfield
|
||||
- Open: stack-dimension placement is undecided (see `INTENT.md`, "Open
|
||||
Placement Question") and belongs to `railiance-master`
|
||||
|
||||
---
|
||||
|
||||
## How It Fits
|
||||
|
||||
- Upstream dependencies: `railiance-cluster` (S2) for runtime,
|
||||
`railiance-platform` (S3) for any stateful backing services it needs
|
||||
- Downstream consumers: every layer that declares itself self-evidencing, plus
|
||||
automated control loops and agent planning surfaces
|
||||
- Often used with: `railiance-master` (which owns what the signals must prove),
|
||||
`railiance-fabric` (graph and blast-radius context for an alert)
|
||||
|
||||
---
|
||||
|
||||
## Terminology
|
||||
|
||||
- Preferred terms: evidence plane, emission contract, expectation-based alerting
|
||||
- Potentially confusing: "self-evidencing" is a property *other* layers aspire
|
||||
to; this repo provides the substrate that makes it checkable, it does not
|
||||
make the claims on their behalf
|
||||
|
||||
---
|
||||
|
||||
## Getting Oriented
|
||||
|
||||
- Start with: `INTENT.md`
|
||||
- Then: `SCOPE.md`, `AGENTS.md`, `workplans/`
|
||||
- Context: `railiance-platform/history/2026-08-11-railiance-architecture-in-aspiration.md`
|
||||
records the assessment that identified this gap
|
||||
Loading…
Add table
Add a link
Reference in a new issue