generated from coulomb/repo-seed
111 lines
3.3 KiB
Markdown
111 lines
3.3 KiB
Markdown
# Railiance Fabric
|
|
|
|
Railiance Fabric defines the repo-owned declaration model for the Railiance
|
|
ecosystem graph.
|
|
|
|
It will hold schemas, seed declarations, validation tools, graph queries, and
|
|
State Hub export contracts for services, capabilities, interfaces,
|
|
dependencies, and bindings across Railiance repositories.
|
|
|
|
## Validate Declarations
|
|
|
|
From a checkout with the Python dependencies installed:
|
|
|
|
```bash
|
|
railiance-fabric validate .
|
|
```
|
|
|
|
During early bootstrapping, the local module entry point works too:
|
|
|
|
```bash
|
|
PYTHONPATH=. python -m railiance_fabric.cli validate .
|
|
```
|
|
|
|
The validator loads `fabric/` declarations, checks schema conformance, verifies
|
|
catalog type names, catches missing references/providers, checks active
|
|
production dependency source links, and warns about dependency cycles.
|
|
|
|
## Query The Graph
|
|
|
|
```bash
|
|
railiance-fabric providers runtime-secrets
|
|
railiance-fabric consumers railiance-platform.openbao.kv-v2
|
|
railiance-fabric dependency-path flex-auth.api
|
|
railiance-fabric unresolved
|
|
railiance-fabric blast-radius openbao-kv-v2-mount
|
|
railiance-fabric export --format json
|
|
railiance-fabric export --format mermaid
|
|
railiance-fabric export --format graph-explorer
|
|
```
|
|
|
|
See `docs/discovery-queries.md` for command details.
|
|
|
|
## Adopt In Another Repo
|
|
|
|
See `docs/adoption-guide.md` for the declaration workflow and
|
|
`docs/first-rollout.md` for the initial Railiance repo rollout.
|
|
|
|
## Next: Ecosystem Registry Service
|
|
|
|
See `docs/ecosystem-registry-service.md` for the standards comparison and
|
|
service direction for registering repos and interacting with the combined
|
|
ecosystem model. See `docs/registry-api.md` for the current registry HTTP API.
|
|
|
|
Start the first registry service slice with:
|
|
|
|
```bash
|
|
railiance-fabric-registry --db .railiance-fabric/registry.sqlite3 --port 8765
|
|
```
|
|
|
|
The initial service exposes repository registration, graph snapshot ingestion,
|
|
artifact attachment, graph query endpoints, State Hub export, and early
|
|
Backstage/xRegistry projection endpoints. It stores snapshots in SQLite and
|
|
reuses the Fabric graph export shape.
|
|
|
|
Feed the running service from this checkout:
|
|
|
|
```bash
|
|
railiance-fabric registry sync --repo-slug railiance-fabric .
|
|
```
|
|
|
|
Or register and sync the known local Railiance ecosystem repos from the
|
|
onboarding manifest:
|
|
|
|
```bash
|
|
railiance-fabric registry sync-manifest registry/railiance-repos.yaml
|
|
```
|
|
|
|
To onboard every active State Hub repo with an available local checkout on this
|
|
host:
|
|
|
|
```bash
|
|
railiance-fabric registry sync-manifest registry/local-repos.yaml
|
|
```
|
|
|
|
Ingest a CycloneDX SBOM as queryable library inventory:
|
|
|
|
```bash
|
|
railiance-fabric registry ingest-cyclonedx bom.json --repo-slug railiance-fabric
|
|
```
|
|
|
|
Useful inspection endpoints include:
|
|
|
|
```text
|
|
GET /repositories/{repo_slug}/inventory
|
|
GET /repositories/{repo_slug}/snapshots
|
|
GET /repositories/{repo_slug}/snapshots/diff
|
|
GET /search?q=jsonschema
|
|
GET /ui/graph-explorer
|
|
GET /exports/graph-explorer/manifest
|
|
GET /exports/graph-explorer
|
|
```
|
|
|
|
See `docs/registry-onboarding.md` for the multi-repo manifest and operating
|
|
loop.
|
|
|
|
The graph explorer export is the first executable slice of the interactive
|
|
Fabric map. See `docs/graph-explorer-transfer-review.md` for the repo-scoping
|
|
transfer review, `docs/graph-explorer-contract.md` for the shared manifest and
|
|
payload contract, and `docs/graph-explorer-operations.md` for launch, refresh,
|
|
verification, and extraction guidance.
|