netbox-discovery-quickstart: add macOS support via Lima VM, fix NetBox/Diode plugin version mismatch - #104
Open
domfee wants to merge 1 commit into
Open
netbox-discovery-quickstart: add macOS support via Lima VM, fix NetBox/Diode plugin version mismatch#104domfee wants to merge 1 commit into
domfee wants to merge 1 commit into
Conversation
…x/plugin version mismatch - Add 0_macos_create_vm.sh: bootstraps a Lima-managed x86_64 Ubuntu VM sized for this workload. A native arm64 VM was tried first, but the Nokia SR Linux lab images' system daemons boot-loop under QEMU's per-process binfmt emulation (they need real kernel/ioctl behavior a full x86_64 guest kernel provides). - Bump 3_start_netbox.sh from netbox-docker 3.3.0 / NetBox v4.3.7 to netbox-docker 5.0.2 / NetBox v4.6.7, and pin the Diode plugin to 1.14.1. The unpinned plugin install now resolves to a release that requires NetBox >=4.4.10, so the pinned v4.3.7 base silently failed to load the plugin. Also raises the NetBox healthcheck start_period to 1800s to match realistic first-migration timing under virtualization/emulation. - Document the above in README.md, plus a Troubleshooting section covering issues encountered getting this working end-to-end: Diode's nginx caching stale upstream IPs after container restarts, Device Discovery's bulk NetBox writes timing out under CPU-constrained emulation, Diode's ingestion-log dedup permanently blocking retries of previously-failed content, and NetBox 4.6's new v2 API token format for anyone scripting against the API directly. Verified end-to-end on macOS (Apple Silicon): Network Discovery and Device Discovery both land correct data in NetBox (IPs, device type/platform/status, full interface data including MAC/MTU/speed). Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Contributor
|
Hey @domfee I'm not in front of laptop but this seems reasonable. I would just ask to bots to make sure that this enables MacOS but doesn't disable Linux in doing so. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds macOS support to the NetBox Discovery quickstart, and fixes a real (platform-independent) version-compatibility bug hit along the way.
Changes
0_macos_create_vm.sh(new)ContainerLab has no native macOS support, and the Nokia SR Linux lab images are x86_64-only. A native arm64 Lima VM was tried first, but SR Linux's system daemons boot-loop under QEMU's per-process binfmt emulation — they need kernel/ioctl behavior that only a genuine x86_64 kernel provides. This script bootstraps a Lima-managed x86_64 Ubuntu 25.04 VM sized for the workload (11 CPUs / 16GiB RAM by default — fewer CPUs caused Device Discovery's bulk NetBox writes to time out under emulation) and prints the next commands to run inside it.
3_start_netbox.shBumped
netbox-dockerfrom3.3.0(paired with NetBox v4.3.7) to5.0.2(paired with NetBox v4.6.7), and pinned the Diode plugin to1.14.1. The script previously installed the plugin unpinned, which now resolves to a release requiring NetBox >=4.4.10 — so on the pinned v4.3.7 base, the plugin silently failed to load (Unable to load plugin netbox_diode_plugin: ... requires NetBox minimum version 4.4.10 (current: 4.3.7)), and neither Network Discovery nor Device Discovery could actually reach NetBox. This isn't macOS-specific — anyone running the quickstart fresh right now would hit it. Also raised the NetBox healthcheckstart_periodfrom 600s to 1800s to match realistic first-migration timing on a freshly-provisioned host.README.md0_macos_create_vm.sh.su - quickstartstep, and realistic migration timing.netbox-docker-netbox-housekeeping-1exiting once on a benign first-boot raceVerification
Ran the full quickstart end-to-end on macOS (Apple Silicon) via the new Lima VM path: NetBox + Diode plugin load correctly, Network Discovery lands all expected IPs in IPAM, and Device Discovery lands both SR Linux devices in DCIM with correct Device Type/Platform/Status and full interface data (MAC address, MTU, speed) including the inter-device link
ethernet-1/1.🤖 Generated with Claude Code