infrahub-generator-creator

Original：🇺🇸 English

Translated

Create and manage Infrahub Generators. Use when building design-driven automation that creates infrastructure objects from templates, topology definitions, or any design-to-implementation workflow in Infrahub.

2installs

Sourceopsmill/infrahub-skills

Added on2026-04-02

NPX Install

npx skill4agent add opsmill/infrahub-skills infrahub-generator-creator

SKILL.md Content

View Translation Comparison →

Infrahub Generator Creator

Overview

Expert guidance for creating Infrahub Generators. Generators query data from Infrahub via GraphQL and create new nodes and relationships based on the result -- enabling design-driven automation where a "design" object automatically creates downstream infrastructure.

When to Use

Building design-driven automation (topology -> devices)
Creating objects from templates or design definitions
Implementing idempotent create-or-update workflows
Auto-generating infrastructure from high-level designs
Understanding the generator tracking system

Rule Categories

Priority	Category	Prefix	Description
CRITICAL	Architecture	`architecture-`	Components, groups
CRITICAL	Python Class	`python-`	Generator, generate()
HIGH	Tracking	`tracking-`	Upsert, idempotent
HIGH	API Ref	`api-`	Constructor, props
HIGH	Registration	`registration-`	.infrahub.yml config
MEDIUM	Patterns	`patterns-`	Cleaning, batch, store
LOW	Testing	`testing-`	infrahubctl commands

Generator Basics

Every generator has three components:

Target group -- objects that trigger the generator
GraphQL query (
```
.gql
```
file) -- fetches the design data
Python class -- inherits from
```
InfrahubGenerator
```
, implements
```
generate()
```

python

from infrahub_sdk.generator import InfrahubGenerator

class MyGenerator(InfrahubGenerator):
    async def generate(self, data: dict) -> None:
        obj = await self.client.create(
            kind="DcimDevice",
            data={"name": "spine-01"},
        )
        await obj.save(allow_upsert=True)

Supporting References

examples.md -- Complete Generator patterns (POP topology, network segment, minimal)
../infrahub-common/graphql-queries.md -- GraphQL query writing reference
../infrahub-common/infrahub-yml-reference.md -- .infrahub.yml project configuration
../infrahub-common/rules/ -- Shared rules (git integration, caching gotchas)
../infrahub-schema-creator/SKILL.md -- Schema definitions Generators work with
rules/ -- Individual rules organized by category prefix