integrations-lifecycle

Name: integrations-lifecycle
Availability: InStock
Author: netdata

Manage the end-to-end lifecycle of Netdata integration metadata, documentation, and taxonomy artifacts.

80.4k|6.6k|Updated Jun 17, 2013

Search Tags:#pipeline #taxonomy #Automation #Documentation #Metadata #Netdata #Integrations

Ready to run

npx skills add https://github.com/netdata/netdata --skill integrations-lifecycle

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: integrations-lifecycle
Source: https://github.com/netdata/netdata/tree/main/.agents/skills/integrations-lifecycle
Command: npx skills add https://github.com/netdata/netdata --skill integrations-lifecycle

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires jsonschema, referencing, jinja2, ruamel.yaml, markdown-it-py, and includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill addresses the complexity of maintaining consistent documentation and configuration across Netdata's vast ecosystem of collectors, exporters, and notification modules, preventing drift between code and user-facing documentation.

Core Features & Use Cases

Pipeline Orchestration: Automates the generation of per-integration Markdown files, umbrella pages, and dashboard-ready JSON artifacts.
Consistency Enforcement: Ensures that changes to collector code, taxonomy, and configuration schemas remain synchronized through standardized validation rules.
Use Case: When adding a new metric to a collector, use this Skill to validate that the corresponding metadata.yaml, taxonomy.yaml, and config_schema.json are updated correctly before the CI pipeline triggers the documentation regeneration.

Quick Start

Run the integration pipeline locally to validate metadata changes and regenerate documentation for the specified collector module.

Frequently Asked Questions about integrations-lifecycle

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I update documentation for a Netdata collector?▼

Edit the authoritative metadata.yaml file for the collector and run the integration pipeline locally to validate changes. Do not edit generated Markdown files directly, as they are overwritten by the CI pipeline.

What is the collector consistency rule?▼

The collector consistency rule requires that any change affecting a collector's runtime behavior must include matching updates to its metadata.yaml, taxonomy.yaml, config_schema.json, and alert definitions in a single source PR.

Why are my changes to generated Markdown files being overwritten?▼

Generated files contain a 'DO NOT EDIT' banner because they are automatically produced from source metadata.yaml files. Always edit the source metadata and allow the CI pipeline to regenerate the documentation.

How does the dashboard consume integration data?▼

The cloud-frontend dashboard consumes the integrations.js artifact produced by the pipeline. This file contains the structured categories and integration objects used to render the in-app Integrations page.

How do I handle ibm.d module documentation?▼

For ibm.d modules, edit the authoritative contexts.yaml, config.go, or module.yaml files and run 'go generate ./...' to trigger the automatic generation of metadata, README, and schema files.