Topics

📄️ .infrahub.yml file format

infrahub-yaml}

📄️ User management and authentication

By default, Infrahub will allow anonymous access in read-only mode. It's possible to disable this via the configuration main.allowanonymousaccess or via the environment variable INFRAHUBALLOWANONYMOUS_ACCESS.

📄️ Activity log

Changes (events) in Infrahub are documented in the Activity log. It helps you see which objects were impacted, when a change was made, and who made it. It can be used to troubleshoot unforeseen changes, audit previous operations, and comprehend the order of updates across various branches.

📄️ Architecture

Infrahub is deployed as a container-based architecture, composed of multiple components. A minimum deployment consists of the following architecture:

📄️ Artifact

An artifact is the result of a Transformation for a specific context and/or object. It can be either plain text or JSON format.

📄️ Check

Checks are user defined logic, stored in an external repository linked to Infrahub, that are run as part of a proposed change. It allows a user to perform any kind of data validation logic during a proposed change. If a check does not complete successfully, then the proposed change cannot be merged.

📄️ Computed attributes

The computed attributes feature enables the dynamic calculation of attribute values based on user-defined logic.

📄️ Data lineage and metadata

Data lineage

📄️ Database backup and restore

Infrahub provides a command-line interface tool to help backup and restore a full Neo4j database. It is designed to be run from almost any host machine and has a much smaller set of requirements than running the full Infrahub application. We use Docker containers to run commands against the Neo4j database to make this tool easier to install.

📄️ Developer Guide

Infrahub support various form of extensibility that rely on users providing their own code that then will be executed by Infrahub.

📄️ Infrahub Events framework

This page is still under construction and is not complete yet.

📄️ Demo environment

A local environment based on Docker Compose is available for demo and testing.

📄️ Generator

A Generator is a generic plugin that queries data and creates new nodes and relationships based on the result.

📄️ GraphQL queries

The GraphQL interface is the main interface to interact with Infrahub. The GraphQL schema is automatically generated based on the core models and the user-defined schema models.

📄️ Groups

Groups in Infrahub allow you to create and manage collections of objects, enabling organized and efficient handling of related entities within your infrastructure. They provide a flexible way to define relationships between different objects and can be extended to suit various use cases through inheritance and customization.

📄️ Hardware requirements

The system on which you want to run Infrahub, has to meet the following hardware requirements:

📄️ IP address management

IP address management, also known as IPAM, is a critical part of any infrastructure involving IP network and address allocations. Depending on the scale of networks, it can be challenging to keep track of all IP resources, how they are used, and which ones remain available.

📄️ Object-storage

Infrahub provides an interface to store and retrieve files or objects in an object-storage. The object-storage is used internally within Infrahub to store rendered artifacts, but it can be used to store any text based file or content.

📄️ Object Template

In many infrastructures, multiple instances of objects share a common structure. Consider network devices: we know in advance the port setup for a given model. When documenting this in our source of truth, repeatedly entering the same port details is both inefficient and error-prone. The Object Template feature allows you to create a reusable blueprint for any object. This blueprint can be used to generate multiple instances that adhere to the predefined structure, ensuring uniformity while reducing manual effort.

📄️ Permissions and Roles

Roles and permissions are essential for controlling user access and behavior in Infrahub. Within the platform, they offer exact control over what users can see, modify, or control.

📄️ Profiles

A profile in Infrahub allow you to define a common set of attributes that should be applied to nodes.

📄️ Proposed change

A proposed change provides a way to review and discuss how two branches differ from each other and to merge a source branch into the target branch. For people with a development background, this will sound very familiar. It’s like a pull or merge request. The proposed change lets you compare two branches, run tests, and finally merge one branch into another.