README: how to try Keel Core, and which upstream features it does not ship #28

New issue

Open

opened 2026-10-03 10:59:17 -03:00 by marcos-mendez · 0 comments

marcos-mendez commented

2026-10-03 10:59:17 -03:00

(Migrated from github.com)

Context
README.rst has a short Keel introduction and then the upstream TurnKey description. That description still advertises TKLBAM backup, HubDNS and the TurnKey Hub, which Keel Core does not install (see the comment above inithooks in common's plans/turnkey/base). A newcomer reading it gets the wrong picture and finds no way to try the image.

What to do

Keep the upstream description as it is; it is kept on purpose. Edit only the Keel part above the line "The upstream description follows."
Add a "Try it" section: where testing builds are published (this repository's Releases page), how to check the .sha512 file, and where the .tar.zst goes on a Proxmox VE host (/var/lib/vz/template/cache/ for the local storage). Mark these builds as testing, not for production.
Add a "Differences from upstream" list, two to five bullets: no TKLBAM, no HubDNS, no TurnKey Hub, and what Keel adds (the keel command and an instance spec, /etc/keel/instance.yaml). Check each claim against the code or the plan before writing it.
Run rst2html (package docutils) or GitHub's preview to make sure the file still renders.

Done when
A reader can tell, from the top of the README, how to get and try a Keel Core template and which upstream features below do not apply.

Help
Ask in https://github.com/orgs/Keel-Linux/discussions

**Context** `README.rst` has a short Keel introduction and then the upstream TurnKey description. That description still advertises TKLBAM backup, HubDNS and the TurnKey Hub, which Keel Core does not install (see the comment above `inithooks` in common's `plans/turnkey/base`). A newcomer reading it gets the wrong picture and finds no way to try the image. **What to do** 1. Keep the upstream description as it is; it is kept on purpose. Edit only the Keel part above the line "The upstream description follows." 2. Add a "Try it" section: where testing builds are published (this repository's Releases page), how to check the `.sha512` file, and where the `.tar.zst` goes on a Proxmox VE host (`/var/lib/vz/template/cache/` for the `local` storage). Mark these builds as testing, not for production. 3. Add a "Differences from upstream" list, two to five bullets: no TKLBAM, no HubDNS, no TurnKey Hub, and what Keel adds (the `keel` command and an instance spec, `/etc/keel/instance.yaml`). Check each claim against the code or the plan before writing it. 4. Run `rst2html` (package `docutils`) or GitHub's preview to make sure the file still renders. **Done when** A reader can tell, from the top of the README, how to get and try a Keel Core template and which upstream features below do not apply. **Help** Ask in https://github.com/orgs/Keel-Linux/discussions