Skip to main content

Infrahub-Sync is a versatile Python package that synchronizes data between a source and a destination system

Project description

Infrahub Logo

Infrahub Sync

Infrahub by OpsMill acts as a central hub to manage the data, templates and playbooks that powers your infrastructure. At its heart, Infrahub is built on 3 fundamental pillars:

  • A Flexible Schema: A model of the infrastructure and the relation between the objects in the model, that's easily extensible.
  • Version Control: Natively integrated into the graph database which opens up some new capabilities like branching, diffing, and merging data directly in the database.
  • Unified Storage: By combining a graph database and git, Infrahub stores data and code needed to manage the infrastructure.

Introduction

Infrahub Sync is a versatile Python package that synchronizes data between a source and a destination system. It builds on the robust capabilities of diffsync to offer flexible and efficient data synchronization across different platforms, including Netbox, Nautobot, and Infrahub. This package features a Typer-based CLI for ease of use, supporting operations such as listing available sync projects, generating diffs, and executing sync processes.

Features

  • Multiple Systems Support: Synchronize data between Netbox, Nautobot, and Infrahub.
  • Flexible Configuration: Define synchronization tasks with YAML configuration files.
  • CLI Interface: Manage sync tasks directly from the command line.
  • Custom Sync Logic: Generate Python code for custom sync adapters and models using provided Jinja templates.

Requirements

Requirements

  • The two latest Infrahub releases
  • Python >=3.9, <3.13
  • Python modules:
    • infrahub-sdk >= 0.12.0

Documentation

Please refer to the Infrahub Sync documentation.

Project Structure

.
├── LICENSE.txt
├── README.md
├── examples
│   ├── infrahub_to_peering-manager
│      ├── config.yml
│      ├── infrahub
│         ├── __init__.py
│         ├── sync_adapter.py
│         └── sync_models.py
│      │
│      └── peeringmanager
│          ├── __init__.py
│          ├── sync_adapter.py
│          └── sync_models.py
│   │
│   ├── ipfabric_to_infrahub
│      ├── config.yml
│      ├── infrahub
│         ├── __init__.py
│         ├── sync_adapter.py
│         └── sync_models.py
│      │
│      └── ipfabricsync
│          ├── __init__.py
│          ├── sync_adapter.py
│          └── sync_models.py
│   │
│   ├── librenms_to_infrahub
│      ├── config.yml
│      ├── infrahub
│         ├── __init__.py
│         ├── sync_adapter.py
│         └── sync_models.py
│      │
│      └── librenms
│          ├── __init__.py
│          ├── sync_adapter.py
│          └── sync_models.py
│   │
│   ├── nautobot-v1_to_infrahub
│      ├── config.yml
│      ├── infrahub
│         ├── __init__.py
│         ├── sync_adapter.py
│         └── sync_models.py
│      │
│      └── nautobot
│          ├── __init__.py
│          ├── sync_adapter.py
│          └── sync_models.py
│   │
│   ├── nautobot-v2_to_infrahub
│      ├── config.yml
│      ├── infrahub
│         ├── __init__.py
│         ├── sync_adapter.py
│         └── sync_models.py
│      │
│      └── nautobot
│          ├── __init__.py
│          ├── sync_adapter.py
│          └── sync_models.py
│   ├── netbox_to_infrahub
│      ├── config.yml
│      ├── infrahub
│         ├── __init__.py
│         ├── sync_adapter.py
│         └── sync_models.py
│      │
│      └── netbox
│          ├── __init__.py
│          ├── sync_adapter.py
│          └── sync_models.py
│   │
│   ├── observium_to_infrahub
│      ├── config.yml
│      ├── infrahub
│         ├── __init__.py
│         ├── sync_adapter.py
│         └── sync_models.py
│      │
│      └── observium
│          ├── __init__.py
│          ├── sync_adapter.py
│          └── sync_models.py
│   │
│   └── peering-manager_to_infrahub
│       ├── config.yml
│       ├── infrahub
│          ├── __init__.py
│          ├── sync_adapter.py
│          └── sync_models.py
│       │
│       └── peeringmanager
│           ├── __init__.py
│           ├── sync_adapter.py
│           └── sync_models.py
│
├── infrahub-sync
│   ├── infrahub_sync
│      ├── __init__.py
│      ├── adapters
│         ├── infrahub.py
│         ├── ipfabricsync.py
│         ├── librenms.py
│         ├── nautobot.py
│         ├── netbox.py
│         ├── observium.py
│         ├── peeringmanager.py
│         ├── rest_api_client.py
│         └── utils.py
│      │
│      ├── cli.py
│      ├── generator
│         ├── __init__.py
│         └── templates
│             ├── diffsync_adapter.j2
│             └── diffsync_models.j2
│      │
│      └── utils.py
│   │
│   └── tests
│       └── __init__.py
│
├── poetry.lock
├── potenda
│   └── potenda
│       └── __init__.py
│
└── pyproject.toml

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

infrahub_sync-1.0.0.tar.gz (28.9 kB view details)

Uploaded Source

Built Distribution

infrahub_sync-1.0.0-py3-none-any.whl (39.4 kB view details)

Uploaded Python 3

File details

Details for the file infrahub_sync-1.0.0.tar.gz.

File metadata

  • Download URL: infrahub_sync-1.0.0.tar.gz
  • Upload date:
  • Size: 28.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.11.8 Darwin/24.0.0

File hashes

Hashes for infrahub_sync-1.0.0.tar.gz
Algorithm Hash digest
SHA256 bdc3f6d5c9ae80160ca0032066695dcf242693b897b4348f4389a8b7e500a870
MD5 92f90d104a6c1305bbca7d8d34aa4632
BLAKE2b-256 ce16a3bd6a387046d210574ddfcbbe6d90072c9493f3ad23cae43b1dadf5b3f4

See more details on using hashes here.

File details

Details for the file infrahub_sync-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: infrahub_sync-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 39.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.11.8 Darwin/24.0.0

File hashes

Hashes for infrahub_sync-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0e3fbb6757cda9974698666b3094a978ab31e03db3752816e3467117cde58ec0
MD5 598f233118c1599cb359c3af4d1de218
BLAKE2b-256 77f4174638d6b50badd9adffff83307cb407ddbe83c64659e77cb52fe14b6c25

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page