Infrahub

Repository config definition for Infrahub by OpsMill

Type object
File match .infrahub.yml .infrahub.yaml
Schema URL https://catalog.lintel.tools/schemas/schemastore/infrahub/latest.json
Source https://schema.infrahub.app/python-sdk/repository-config/latest.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Properties

check_definitions InfrahubCheckDefinitionConfig[]

User defined checks

schemas string[]

Schema files

jinja2_transforms InfrahubJinja2TransformConfig[]

Jinja2 data transformations

artifact_definitions InfrahubRepositoryArtifactDefinitionConfig[]

Artifact definitions

python_transforms InfrahubPythonTransformConfig[]

Python data transformations

generator_definitions InfrahubGeneratorDefinitionConfig[]

Generator definitions

queries InfrahubRepositoryGraphQLConfig[]

GraphQL Queries

graphql_fragments InfrahubRepositoryFragmentConfig[]

GraphQL fragment files declared for this repository

objects string[]

Objects

menus string[]

Menus

Definitions

InfrahubCheckDefinitionConfig object
name string required

The name of the Check Definition

file_path string required

The file within the repository with the check code.

format=path
parameters object

The input parameters required to run this check

targets string | null

The group to target when running this check, leave blank for global checks

Default: null
class_name string

The name of the check class to run.

Default: "Check"
InfrahubGeneratorDefinitionConfig object
name string required

The name of the Generator Definition

file_path string required

The file within the repository with the generator code.

format=path
query string required

The GraphQL query to use as input.

targets string required

Name of the CoreStandardGroup whose members become individual Generator targets. One run is created per group member.

parameters object

Maps GraphQL query variable names to target object attribute paths using double-underscore notation.

class_name string

The name of the Python class within file_path that extends InfrahubGenerator.

Default: "Generator"
convert_query_response boolean

When true, converts the raw GraphQL dict into SDK InfrahubNode objects accessible via self.nodes and self.store.

Default: false
execute_in_proposed_change boolean

When true (default), the Generator runs as a CI check during proposed changes.

Default: true
execute_after_merge boolean

When true (default), the Generator runs after a branch merge. Set to false for Generators that only run via event triggers.

Default: true
InfrahubJinja2TransformConfig object
name string required

The name of the transform

query string required

The name of the GraphQL Query

template_path string required

The path within the repository of the template file

format=path
description string | null

Description for this transform

Default: null
InfrahubPythonTransformConfig object
name string required

The name of the Transform

file_path string required

The file within the repository with the transform code.

format=path
class_name string

The name of the transform class to run.

Default: "Transform"
convert_query_response boolean

Decide if the transform should convert the result of the GraphQL query to SDK InfrahubNode objects.

Default: false
description string | null

Description for this transform

Default: null
InfrahubRepositoryArtifactDefinitionConfig object
name string required

The name of the artifact definition

parameters object required

The input parameters required to render this artifact

content_type string required

The content type of the rendered artifact

targets string required

The group to target when creating artifacts

transformation string required

The transformation to use.

artifact_name string | null

Name of the artifact created from this definition

Default: null
InfrahubRepositoryFragmentConfig object
name string required

Logical name for this fragment file or directory

file_path string required

Path to a .gql fragment file or a directory of .gql files, relative to repo root

format=path
InfrahubRepositoryGraphQLConfig object
name string required

The name of the GraphQL Query

file_path string required

The file within the repository with the query code.

format=path