Config

Config is the tree where capacity services, parameter objects, resource pools, and device CLI live. It is not the YAML file on disk (/etc/factum2/factum2.yaml); that file only has database, web, worker, and similar process settings.

Tree (primary)

The page is a tree with an inspector and a Preview dock. Right-click to add folders, sites, locations, parameter objects, resource objects, CLI objects, and services, or to attach a device. Drag to move a node (the API rejects illegal parents).

Kind	What it is
Folder / region / site / location	Organizational. Region, site, and location are folder variants. NetBox sync creates these under global.
Device	A DCIM device. NetBox sync places each device under its site (or under global when it has none). Detach does not delete inventory. Interfaces are managed children.
Parameter object	Named assignments (MTU, AS number, …). They apply to the parent and its descendants.
Resource	Named CIDR list used by prefix fields on a service definition. Place on a site, device, or interface — not under a service node.
CLI object	Per-NOS command templates (features with add/remove). Baseline objects sit on the ancestor chain; service translation lives under _catalog/cli.
Service	A capacity Service row (create or attach a definition). Endpoints are homogeneous interfaces in the inspector. Virtual refs appear under involved ports.

Reserved folders (global, _catalog, _services) are system folders and cannot be dragged. Interfaces cannot be dragged either (they follow the device). Put service-translation CLI under _catalog/cli/<type>/<platform>. Put global baseline CLI as a direct child of global, not under _catalog — _catalog is not on a PE’s ancestor chain, so baseline objects there would never preview.

Matrix is an audit view: one variable across interfaces under the selected folder or device (or the nearest such ancestor).

CLI objects

A CLI object is one platform’s command templates. Each feature has an add blob and a remove blob (Jet template). v1 always remove-then-add; the update field is hidden.

Context (inspector) is optional wrapping, not a free-form regex:

• Empty / global — emit remove then add as-is. Use this for SR OS block-paste and for whole-service add/remove blobs.
• enter set (for example interface {{.LocalIface}}) — one enter, then remove, then add, then exit. Tick remove at root if teardown must stay at configure root (no / delete of a service object).

Translation objects are looked up globally by service type + platform (sros-md falls back to sros). Huawei vrp applies the same way as the other CLI platforms (system-view session).

Devices and services

Attach an existing DCIM device; Factum does not create routers from this tree. NetBox sync does that attach for every device and keeps the device under its site. Detach removes the device from the tree and its config children (parameters, CLI, interfaces). The inventory row stays. The next sync places a NetBox device back under its site.

A service node is the same CN/CI row as on the Services page. Create from the tree: pick a definition (Config → Catalog → Service definitions — Factum ships none), then the form for that definition. The row is written with no endpoints unless you fill the interface slots; save must meet the definition’s min/max. Virtual refs show under each involved port (two VLANs on one port are two refs). Default delete on the tree detaches the node; the service row remains. Unrealize (inspector or Services dialog) drops type and endpoints and keeps a Lime/commercial row.

Catalog

Catalog (button on the Config page) holds definitions that are not tree nodes:

Panel	What it is
Variables	Typed knobs. Assign values on a parameter object.
Service types	Definitions you create: fields, interfaces (min/max), connection types, NetBox mapping. No built-in products.
Macros	Reusable CLI fragments (include "name")

Operators with write permission add variable defs, types, and macros here. CLI objects are added from the tree (translation under _catalog/cli/<type>/<platform>). Adding a capacity product is a catalog definition plus CLI objects, not a new Go package.

Export and import

Export and Import on the Config page move definitions as one JSON file (factum2-config). Check a service definition such as ELINE and leave Include related objects on to take:

• its translation CLI objects (_catalog/cli/<type>/<platform>, and any CLI object whose service type is that definition)
• macros those templates include, including nested includes
• variable definitions the templates read, and any variable assigned on an exported parameter object
• parameter objects that assign those variables

You can also check CLI objects, macros, and parameter objects on their own.

Import matches by definition name, macro name, variable name, CLI path (or service type + platform), and parameter path. It updates those objects. Features, connection types, and assignments on the objects in the file are replaced. Other definitions stay. Missing folders on a path are created. A device or service named in the path must already be attached in the tree.

Secret values are left out unless Include secret values is checked. On import, an omitted secret keeps the value already stored. A new required secret with no value fails the import; the whole file is one transaction.

How a push uses this

1. The service has a service type and endpoints (created or attached in the tree, or from the Services page).
2. Each endpoint's device has a platform. Factum picks the CLI object for that type + NOS (under _catalog/cli).
3. Feature blobs are rendered with the service, endpoints, macros, and resolved parameter values.
4. The driver applies the CLI to the device, logging in with Admin → Device sync credentials (a per-device override, or the default row). The same stored auth is used when the tree rebinds a pushed endpoint or unrealizes with “remove from device”.

Use Preview on this page against a device before pushing a new CLI object from the service dialog. Push is still service-only; baseline CLI is preview-only.

Inheritance

A parameter object applies to its parent and that parent's descendants: a variable set on a site-level object applies to devices under that site unless a closer object overrides it. Synced devices sit under their site, so they pick up those values.

A resource is a named CIDR list. Prefix fields on a definition that set resource pick a free prefix from the closest matching resource on the interface → device → ancestors → global walk (not from a pool under the service node). Occupancy is last-write-wins.