Document sysext in elemental's context #270
Draft
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dharmit
force-pushed
the
sysext-elemental
branch
from
3cc05ad to
cef86f8
Compare
dharmit
force-pushed
the
sysext-elemental
branch
from
cef86f8 to
8c282b4
Compare
dharmit
force-pushed
the
sysext-elemental
branch
from
8c282b4 to
5d56c7b
Compare
dharmit
commented
Dec 18, 2025
docs/systemd-system-extensions.md
Outdated
Comment on lines
39
to
46
| `elemental` is a higher level tool used for installation and upgrade of an immutable OS. `elemental3ctl` is lower | ||
| level and helps in, among other things, building a bootable OS image of either RAW or ISO foramt. However, | ||
| `elemental3ctl` is not expected to be used directly by most users; it will be used by `elemental` to get stuff done. | ||
| `elemental3ctl` can also be used to install an OCI image on the target system. | ||
|
|
||
| As a matter of fact, `elemental3ctl` itself is installed on the immutable OS as a sysext. Another sysext installed | ||
| out of the box is RKE2, thus making the OS a perfect environment to develop and deploy Kubernetes applications on. | ||
| `elemental3ctl` is a lower level tool that can do various things like installing an OS (packaged as OCI image) on | ||
| target system, upgrading the system 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). | ||
| `elemental3` is a higher level tool that uses the ISO artifact generated by `elemental3ctl` and other payload (system | ||
| extensions, Kubernetes definitions and firstboot configs) to generate a ISO or RAW file which can be used to boot a | ||
| VM from. | ||
| The `elemental3ctl` binary is installed on the immutable OS as a sysext. Another sysext installed out of the box is | ||
| RKE2, thus making the OS a perfect environment to develop and deploy Kubernetes applications on. |
Contributor
Author
There was a problem hiding this comment.
@atanasdinov i will eventually squash/rebase commits, but I have pushed this one separately so that you can review if our conversation yesterday has made my understanding clearer or not. 😆
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The idea behind this PR is to extract system extension related documentation from the "Building a Linux Virtual Machine Image with Elemental" document and have a dedicated file for it.