docs: a structure that keeps device-types vendor- and product-agnostic #37

Open

christianmanivong wants to merge 2 commits from docs/structure-plan into main

pull from: docs/structure-plan

merge into: NAPALM:main

NAPALM:main

NAPALM:fix/ssh-write-without-sudo-stdin

NAPALM:feat/ssh-algorithm-fix

NAPALM:feat/guest-os-provisioning

NAPALM:feat/update-origin-host-status

NAPALM:feat/systemd-services-mixin

NAPALM:feat/vm-cpu-type

NAPALM:feature/vmid-as-string

NAPALM:feat/OSDriver

NAPALM:feature/create-vm-from-image

NAPALM:feature/network-target-vlan-tag

NAPALM:feature/network-targets

NAPALM:feature/generic-vm-provisioning

Conversation 0 Commits 2 Files Changed 1

+241

christianmanivong commented 2026-10-14 08:23:27 +00:00

Owner

Copy link

Copy source

Adds docs/STRUCTURE.md, the agreed plan:

• This package keeps roles, capabilities, templates, models and I/O-free reconcilers.
• POSIX host readers, the SSH exec transport and the privilege layer move to a new package, napalm-unix.
• SNMP polling, ping sweeps, discovery scoring, guest profiles, display labels and warnings belong to the application. Drivers declare SNMP OIDs as data and report facts.
• Fixes become templates whose values come from the caller.

Documentation only. The steps are tracked in NetOrk/netork#1105: #32, #33, #34, #35, #36.

Adds `docs/STRUCTURE.md`, the agreed plan: - This package keeps roles, capabilities, templates, models and I/O-free reconcilers. - POSIX host readers, the SSH exec transport and the privilege layer move to a new package, napalm-unix. - SNMP polling, ping sweeps, discovery scoring, guest profiles, display labels and warnings belong to the application. Drivers declare SNMP OIDs as data and report facts. - Fixes become templates whose values come from the caller. Documentation only. The steps are tracked in NetOrk/netork#1105: #32, #33, #34, #35, #36.

christianmanivong added 1 commit 2026-10-14 08:23:27 +00:00

docs: a structure that keeps device-types vendor- and product-agnostic ... 01fe680456

Roles and capabilities declare, templates run declared steps, reconcilers
stay free of I/O. POSIX host readers, the SSH exec transport and the
privilege layer move to a new package, napalm-unix. SNMP polling, ping
sweeps, discovery scoring, guest profiles, display labels and warnings
belong to the application; drivers declare SNMP OIDs as data and report
facts. Fixes become templates whose values come from the caller.

Says in which order this happens and where the open proposals #8-#14 and
#22 go instead.

christianmanivong referenced this pull request 2026-10-14 08:23:27 +00:00

netmiko session: one open/close/is_alive/_send_command for the SSH CLI drivers #8

christianmanivong referenced this pull request 2026-10-14 08:23:27 +00:00

CLI switches: a config-mode mixin for netgear_smart, tplink_jetstream and procurve #9

christianmanivong referenced this pull request 2026-10-14 08:23:27 +00:00

LLDP: one row table, two projections (neighbors and detail) #10

christianmanivong referenced this pull request 2026-10-14 08:23:27 +00:00

pure CLI text helpers: uptime, port ranges, key/value lookup, port sort, route table, LAG rows #11

christianmanivong referenced this pull request 2026-10-14 08:23:27 +00:00

ping: one Unix ping parser and one reply builder #12

christianmanivong referenced this pull request 2026-10-14 08:23:27 +00:00

Linux userland helpers shared by linux, proxmox and openwrt (snmpd, lldpctl, apk, package names) #13

christianmanivong referenced this pull request 2026-10-14 08:23:27 +00:00

run_device_action: one dispatcher, and the contract the drivers actually follow #14

christianmanivong referenced this pull request 2026-10-14 08:23:27 +00:00

Move the _run_*_command hooks onto run_command #22

christianmanivong added 1 commit 2026-10-14 08:56:18 +00:00

docs: what the drivers need from the SNMP profile, opt-outs, and how getters behave ... c7ea15dbb4

The SNMP profile has to express fallback OIDs, tables folded by first,
average or maximum, numbers inside text values, memory as used, free or
percent, and the uptime source. TX errors counting drops becomes
OPNsense's entry instead of every firewall's.

A driver opts out of an inherited template with None, so callers ask
callable(). USES_SSH, FULL_UPGRADE and platform stay as driver facts.
Getters do not write, a failed read raises, a write reports its real
result, and the application uses public driver methods only.

christianmanivong referenced this pull request from NAPALM/napalm-opnsense 2026-10-14 08:58:50 +00:00

Agnostic structure: fix_snmp template, ping batch, neutral markers #16

christianmanivong referenced this pull request from NAPALM/napalm-openwrt 2026-10-14 08:58:51 +00:00

Agnostic structure: fix templates, facts instead of warnings, shared parsers #13

christianmanivong referenced this pull request from NAPALM/napalm-proxmox 2026-10-14 08:58:51 +00:00

Agnostic structure: fix templates, guest profile from the caller, napalm-unix transport #24

christianmanivong referenced this pull request from NAPALM/napalm-hpe-aruba-procurve 2026-10-14 08:58:52 +00:00

Agnostic structure: SNMP profile and fix_snmp template #12

christianmanivong referenced this pull request from NAPALM/napalm-netgear 2026-10-14 08:58:52 +00:00

Agnostic structure: SNMP profile, fix template, firmware catalogue out #8

christianmanivong referenced this pull request from NAPALM/napalm-tplink-jetstream 2026-10-14 08:58:52 +00:00

Agnostic structure: SNMP profile and fix_snmp template #4

christianmanivong referenced this pull request from NAPALM/napalm-hpe-officeconnect 2026-10-14 08:58:52 +00:00

Agnostic structure: wording only #4

christianmanivong referenced this pull request from NAPALM/napalm-zyxel 2026-10-14 08:58:53 +00:00

Agnostic structure: run_device_action and invented facts #6

christianmanivong referenced this pull request from NAPALM/napalm-fritzbox 2026-10-14 08:58:53 +00:00

Agnostic structure: facts instead of warnings #4

christianmanivong referenced this pull request from NAPALM/napalm-sonos 2026-10-14 08:58:53 +00:00

Agnostic structure: drop the run_device_action wrapper #3

christianmanivong referenced this pull request from NAPALM/napalm-yealink 2026-10-14 08:58:53 +00:00

Agnostic structure: drop the SNMP stub; tracked artefacts #2

christianmanivong referenced this pull request from NAPALM/napalm-vmware 2026-10-14 08:58:53 +00:00

Agnostic structure: facts instead of warnings, guest profile from the caller #5

christianmanivong referenced this pull request from NAPALM/napalm-windows 2026-10-14 08:58:53 +00:00

Agnostic structure: own ROLE, metadata #3

christianmanivong referenced this pull request from NAPALM/napalm-qnap-qts 2026-10-14 08:58:53 +00:00

Agnostic structure: opt out of Linux templates; follow napalm-unix #7

christianmanivong referenced this pull request from NAPALM/napalm-openmediavault 2026-10-14 08:58:54 +00:00

Agnostic structure: facts, Linux templates, tracked artefacts #6

christianmanivong referenced this pull request from NAPALM/napalm-redfish 2026-10-14 08:58:54 +00:00

Agnostic structure: no SNMP collection, facts instead of a warning #1

christianmanivong referenced this pull request from NAPALM/napalm-hpe-aruba-procurve 2026-10-14 08:59:08 +00:00

use napalm-device-types helpers; remove dead _detect_management_vlan #6

christianmanivong referenced this pull request 2026-10-16 09:11:16 +00:00

fix: keep CARP state knowledge out of the base package (4.10.1) #39

christianmanivong referenced this issue from a commit 2026-10-16 09:11:16 +00:00

fix: keep CARP state knowledge out of the base package (4.10.1)

christianmanivong referenced this pull request 2026-10-16 13:18:35 +00:00

feat: an HA pair's DHCP peers and config sync as facts (4.11.0) #42

All checks were successful

Hide all checks

CI / test (3.10) (push) Successful in 26s

Details

CI / test (3.11) (push) Successful in 24s

Details

CI / test (3.12) (push) Successful in 26s

Details

CI / test (3.13) (push) Successful in 25s

Details

CI / test (3.10) (pull_request) Successful in 25s

Details

CI / test (3.11) (pull_request) Successful in 24s

Details

CI / test (3.12) (pull_request) Successful in 26s

Details

CI / test (3.13) (pull_request) Successful in 25s

Details

You are not authorized to merge this pull request.

This pull request can be merged automatically.

This branch is out-of-date with the base branch

View command line instructions

Checkout

From your project repository, check out a new branch and test the changes.

git fetch -u origin docs/structure-plan:docs/structure-plan

git checkout docs/structure-plan

Sign in to join this conversation.

Reviewers

No Reviewers

Labels

Clear labels

bug

Something is broken

enhancement

New feature or request

tech-debt

Refactoring / cleanup / deferred debt

prio

P0

Road blocker: blocks other work, drop everything

prio

P1

Critical

prio

P2

Important and urgent

prio

P3

Important, not urgent

prio

P4

Neither important nor urgent

No labels

Milestone

No items

No Milestone

Projects

Clear projects

No projects

Assignees

Clear assignees

christianmanivong

No Assignees

1 Participants

Notifications

Subscribe

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: NAPALM/napalm-device-types#37