Skip to content

Cross-References

Fault Intelligence artifacts are published as linked sets. The parent Alert Definition folder and the three artifact IDs share the same six-digit suffix.

AD000002-bgp-neighbor-admin-shutdown-xr/
  FS000002-...
  RG000002-...
  RAW000002-...
Link Field or convention
FS to parent AD FS.metadata.alert_def_id equals the AD###### folder prefix.
RAW to parent AD RAW.workflow.metadata.alert_def_id equals the AD###### folder prefix.
FS to RAW FS.metadata.repair_action_workflow_ref matches RAW.workflow.metadata.name.
FS variables to RAW inputs FS extraction parameter names match RAW input names and {{ alert_vars.<name> }} sources.
RG to FS/RAW RG front matter/prose names the linked FS and RAW; the aligned ID suffix keeps the set together.

Validation Checklist

  • The folder name starts with the same AD###### suffix used by the contained artifacts.
  • There is exactly one FS, one RG, and one RAW for a normal fault-intelligence set.
  • The RG is Markdown, not YAML.
  • The FS and RAW are YAML and have companion .analysis.md files when generated by ia-create.
  • Variable names extracted by the FS are declared as RAW inputs before use in commands.
  • config_cli.commands[] contains config scope and delta only; human CLI bookends belong in the RG, not the RAW.

Published Indexes

ia-publish maintains:

File Purpose
intelligence-artifacts/index.md Human-readable catalog summary.
intelligence-artifacts/index.json Machine-readable catalog consumed by ia-reader and ia-explorer.