534f179ee6
main was 16 days and 259 commits behind the line the product is actually built on, at contract 0.30.0 against 0.35.0, with no per-PC credential code at all. It was neither current nor curated - just stale. This brings it forward and, at the same time, makes it mean something: main is what a receiving site installs, and nothing else. WHAT IT CARRIES. Twelve plugins - backups, computers, endpoints, guides, knowledgebase, machines, network, notifications, printers, slides, tools, warranty - plus applications, which is manifest-less core and always ships. The only manifest dependency inside that set is endpoints on computers, and both are in it, so the closure is self-contained. WHAT IT DOES NOT. employees, geenforce, measuringtools, printedparts and usb stay on the site line. So do the Windows installer tree, the VM rehearsal helpers, the agent tooling config, one site's data loader, the internal audit and findings records, and the planner spreadsheet. 1,135 tracked files against 1,438. A REMOVAL THAT BREAKS THE APP IS NOT A REMOVAL, and two nearly shipped: deploy/site-profile-universal.json still named all seventeen plugins. It is the file docs/DEPLOY.md tells a site to provision from, so a fresh install would have failed at `flask plugin apply-profile` with PluginError - the first thing a receiving site does, broken by the branch meant to serve them. It now names the twelve that exist, and its comment says the two must agree. agent/ was never refreshed. Whoever populated this branch copied shopdb/, plugins/, frontend/ and tests/ from the site line and left the agent tree at its September state: 22 C# and PowerShell sources missing, including AgentCredentials, EnrollmentService, AgentHttpFactory and the fleet-alert client, plus one file the site line had deleted still present. The old tree is internally consistent, so it compiles, and nothing in CI builds it - every gate was green over a server that speaks enrollment and per-PC credentials to a bundled agent source that cannot. Resynced whole. DECISIONS THIS ENCODES, rather than defers: - The plugin-authoring lab builds printedparts, whose manifest depends on employees, so it could not stay. The lab remains on the site line and main ships no build-along tutorial. That is a real loss for an adopting developer and is recorded here rather than discovered later. - Recognition, Training and Recertification notifications are no longer seeded. Each splits one notification into a card per employee and renders a photo, which needs a plugin this branch does not bundle. Seeding them would offer an author a type that cannot resolve anybody. A site that installs employees gets them from that plugin's own seed. - Windows/IIS is documented as the legacy path throughout, and the README leads with Docker, because that is what a receiving site gets. The API description is regenerated for THIS branch - 347 paths and 483 operations, down from 415 and 573 - so the published contract describes what is here rather than what the site line serves. docs/CONFIG.md lost the two measuring-tool label keys the code no longer declares, which two lanes had decided opposite ways. Suite: 3124 passed, 6 skipped. Naming and style gates pass. The docs gates run rather than skip, and every index line count is derived from the file it names.
53 lines
2.8 KiB
Markdown
53 lines
2.8 KiB
Markdown
<!-- docmeta
|
|
purpose: reference
|
|
audience: developer
|
|
status: current
|
|
summary: How to add a backup kind to the backups plugin - the BackupKind members and what a new kind inherits for free.
|
|
loadwith:
|
|
-->
|
|
|
|
# Adding a fleet config backup kind
|
|
|
|
The recipe for adding a kind to the `backups` plugin - the per-PC CONFIG
|
|
backups the collector takes off shopfloor machines (NTLARS settings,
|
|
part-marker configs). Backing up the ShopDB database itself is
|
|
[BACKUP-RESTORE.md](BACKUP-RESTORE.md); why a Backup badge reads green or red
|
|
is [BACKUP-STALENESS.md](BACKUP-STALENESS.md), and you do not need it here.
|
|
|
|
---
|
|
|
|
A kind is one class in `plugins/backups/services/registry.py`, added to
|
|
`REGISTRY` at the bottom of that file:
|
|
|
|
```python
|
|
REGISTRY = {k.key: k for k in (NtlarsKind(), PartMarkerKind())}
|
|
```
|
|
|
|
Subclass `BackupKind` and override what applies. `NtlarsKind` is the fullest
|
|
example (parseable, renderable, has an info panel); `PartMarkerKind` is the
|
|
lean one.
|
|
|
|
| Member | What it is |
|
|
|--------|------------|
|
|
| `key` | Wire value. This is what lands in `backuprevisions.backupkind` and what the fleet table shows on the badge. Keep it short and lowercase. |
|
|
| `displayname` | Human label for the UI. |
|
|
| `storagebackend` | `'shopdb'` (bytes live in the DB, deduped on a semantic hash) or `'share'` (file lives on the SMB share, deduped on a raw byte hash). |
|
|
| `assettypes` | Which core asset types this kind can attach to; `['*']` for any. |
|
|
| `emptytext` | Text when an asset has no revisions of this kind. `None` HIDES the panel, which is the right default - a kind applies to an asset TYPE, but whether a given machine ever has that backup is per-machine. A part-marker panel on all 144 machines is noise. |
|
|
| `parse(raw)` | Opaque kinds return `None`; parseable kinds return a projection dict. |
|
|
| `formats()` / `render(...)` | Download formats, for `shopdb` kinds. |
|
|
| `resolveassetid(payload)` | Map a collector payload to the asset the backup belongs to. |
|
|
| `infopanel()` / `buildinfo(...)` | Optional at-a-glance card (ADR-010). Declared by the KIND, not hardcoded in the plugin, so a successor technology ships its own card by adding a class. |
|
|
| `sharedir(...)` | Conventional UNC directory for a `share` kind. Advisory - the authoritative path is whatever the collector reported, because the PC is what actually wrote the file. |
|
|
|
|
### What you do NOT have to touch
|
|
|
|
The **Backups stopped** dashboard card needs no change. It reads
|
|
`backuprevisions` generically: newest revision per chain, whatever the kind, and
|
|
shows `backupkind` as the detail line. A new kind inherits the card with no
|
|
work. The staleness rule needs no change either - it is time-based and
|
|
kind-agnostic ([BACKUP-STALENESS.md](BACKUP-STALENESS.md)).
|
|
|
|
Making a kind file against the DEVICE rather than the parent asset it hangs
|
|
under is [ASSET-COMPOSITION.md](ASSET-COMPOSITION.md).
|