Repository configuration file

The repository configuration file allows you to define multiple resources that need to be imported into Infrahub.

The file should be formatted as a Yaml file, have the filename .infrahub.yml and should be stored at the root of the repository.

info

See this topic for more details on the available repository configuration options

note

To help with the development process of a repository configuration file, you can leverage the schemas we publish for validation within your editor

Check Definitions

Description: User defined checks
Key: check_definitions
Type: array
Item type: InfrahubCheckDefinitionConfig

Property	Type	Description	Mandatory
name	string	The name of the Check Definition	True
file_path	string	The file within the repository with the check code.	True
parameters	object	The input parameters required to run this check	False
targets	string	The group to target when running this check, leave blank for global checks	False
class_name	string	The name of the check class to run.	False

Description: Schema files
Key: schemas
Type: array
Item type: string
Item format: path

Description: Jinja2 data transformations
Key: jinja2_transforms
Type: array
Item type: InfrahubJinja2TransformConfig

Property	Type	Description	Mandatory
name	string	The name of the transform	True
query	string	The name of the GraphQL Query	True
template_path	string	The path within the repository of the template file	True
description	string	Description for this transform	False

Description: Artifact definitions
Key: artifact_definitions
Type: array
Item type: InfrahubRepositoryArtifactDefinitionConfig

Property	Type	Description	Mandatory
name	string	The name of the artifact definition	True
artifact_name	string	Name of the artifact created from this definition	False
parameters	object	The input parameters required to render this artifact	True
content_type	string	The content type of the rendered artifact	True
targets	string	The group to target when creating artifacts	True
transformation	string	The transformation to use.	True

Description: Python data transformations
Key: python_transforms
Type: array
Item type: InfrahubPythonTransformConfig

Property	Type	Description	Mandatory
name	string	The name of the Transform	True
file_path	string	The file within the repository with the transform code.	True
class_name	string	The name of the transform class to run.	False
convert_query_response	boolean	Decide if the transform should convert the result of the GraphQL query to SDK InfrahubNode objects.	False

Description: Generator definitions
Key: generator_definitions
Type: array
Item type: InfrahubGeneratorDefinitionConfig

Property	Type	Description	Mandatory
name	string	The name of the Generator Definition	True
file_path	string	The file within the repository with the generator code.	True
query	string	The GraphQL query to use as input.	True
parameters	object	Maps GraphQL query variable names to target object attribute paths using double-underscore notation.	False
targets	string	Name of the CoreStandardGroup whose members become individual Generator targets. One run is created per group member.	True
class_name	string	The name of the Python class within file_path that extends InfrahubGenerator.	False
convert_query_response	boolean	When true, converts the raw GraphQL dict into SDK InfrahubNode objects accessible via self.nodes and self.store.	False
execute_in_proposed_change	boolean	When true (default), the Generator runs as a CI check during proposed changes.	False
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.	False

Description: GraphQL Queries
Key: queries
Type: array
Item type: InfrahubRepositoryGraphQLConfig

Property	Type	Description	Mandatory
name	string	The name of the GraphQL Query	True
file_path	string	The file within the repository with the query code.	True

Description: Objects
Key: objects
Type: array
Item type: string
Item format: path

Description: Menus
Key: menus
Type: array
Item type: string
Item format: path