IF Commons GitHub

Estate capture policy

0004Active

0004-estate-capture · owner if · domain commons

Requirements

FR-001checkpassing

defineCapturePolicy MUST give a policy in which every field is present, taking from the defaults what is left out: the branch evidence, the controller as collector, managed assets every 15 minutes and adopted assets every day, every capture journaled with the journal committed every hour, nothing pushed to the remote origin, and a seal asked for only with an export; and MUST give every reason, together, where it cannot.

Enforced (check): .github: cd commons/estate && bun run verify — suite/capture.test.ts

Proved by: estate/suite/capture.test.ts

Written in: estate/src/governance/capture.ts

Tests: passed: suite/capture.test.ts no input gives the defaults, a left out field is the default, and every reason is given to

FR-002checkpassing

The branch MUST be a name of a branch that is not the tenant's own (main, master, HEAD, trunk, develop), so that the tenant's branch stays what a person signed.

Enforced (check): .github: cd commons/estate && bun run verify — suite/capture.test.ts

Proved by: estate/suite/capture.test.ts

Written in: estate/src/governance/capture.ts

Tests: passed: suite/capture.test.ts the branch is a name of a branch that is not the tenant's own

FR-003checkpassing

The collector MUST run on controller or on an asset, whose id is an asset id.

Enforced (check): .github: cd commons/estate && bun run verify — suite/capture.test.ts

Proved by: estate/suite/capture.test.ts

Written in: estate/src/governance/capture.ts

Tests: passed: suite/capture.test.ts the collector runs on the controller or on an asset

FR-004checkpassing

A cadence MUST be an ISO 8601 duration above zero and at most seven days, for managed assets, for adopted assets and for each asset named (which MUST be an asset id); the freshness window of a cadence MUST be twice the cadence and never more than seven days.

Enforced (check): .github: cd commons/estate && bun run verify — suite/capture.test.ts

Proved by: estate/suite/capture.test.ts

Written in: estate/src/governance/capture.ts

Tests: passed: suite/capture.test.ts a cadence is a duration above zero and at most seven days, for each kind and each asset na

FR-005checkpassing

The journal MUST be every-capture or changes-and-heartbeat; a heartbeat MUST be given for the second and only for it, MUST be a duration above zero and MUST NOT be longer than the freshness window of any cadence, so that an asset does not look stale between heartbeats; the interval of the journal's commits MUST be a duration above zero.

Enforced (check): .github: cd commons/estate && bun run verify — suite/capture.test.ts

Proved by: estate/suite/capture.test.ts

Written in: estate/src/governance/capture.ts

Tests: passed: suite/capture.test.ts the journal is every capture or changes and a heartbeat, a heartbeat is for the second and

FR-006checkpassing

Pushing MUST be never, after-commit or every, to a remote that has a name; every MUST have an interval above zero, and an interval MUST NOT be given for another mode.

Enforced (check): .github: cd commons/estate && bun run verify — suite/capture.test.ts

Proved by: estate/suite/capture.test.ts

Written in: estate/src/governance/capture.ts

Tests: passed: suite/capture.test.ts pushing is never, after a commit or at an interval, to a named remote, and an interval is

FR-007checkpassing

A seal MUST be never, on-export or daily (a person's seal of the journal's head is due every day), and a requirement written out MUST name a signer where it is not never.

Enforced (check): .github: cd commons/estate && bun run verify — suite/capture.test.ts

Proved by: estate/suite/capture.test.ts

Written in: estate/src/governance/capture.ts

Tests: passed: suite/capture.test.ts a seal is never, with an export or due every day, and a requirement written out names a si

FR-008checkpassing

cadenceOf MUST give the cadence of an asset: its own where one is given, else that of its state, and nothing for a discovered asset.

Enforced (check): .github: cd commons/estate && bun run verify — suite/capture.test.ts

Proved by: estate/suite/capture.test.ts

Written in: estate/src/governance/capture.ts

Tests: passed: suite/capture.test.ts the cadence of an asset is its own, else that of its state, and a discovered asset has non

Acceptance scenarios

  1. Given no input, When the policy is defined, Then it holds the defaults, per FR-001.
  2. Given the branch main, When the policy is defined, Then it is refused, per FR-002.
  3. Given a cadence of eight days, When the policy is defined, Then it is refused, per FR-004.
  4. Given a heartbeat of an hour and managed assets every 15 minutes, When the policy is defined, Then it is refused, because a managed asset would look stale, per FR-005.
  5. Given an adopted asset and a managed asset with a cadence of their own, When the cadence is asked, Then it is the one of their own or that of their state, per FR-008.

Out of scope

  • Collecting, journaling, committing and pushing: the programs that use the policy.
  • Whether the signer a seal names is one of the tenant's signers: the tenant's check.

Edge cases

  • An asset that is discovered has no cadence, per FR-008.

Assumptions

  • Seven days is the longest interval of continuous validation of FedRAMP 20x, as Stolos 073-freshness took it.

Open questions

  • None.

Key entities

  • Capture policy - how the evidence of a tenant's assets is captured, journaled, committed, pushed and sealed.

Success criteria

SC-001success criterion

A policy that would leave an asset looking stale between captures does not compile into a tenant.

Review & acceptance checklist

  • [x] Every requirement is testable (MUST / MUST NOT), not aspirational
  • [x] No company fact is asserted here
  • [x] Every open item is marked, not silently decided

Cited by

governance/capture, Estate

Titles, headings, exports, tables, columns and requirements. Esc closes.