https://github.com/wikimedia/homer

Dynamically configure Juniper network devices using metadata from Netbox. Mirror of https://gerrit.wikimedia.org/g/operations/software/homer. Contribute via Gerrit
https://github.com/wikimedia/homer

Last synced: 6 days ago
JSON representation

Dynamically configure Juniper network devices using metadata from Netbox. Mirror of https://gerrit.wikimedia.org/g/operations/software/homer. Contribute via Gerrit

• Host: GitHub
• URL: https://github.com/wikimedia/homer
• Owner: wikimedia
• License: gpl-3.0
• Created: 2019-07-25T23:14:03.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2025-05-12T08:40:17.000Z (about 1 month ago)
• Last Synced: 2025-05-12T09:49:49.408Z (about 1 month ago)
• Language: Python
• Homepage: https://www.mediawiki.org/wiki/Developer_access
• Size: 276 KB
• Stars: 13
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
Homer - Configuration manager for network devices

-------------------------------------------------

Homer allows to manage the lifecycle of the configuration for network devices, generating and deploying their

configuration.

The configuration generation is based on ``YAML`` files to define variables and ``Jinja2`` templates.

The ``YAML`` files allow for hierarchical override of variables based on the device role, site or hostname.

Once generated, the configuration can be deployed to the selected devices.

The device list can either live hardcoded in the configuration files or be dynamically gathered from Netbox.

When using Netbox as inventory both the Virtual Chassis endpoint and the Device endpoint are used to select

all the devices that matches the configured whitelist of device roles and statuses.

Also when using Netbox as inventory for each device additional metadata is exposed to the templates, namely:

- ``role``: device role slug

- ``site``: device site slug

- ``type``: device type slug

- ``ip4``: primary IPv4 without netmask

- ``ip6``: primary IPv6 without netmask

- ``netbox_object``: the Netbox device object. Directly exposed data should always be preferred in templates.

  It is exposed to not be a blocker in case some additional data is needed that is not yet exposed by

  Homer explicitely. It could be removed in a future release.

If any metadata is present in the ``YAML`` inventory file when using Netbox as inventory, this additional metadata

ie exposed too to the templates, with the Netbox values having precedence in case of overlapping keys.

When using Netbox to gather dynamic configuration, it's also possible to write a custom plugin in the form of a

Python module that implements a class called ``NetboxDeviceDataPlugin`` that inherits from

`homer.netbox.BaseNetboxDeviceData` and is in the Python ``PATH``.

Assuming that the plugin class implements a method named ``_get_name``, it will be accessible within the templates

with ``netbox.device_plugin.name``.

Homer can use GraphQL to fetch Netbox data. For that, store your query in the ``basepath``/public/graphql directory.

And reference it using ``_gql_execute(filename, variables)``.