playground-diffsync

Description

This repository is just a set of examples around diffsync in order to understand how it works and how you could use it.

Install dependencies

python3 -m venv .venv
source .venv/bin/activate
pip3 install -r requirements.txt

Example 1

Context

The goal of this example is to synchronize some data from PeeringDB, that as the name suggests is a DB where peering entities define their facilities and presence to facilitate peering, towards Nautobot Demo that is a always on demo service for Nautobot, an open source Source of Truth.

In Peering DB there is a model that defines a Facility and you can get information about the actual data center and the city where it is placed. In Nautobot, this information could be mapped to the Region and Site models, where Region can define hierarchy. For instance, Barcelona is in Spain and Spain is in Europe, and all of them are Regions. And, finally, the actual datacenter will refer to the Region where it is placed.

Because of the nature of the demo, we will focus on syncing from PeeringDB to Nautobot (we can assume that PeeringDB is the authoritative System of Record) and we will skip the delete part of the diffsync library.

Show me the code

Inside sync_nautobot_peeringdb we have 3 files:

• models.py: defines the reference models that we will use: RegionMode and SiteModel
• adapter_peeringdb.py: defines the PeeringDB adapter to translate via load() the data from PeeringDB into the reference models commented above. Notice that we don't define CRUD methods because we will sync from it (no to it)
• adapter_nautobot.py: deifnes the Nautobot adapter with the load() and the CRUD methods

from IPython import embed
embed(colors="neutral")

# Import Adapaters
from sync_nautobot_peeringdb.adapter_nautobot import NautobotRemote
from sync_nautobot_peeringdb.adapter_peeringdb import PeeringDB

# Initialize PeeringDB adapter, using CATNIX id
peeringdb = PeeringDB(ix_id=62)

# Initialize Nautobot adapter, pointing to the demo instance (it's also the default settings)
nautobot = NautobotRemote(
    url="https://demo.nautobot.com",
    token="aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
)

# Load PeeringDB info into the adapter
peeringdb.load()

# We can check the data that has been imported, some as `site` and some as `region` (with the parent relationships)
peeringdb.dict()

# Load Nautobot info into the adapter
nautobot.load()

# Let's diffsync do it's magic
diff = nautobot.diff_from(peeringdb)

# Quick summary of the expected changes (remember that delete ones are dry-run)
diff.summary()

# Execute the synchronization
nautobot.sync_from(peeringdb)