Remove elemental3ctl sysext image references#415
Remove elemental3ctl sysext image references#415davidcassany wants to merge 1 commit intoSUSE:mainfrom
Conversation
This commits removes the referenes of elemental3ctl being provided as systemd-sysext image. Signed-off-by: David Cassany <dcassany@suse.com>
| ## How are systemd extensions used in Elemental? | ||
|
|
||
| The elemental project mainly consists of two binaries: | ||
| - `elemental3` | ||
| - `elemental3ctl` | ||
|
|
||
| `elemental3` is a higher-level tool that takes as its input an OCI image containing an ISO artifact, adds payloads | ||
| such as system extensions, Kubernetes definitions, first-boot configs, and generates an ISO or RAW file which can be | ||
| used to boot a VM. | ||
|
|
||
| `elemental3ctl` is a lower-level tool that can do various things like installing an OS (packaged as an OCI image) on a | ||
| target system, upgrading such OS from an OCI image, manage kernel modules on a system, unpack an OCI image, build | ||
| an installation media (generally an ISO file) from an OS image (packaged as OCI image), and more. | ||
|
|
||
| `elemental3ctl` is a runtime management tool that helps deploy an OS image on disk, as well as helps manage such an | ||
| installation by performing upgrades, managing kernel modules, perform factory reset, etc. `elemental3` complements | ||
| it by building and configuring an OS image that could have additional artifacts and | ||
| capabilities, making it a platform to build and deploy cloud-native applications. | ||
|
|
||
| `elemental3ctl` is provided on an image mode OS as a system extension. No newline at end of file |
There was a problem hiding this comment.
IIUC we are not removing the elemental's capability of being able to add sysexts via product manifests. Shouldn't we keep this section as-is in that case? The last statement about elemental3ctl being provided as sysext should be removed, of course.
There was a problem hiding this comment.
I agree we could document here how systemd extensions can be used in Elemental, however I don't think we can leave this section as is. In fact, if we remove the last statement all the content under How are systemd extensions used in Elemental? does not relate to systemd sysexts at all. This disctinction between elemental3 and elemental3ctl is interesting and valid content, but I don't think it belongs here if this is no longer meant to justify elemental3ctl is delievered as sysext. Do you have any idea where we could include this distinction? We can try to find a good spot for it.
Regarding the use of systemd sysext I am bit hesitant to document additional content, its role in Elemental is still a bit blurry.
What you think?
There was a problem hiding this comment.
You are right about not leaving things as is. The elemental3-elemental3ctl distinction is something that took me a while to grasp, so that's something I strongly feel about keeping around, as you suggested.
I don't see any single doc talking about both tools. How about moving this info to index.md in that case so that new readers see it before almost anything else?
There was a problem hiding this comment.
Yes, that might be a good spot, let me try to include it there 👍
2 participants
This commits removes the referenes of elemental3ctl being provided as systemd-sysext image.
The generic systemd-sysext documentation is left as is.