Files
felhom.eu/documentation/runbooks/household-leaves.md
T

9.3 KiB

A household or a tester leaves — the runbook

Status: written 2026-11-14 from source and from one real use; NOT run as a whole. Operator ruling D74 (09-update-architecture.md §3 decision 294, R-1375). Each step says PROVEN (with where) or NOT PROVEN. A step that is NOT PROVEN is not a wrong step: nobody has seen it work. Read its line before you press. Source: the endings list (audits/endings-list-2026-11-10/TABLE.md, endings EH00 to EH06) and the one real retirement (audits/RETIRE-peti-2026-09-25.md). The design of what the hub removes is 05-hub-architecture.md §14.

What this is, and what it is not

A household leaves Felhom, or a tester stops testing. You remove what Felhom holds of them: in the hub, at the off-site provider, on ep0, and at Cloudflare. There is no single button. The hub has five doors; three are buttons, one is a tick box, one is by hand.

It is NOT for a household that starts again on a new machine. For that, use RESET only (door 2) and stop.

Before you start — four questions

  1. Does the household want its data? The box holds the data. The hub holds none of it. Tell the household to copy what it wants off the box (the file manager, or each app's own export) BEFORE you start. After door 3 the off-site copies are gone and there is no undo. NOT PROVEN: no text for the household exists (capability E16; R-810). Write to them by hand.
  2. Is the box still on? An ONLINE box refuses doors 1 and 3. Ask the household to switch the box off, or wait until the hub shows it as down (a silent box can be deleted after 6 minutes). PROVEN in tests (hub/internal/web/hosts.go, the 409 gate; customer_delete_test.go GatesFailClosed).
  3. Was the off-site tier ever ticked for this household, and is it ticked now? Read the household's config page. If it was ticked once and is unticked now, see „The untick trap” below before door 3.
  4. Who is it? Write the customer id and the host id on paper. You type both.

The five doors, in the order you use them

# Door Where What it ends Ending
1 Delete the box hub → Hosts → the box → Delete the box's record EH00
2 RESET the household hub → the household → Reset everything the box made, at the hub and outside; the household's record stays EH01
3 Delete the household hub → the household → Delete customer… doors 1 and 2 for every box, then the record itself EH02
4 Untick a tier hub → the household → Edit the tier is no longer offered to the box; NOTHING is removed EH06
5 Cloudflare, by hand Cloudflare's dashboard the tunnel, the DNS records, the API token EH05

Doors 2 and 3 open two more by themselves: the off-site account (EH03) and the copies on ep0 (EH04).

For a household that leaves: door 3, then door 5. Door 3 does doors 1 and 2 for you. For a tester who stops: the same. There is no other path for a tester (the endings list, „a tester ends”).

The steps

Step 1 — the household copies its data off the box. NOT PROVEN (no product path; by hand).

Step 2 — the box is off, or silent for 6 minutes.

PROVEN in tests: an online box refuses (TestCustomerDelete…GatesFailClosed). NOT PROVEN on a real leaving household.

Step 3 — read the preview. hub → the household → Delete customer…

The dialog shows what will go: the boxes, the off-site account, the residue count, and the Cloudflare objects you must remove by hand. Read the off-site line. It must name an account when the household ever had the off-site tier. If it says „none” and you know there was one: STOP, go to „The untick trap”. PROVEN: the preview was read at the one real use (RETIRE-peti-2026-09-25.md A3 step 3: 0 hosts, the sub-account, residue 1,519). The Cloudflare line: PROVEN in a test only (TestR688_PreviewNamesCloudflareByHand).

Step 4 — tick the three boxes, type the customer id, press.

The hub then runs, in this order: the journal entry → every box deleted (door 1) → the off-site account taken down → the copies on ep0 taken down → the claim reset → the hub's rows purged → the record and ALL key packages purged.

  • Door 1 for each box: PROVEN in tests (TestDeleteHost_CascadeAndIsolation); a real box delete is routine (Tester4, 2026-11-11 and 11-14, by the operator).
  • The off-site account: PROVEN once on a real account (RETIRE-peti-2026-09-25.md: sub-account 269130 removed, the pool's other accounts and their sizes unchanged). That account held no backup. NOT PROVEN: an account that holds a real backup. The hub empties the folder through the account's own login first, then deletes the account; if the emptying fails the account is KEPT and the step fails (R-32) — then press again.
  • The copies on ep0: NOT PROVEN on real copies (at the one real use there was nothing on ep0: existed=false). Tests only (customer_delete_test.go). The second copy of ep0 on DooPlex is NOT removed by this and was not measured (runbooks/ep0-datastore-copy.md).
  • The purge of the hub's rows: PROVEN once (482 reports, 1,036 telemetry rows, 1 log tail gone; journal #20). Known gap, R-1376: rows in 13 tables stay (the box's update settings and reports, its kernel notices, the off-site key and window rows, the abandon requests). Built to be removed, not released (hub main, 2026-11-14; D73, 05 §14.2) — until that release they stay.

Step 5 — if a leg fails: press again.

The dialog offers Resume. A leg that is done is not done again. Nothing is half forgotten: the journal names the leg. PROVEN in tests (…ResumesAfterExternalFailure). NOT PROVEN live (_recovery-inventory-2026-07-28.md: „the end-to-end live leg is not run”).

Step 6 — check the provider by hand. 5 minutes.

At the off-site provider's page: the household's sub-account is gone; the others are there; the pool's size did not jump. PROVEN as a check (it is what RETIRE-peti-2026-09-25.md A4 did). Always do it when the journal says skipped_no_config — the hub could not know the account then.

Step 7 — door 5, Cloudflare, by hand. NOT PROVEN (never done; no code does it; the operator accepted that, R-688).

From the dialog's list: 1. delete the tunnel; 2. delete the DNS records that point at it; 3. delete the household's API token; 4. if the zone was added only for this household, remove the zone or leave it to the household (it is THEIR domain — ask them). If you do nothing: the names point at a tunnel that no longer runs; a visitor sees Cloudflare's error page. No data is exposed.

Step 8 — what stays, on purpose. Do not „clean” these.

  • The audit trail in the hub: the delete and reset journals, the host-deletion records, the events and the notification log. The last two go by themselves after one year (R-901, PROVEN in a test).
  • The hub's own database snapshots: they hold the household's rows for up to 8 weeks on ep0. That is the only way back, and it is a retention fact you must be able to state to the household.
  • The household's box and its drives: theirs. Felhom removes nothing on the box. If the household wants the box wiped, that is a new install by them, or the box's own „factory” path — NOT PROVEN as part of leaving.

Step 9 — a tester only: what to collect. NOT PROVEN (no list existed; this is the first).

Before step 4, ask the tester for: what did not work (in their words); whether they want to come back later (then use RESET, door 2, and keep the record); the box's hub page saved as a file if a finding is open in the register. After step 7: remove the tester from runbooks/target-selection.md (as Peti's entry was), and from STATUS.md if named there.

The untick trap (door 4) — read this if the off-site tier was unticked

Unticking the off-site tier removes nothing at the provider. Until the fix is released, it also made the hub forget the account: a later RESET or delete then skipped it, and the account stayed, paid for, with the household's copies in it, and no record in the hub (R-1375, endings EH06 and EH01).

  • Fix built, not released (hub main, 2026-11-14, D71): the hub keeps the account's record after an untick, and RESET and delete take the account down when a record exists.
  • Until that release, and for any household unticked before it: before door 3, tick the off-site tier again and save (this is ending EH06's own undo and gives the record back), THEN do door 3. NOT PROVEN on a real household.
  • If the record is already lost (unticked, then RESET or deleted, before the fix): the account has the label felhom-customer=<customer id> at the provider. Find it by the label, never by its number, and remove it by hand as RETIRE-peti-2026-09-25.md A3 did. PROVEN once (that record).

The second off-site tier (the whole-box copies on ep0)

Switching it off keeps the household's place and copies on ep0, on purpose (PROVEN in a test, TestPBSDR_DisableKeepsTenancy). The hub finds them by the customer id, so door 2 and door 3 take them down whether the tier is ticked or not. Nothing to do by hand here.

What is not in this runbook, and why

  • A mail to the household that says what was removed. It does not exist (R-810). Write by hand.
  • A refund or an invoice. Money is the operator's.
  • A wipe of the household's box. Not Felhom's to do.