| 1 | # Recipes -- INDEX |
| 2 | |
| 3 | Step-by-step recipes for the most common integration-lifecycle |
| 4 | tasks a maintainer (or AI assistant) performs. |
| 5 | |
| 6 | | Recipe | When to use | |
| 7 | |---|---| |
| 8 | | `add-go-collector.md` | Adding a new go.d module from scratch (most common case). | |
| 9 | | `update-collector.md` | Modifying an existing collector's metrics, config, alerts, or docs. | |
| 10 | | `add-ibm-d-module.md` | Adding a new ibm.d module (where `metadata.yaml` is generated). | |
| 11 | | `add-cloud-notification.md` | Adding a new cloud-notification destination. | |
| 12 | | `add-secretstore-backend.md` | Adding a new secretstore backend. | |
| 13 | | `add-service-discovery.md` | Adding a new service-discovery discoverer. | |
| 14 | | `regenerate-locally.md` | Running the full pipeline locally to verify your changes before pushing. | |
| 15 | |
| 16 | ## Common preamble for all recipes |
| 17 | |
| 18 | Every recipe assumes you are in the agent repo root. Install |
| 19 | the Python deps once per machine: |
| 20 | |
| 21 | ```bash |
| 22 | ./integrations/pip.sh |
| 23 | ``` |
| 24 | |
| 25 | That installs `jsonschema`, `referencing`, `jinja2`, |
| 26 | `ruamel.yaml` -- the four packages `gen_integrations.py` |
| 27 | needs. |
| 28 | |
| 29 | For fast iteration during development, prefer `-c plugin/module` |
| 30 | scoping on `gen_docs_integrations.py` to skip cleaning/ |
| 31 | regenerating other directories: |
| 32 | |
| 33 | ```bash |
| 34 | python3 integrations/gen_docs_integrations.py -c go.d.plugin/<your-module> |
| 35 | ``` |
| 36 | |
| 37 | ## When in doubt |
| 38 | |
| 39 | 1. Read `pipeline.md` for the end-to-end flow. |
| 40 | 2. Read `schema-reference.md` for the exact field your |
| 41 | `metadata.yaml` change needs. |
| 42 | 3. Read `consistency.md` for the collector consistency rule. |
| 43 | 4. Read `gotchas.md` BEFORE assuming the pipeline does the |
| 44 | obvious thing. |
| 45 | 5. If you encountered a question that this catalog doesn't |
| 46 | cover and you had to investigate to answer it, AUTHOR a |
| 47 | how-to under `../how-tos/<slug>.md` and add it to |
| 48 | `../how-tos/INDEX.md`. This rule is mandatory; see |
| 49 | `../SKILL.md` "Live how-to rule". |