Tooling
Because RFDs are so core to everything we do, we automatically publish a JSON file of all the RFDs along with their state, links, and other information in the repo for easy parsing. This file lives at .helpers/rfd.json. We then have functions in python that allow us to easily get this information and automate or program tooling with RFD data.
This code lives in the configs repo.
As mentioned above, RFD metadata includes "labels" that describe high-level categories that the RFD falls into. The intent is to facilitate tooling around search. Labels are text, separated by commas in metadata. While arbitrary tags can be added, we use the following canonical set of labels for consistency:
-
process: Related to a process of some kind. -
hardware: self-explanatory -
software: self-explanatory -
control-plane: Control-plane related -
host: Host software or hardware related -
virtualization: guest or virtualization related -
boot: self-explanatory -
network: self-explanatory -
storage: self-explanatory -
security: all aspects of security -
metrics: collected metrics -
debug: debugging -
design: related to design in general
