Skip to content

Governance console workflow

The governance console is the product-facing control plane for SkeinRank. It is designed for teams that need to manage terminology safely before it affects search, retrieval, or RAG workflows.

The console should be read as a beta workflow: the core ideas are implemented and testable, while deployment and production hardening are documented separately as the project matures.

DashboardSee setup readiness, runtime state, failed jobs, and next actions.
TermsCreate profiles, canonical terms, aliases, and terminology workspace state.
IntegrationsCreate bindings, run dry-runs, launch enrichment jobs, and inspect graph view.
SnapshotsAudit the active runtime version used by each binding.
Search PlaygroundVerify canonical query output and search hits before integration.

Dashboard

A compact command center for setup progress, system readiness, binding health, recent jobs, and next actions.

Terms

Terminology profiles, canonical terms, aliases, profile management, and evidence checks for terms.

Suggestions

Proposal flow for contributors and review queue for moderators/admins. Supports alias and canonical term suggestions.

Guardrails

Global and profile-scoped stop-list controls that prevent noisy terms or aliases from entering the dictionary.

Integrations

Elasticsearch bindings, dry-runs, enrichment jobs, operator job panel, and topology graph view.

Snapshots

Runtime audit view for active snapshots, stale bindings, pending versions, job history, and rollback availability.

Search Playground

Result-first runtime test page for canonical query preview, matched aliases, runtime snapshot, and search hits.

API Access and Users

Personal tokens, service accounts, roles, account status, and admin controls for API usage.

  1. Start the local beta stack with the Docker beta quickstart.
  2. Open Dashboard and review the setup checklist.
  3. Create or import a terminology profile in Terms.
  4. Add canonical values and aliases.
  5. Use Suggestions and Guardrails if changes need review or stop-list protection.
  6. Create an Elasticsearch binding in Integrations.
  7. Run a dry-run to inspect what would be written.
  8. Run enrichment when the binding is ready.
  9. Check Snapshots to confirm the active runtime version.
  10. Open Search Playground and test a query such as k8s pg timeout.
  11. Use API Access to prepare integration with an external backend or search UI.
  12. Follow the API integration guide to call the runtime endpoints from your application.
RoleIntended behavior
AdminFull control: users, profiles, terms, aliases, tokens, bindings, jobs, snapshots, and service accounts.
ModeratorTerminology editing, suggestions review, guardrails, evidence checks, and operational review.
ContributorRead terminology and submit suggestions for review.

Earlier drafts presented the console as profile CRUD plus runtime snapshot export. The current platform model is binding-first:

Profile defines terminology.
Binding defines runtime search context.
Snapshot defines the immutable version used by that binding.

Runtime snapshots should not be treated as manual files that users export from the Terms page. They are managed through bindings, enrichment jobs, and snapshot audit screens.

Beta positioning

Use “governance console beta” or “platform preview” until the Docker deployment path, upgrade flow, and production hardening are documented and tested end-to-end.