Skip to content

Catalogue Manifest Export

The catalogue manifest helper creates a local, redacted JSON summary from a validated nats-sinks configuration. It is useful when a team needs a reviewable data-product record for a catalogue, governance process, release package, or architecture review.

The helper does not query NATS, Oracle, filesystems, object stores, or any other sink destination. It does not export payloads. It only describes the configuration that would be used by the sink runtime.

CLI

nats-sink export-catalogue-manifest config.json \
  --dataset-name orders-events \
  --output .local/catalogue/orders-events.json

Omit --output to print the manifest to standard output. Existing output files are not replaced unless --overwrite is set.

The manifest includes:

  • stream, consumer, and subject patterns,
  • active and named sink types,
  • routing mode and route target names,
  • priority, classification, and label defaults,
  • mission metadata profile settings,
  • first-party metadata profiles,
  • security-label and custody enablement,
  • allow-listed Oracle lineage fields,
  • selected governance hints from configured mission metadata defaults, and
  • a fully redacted copy of the effective configuration.

Example Shape

{
  "schema": "nats_sinks.catalog_manifest.v1",
  "dataset": {
    "name": "orders-events",
    "stream": "ORDERS",
    "consumer": "file-orders-sink",
    "subject_patterns": ["orders.*"]
  },
  "sinks": {
    "active": "file",
    "named": {}
  },
  "metadata": {
    "mission_metadata_enabled": true,
    "first_party_metadata_profiles": [
      "nats-sinks.artifact-reference.v1",
      "nats-sinks.data-quality.v1",
      "nats-sinks.geo-temporal-track-fix.v1",
      "nats-sinks.object-relationship.v1"
    ],
    "custody_enabled": false
  }
}

Boundaries

The manifest is a review helper, not a catalogue server or compliance certification. It can support NATO-style or enterprise data-catalogue processes by providing consistent metadata, but actual catalogue registration, access control, releasability, retention, and governance decisions remain external.

Secrets are redacted through the same configuration redaction path used by show-effective-config. Do not paste unreviewed local manifests into public issues or documentation if the configuration contains sensitive operational names.