Skip to content

Build_sysext script to enable sysext builds in the OS image build process#920

Merged
pothos merged 1 commit intoflatcar:mainfrom
krishjainx:sysext-internship
Jul 4, 2023
Merged

Build_sysext script to enable sysext builds in the OS image build process#920
pothos merged 1 commit intoflatcar:mainfrom
krishjainx:sysext-internship

Conversation

@krishjainx
Copy link
Copy Markdown
Contributor

@krishjainx krishjainx commented Jun 14, 2023 •
edited
Loading

Build_sysext script to enable sysext builds in the OS image build process

Included a script to enable generating systemd-sysexts. Successfully tested sysext generation (manually; script refinement in progress) with a fresh Flatcar image (e.g., Python and Neofetch system extension). Part of my internship work.

Link to the related issue: Flatcar Issue #1052.

How to use

The current OS images we provide are not OK as base for flatcar specific sysext images: it lacks the package metadata and portage configuration, in order to keep end user OS image clean. This script retains this information and allows you to produce systemd-sysexts to extend the system. This script can be used to build a Flatcar sysext image. Recommended to run from image build folder.

sudo build_sysext --board=amd64-usr command-extras package_1 package_2 package_3 - builds sysext named python-sysext with package_1, package_2 and package_3 within it  for amd64 architecture.
sudo build_sysext --board=arm64-usr command-extras package_1 package_2 package_3 - builds sysext named python-sysext with package_1, package_2 and package_3 within it  for arm64 architecture.

Testing done

I have built multiple sysext images using the script and have been able to successfully extend a fresh upstream Flatcar image with packages such as Python, Neofetch, etc. I provided a Butane configuration similar to the one below, transpiled it to Ignition, and booted with it. I received a review and advice on how to make the script more robust and meet the demands of the Flatcar team.

variant: flatcar
version: 1.0.0
storage:
  files:
    - path: /etc/extensions/python.raw
      mode: 0644
      contents:
        source: https://0x0.st/HQpJ.raw

Notes:

A problem with installing regular packages is that in many cases the software won't correctly work because only /usr is added. Files on /etc will be missing and the approach in the Azure OEM was that we ship the needed files in the sysext and then set up symlinks before, e.g., a service starts (We could build a confext in the future but this doesn't work now). Also, files in /var will be missing. For some of these files there might be tmpfile directives but they won't get executed on load. Finally, the services that use .wants symlinks to be enabled would currently work because we have deployed a workaround but we plan to drop this because the recommended way is to use Upholds= instead of Wants= (currently through drop-ins for the multi-user target but in systemd 254 it should work to use .upholds symlinks). In summary, we need some postprocessing for some scenarios and call out what won't work for the rest.

"I think this should be addressed to some degree by the --manglefs_script option" - @krnowak

Edit: A great use case for this would be to build a Docker and containerd sysext to replace torcx.

t-lo
t-lo reviewed Jun 14, 2023
View reviewed changes
pothos
pothos reviewed Jun 14, 2023
View reviewed changes
@t-lo t-lo requested a review from pothos June 15, 2023 11:53
pothos
pothos reviewed Jun 15, 2023
View reviewed changes
pothos
pothos reviewed Jun 15, 2023
View reviewed changes
pothos
pothos reviewed Jun 15, 2023
View reviewed changes
pothos
pothos reviewed Jun 15, 2023
View reviewed changes
pothos
pothos reviewed Jun 15, 2023
View reviewed changes
@pothos
Copy link
Copy Markdown
Member

pothos commented Jun 15, 2023 •
edited
Loading

A problem with installing regular packages is that in many cases the software won't correctly work because only /usr is added.
Files on /etc will be missing and the approach in the Azure OEM was that we ship the needed files in the sysext and then set up symlinks before, e.g., a service starts (We could build a confext in the future but this doesn't work now).
Also, files in /var will be missing. For some of these files there might be tmpfile directives but they won't get executed on load.
Finally, the services that use .wants symlinks to be enabled would currently work because we have deployed a workaround but we plan to drop this because the recommended way is to use Upholds= instead of Wants= (currently through drop-ins for the multi-user target but in systemd 254 it should work to use .upholds symlinks).
In summary, we need some postprocessing for some scenarios and call out what won't work for the rest.

Edit: A great use case for this would be to build a Docker and containerd sysext to replace torcx.

@github-actions
Copy link
Copy Markdown

github-actions bot commented Jun 15, 2023 •
edited
Loading

Build action triggered: https://github.com/flatcar/scripts/actions/runs/5424483460

pothos
pothos reviewed Jun 15, 2023
View reviewed changes
pothos
pothos reviewed Jun 15, 2023
View reviewed changes
pothos
pothos reviewed Jun 15, 2023
View reviewed changes
pothos
pothos reviewed Jun 15, 2023
View reviewed changes
@krishjainx krishjainx marked this pull request as ready for review June 19, 2023 22:41
jepio
jepio reviewed Jun 21, 2023
View reviewed changes
@jepio
Copy link
Copy Markdown
Member

jepio commented Jun 21, 2023

@krishjainx
can you paste a log showing the output you see when you execute ./build_sysext (with whatever package you're testing with)?

Please try running the build two times in a row to make sure things don't break when this is done.

pothos
pothos reviewed Jun 22, 2023
View reviewed changes
@jepio
Copy link
Copy Markdown
Member

jepio commented Jun 26, 2023

Could you also make the script executable with chmod?

@krishjainx krishjainx requested review from jepio, pothos and t-lo June 26, 2023 11:00
pothos
pothos reviewed Jun 26, 2023
View reviewed changes
pothos
pothos reviewed Jun 26, 2023
View reviewed changes
pothos
pothos reviewed Jun 26, 2023
View reviewed changes
pothos
pothos reviewed Jun 26, 2023
View reviewed changes
pothos
pothos reviewed Jun 26, 2023
View reviewed changes
pothos
pothos reviewed Jun 26, 2023
View reviewed changes
pothos
pothos reviewed Jun 26, 2023
View reviewed changes
pothos
pothos reviewed Jun 26, 2023
View reviewed changes
@t-lo
Copy link
Copy Markdown
Member

t-lo commented Jun 29, 2023 •
edited
Loading

The build looks good, tests are successful with a single failure that can be explained.
The devcontainer tests are failing for systemd-nspawn and docker on both archs; the tests break in emerge_gitclone with:

Cloning into _/var/lib/portage/scripts_..."
error: pathspec _285cff6c98_ did not match any file(s) known to git"

Pathspec cannot be found because the upstream scripts repo was cloned by emerge_gitclone but this PR uses a fork.

@krishjainx
Copy link
Copy Markdown
Contributor Author

krishjainx commented Jun 29, 2023

Could you review? @pothos @jepio Thanks!

pothos
pothos requested changes Jun 29, 2023
View reviewed changes
Copy link
Copy Markdown
Member

@pothos pothos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good except for unused imports: https://github.com/flatcar/scripts/pull/920/files#r1242488294

@krishjainx
Copy link
Copy Markdown
Contributor Author

krishjainx commented Jun 29, 2023

This and squash the commits

@krnowak
Copy link
Copy Markdown
Member

krnowak commented Jun 29, 2023

I'd like to make a review before merging this, please.

@krishjainx krishjainx temporarily deployed to development June 29, 2023 12:29 — with GitHub Actions Inactive
krnowak
krnowak reviewed Jun 29, 2023
View reviewed changes
@krnowak
Copy link
Copy Markdown
Member

krnowak commented Jun 29, 2023

A problem with installing regular packages is that in many cases the software won't correctly work because only /usr is added. Files on /etc will be missing and the approach in the Azure OEM was that we ship the needed files in the sysext and then set up symlinks before, e.g., a service starts (We could build a confext in the future but this doesn't work now). Also, files in /var will be missing. For some of these files there might be tmpfile directives but they won't get executed on load. Finally, the services that use .wants symlinks to be enabled would currently work because we have deployed a workaround but we plan to drop this because the recommended way is to use Upholds= instead of Wants= (currently through drop-ins for the multi-user target but in systemd 254 it should work to use .upholds symlinks). In summary, we need some postprocessing for some scenarios and call out what won't work for the rest.

Edit: A great use case for this would be to build a Docker and containerd sysext to replace torcx.

I think this should be addressed to some degree by the --manglefs_script option.

@krishjainx krishjainx requested review from krnowak and pothos June 29, 2023 15:47
@krishjainx
Copy link
Copy Markdown
Contributor Author

krishjainx commented Jun 29, 2023

Squashed 🐛 s and squashed commits

krnowak
krnowak reviewed Jun 29, 2023
View reviewed changes
@krishjainx krishjainx mentioned this pull request Jun 29, 2023
Closed
@krishjainx krishjainx temporarily deployed to development June 29, 2023 19:00 — with GitHub Actions Inactive
@krnowak
Copy link
Copy Markdown
Member

krnowak commented Jun 30, 2023

I'm currently trying to use this script to build OEM sysexts, just to see if we can do it. I think I'll want more changes, mostly related to the BUILD_DIR stuff. You can see my branch here: https://github.com/flatcar/scripts/commits/krnowak/test-new-oem-script (ignore the fact that the commits are made by Flatcar Buildbot, apparently I messed up my git config :) ). The changes in the script that I have made are here: 72d2b62

@krishjainx
Copy link
Copy Markdown
Contributor Author

krishjainx commented Jun 30, 2023 via email

@krnowak
Copy link
Copy Markdown
Member

krnowak commented Jun 30, 2023

Ok cool. Just these changes?

I think I'll let you know on Monday - the build is currently running on our Jenkins instance.

@krishjainx
Copy link
Copy Markdown
Contributor Author

krishjainx commented Jun 30, 2023 via email

@krishjainx krishjainx requested a review from krnowak July 3, 2023 09:42
pothos
pothos reviewed Jul 3, 2023
View reviewed changes
krnowak
krnowak requested changes Jul 3, 2023
View reviewed changes
@krishjainx krishjainx requested review from krnowak and pothos July 3, 2023 20:27
pothos
pothos reviewed Jul 4, 2023
View reviewed changes
@krishjainx
Add script to enable sysext builds in the OS image build process
6380a43 
Included a script to enable generating systemd-sysexts. Successfully
tested sysext generation with a fresh Flatcar image (e.g., Python and
Neofetch system extension). Part of my internship work.

The current OS images we provide are not OK as base for flatcar specific
sysext images: it lacks the package metadata and portage configuration,
in order to keep end user OS image clean. This script retains this
information and allows you to produce systemd-sysexts to extend the
system. This script can be used to build a Flatcar sysext image.
Recommended to run from image build folder.

Signed-off-by: Krish Jain <kjain7@u.rochester.edu>
@pothos pothos merged commit eb2f3d5 into flatcar:main Jul 4, 2023
@t-lo t-lo mentioned this pull request Jul 6, 2023
Closed
@github-actions github-actions bot mentioned this pull request Nov 10, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@krnowak krnowak krnowak approved these changes

@pothos pothos pothos approved these changes

@t-lo t-lo Awaiting requested review from t-lo

@jepio jepio Awaiting requested review from jepio

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@krishjainx @pothos @jepio @t-lo @krnowak