docs: local_libvirt overlay binds on host_uri and renames the row, an unmatched host_uri warns

Open Beginner friendly
  • Is something wrong?
#3,593 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
1-3 hours
Newbie friendliness
82/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
python
Domain
documentation

Research direction

Update the claims in systems.toml.example, docs/operating/runbooks/image-lifecycle.md, and docs/operating/providers/examples/systems-local-libvirt.toml. Read the cited _overlay_one_local implementation in src/kdive/inventory/reconcile/resources.py to confirm how host_uri, name, warnings, and pool behave. Done when the docs describe those behaviors accurately; the proposed reconcile run is optional evidence for the docs-only change.

Written by the indexing model from the issue text.

Description

area:providers effort:S priority:P3 risk:night-safe status:ready type:docs

Problem

The example config and the egress runbook tell operators the [[local_libvirt]] name must match the discovery-created resource name or the overlay is "silently ignored". The code binds on host_uri, renames the row to the configured name, and warns (not silently) only when no discovered host has that host_uri.

Evidence

  • systems.toml.example:321-322: "name must match the discovery-created resource name ... a mismatch is silently ignored."
  • docs/operating/runbooks/image-lifecycle.md:323: same claim, "and egress stays off".
  • src/kdive/inventory/reconcile/resources.py:~496-540 (_overlay_one_local): SELECT ... WHERE kind = ... AND host_uri = ...; UPDATE resources SET name = inst.name, cost_class, capabilities, pool; an absent host appends a warned record "no discovered local-libvirt host at <host_uri>; overlay deferred".
  • Also docs/operating/providers/examples/systems-local-libvirt.toml:50-51 and systems.toml.example:319-320 say the overlay "only sets name/cost_class/concurrent_allocation_cap"; the overlay also sets pool.

Expected

Docs say: the block binds by host_uri; name becomes the row's name; an unmatched host_uri is reported as an "overlay deferred" warning.

Proposed approach

Reword the three places; confirm with a reconcile run that a different name renames the row and does not disable egress. Docs-only.

Provenance

Follow-up from campaign 4c2c8dc9e59d-7f9a87f5-2251-458a-bb30-04fbb2d4b05c.

Dominant language
Python
Stars
0
Forks
0
Avg merge
9h 13m
Merged PRs (30d)
197

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from randomparity/kdive

All issues in randomparity/kdive

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.