Reference documents — reference

Documents (json / csv / md / txt) attached to an entity by their labels — project notes, schemas, runbooks. Unlike the event connectors this is declarative reference material, not a stream: it’s always surfaced when correlating on that entity, regardless of the read time window. A runbook doesn’t “age out” of a 15-minute read.

The config is the data: each attachment carries its own labels and content. Editing the source re-materializes it — there’s no poll interval, and no entity key (correlation is label-native). The labels you tag each document with become real NavFlow labels you can build views on.

Set up

- name: runbooks
  connector: reference
  config:
    attachments:
      - name: restart.md
        format: md
        content: |
          1. kubectl rollout restart deploy/navflow
          2. watch the pod come healthy
        labels: { service: navflow, environment: production }
    labels:
      - { name: service, field: service }
      - { name: environment, field: environment }

Configuration

Each attachments entry:

Verify

Open the source: Recent events shows one event per document; Fields shows the labels they carry. Read the entity they describe — read({ service: navflow }) — and the documents come back in the timeline, even outside the read window.